initial commit, 4.5 stable
Some checks failed
🔗 GHA / 📊 Static checks (push) Has been cancelled
🔗 GHA / 🤖 Android (push) Has been cancelled
🔗 GHA / 🍏 iOS (push) Has been cancelled
🔗 GHA / 🐧 Linux (push) Has been cancelled
🔗 GHA / 🍎 macOS (push) Has been cancelled
🔗 GHA / 🏁 Windows (push) Has been cancelled
🔗 GHA / 🌐 Web (push) Has been cancelled
Some checks failed
🔗 GHA / 📊 Static checks (push) Has been cancelled
🔗 GHA / 🤖 Android (push) Has been cancelled
🔗 GHA / 🍏 iOS (push) Has been cancelled
🔗 GHA / 🐧 Linux (push) Has been cancelled
🔗 GHA / 🍎 macOS (push) Has been cancelled
🔗 GHA / 🏁 Windows (push) Has been cancelled
🔗 GHA / 🌐 Web (push) Has been cancelled
This commit is contained in:
111
modules/webrtc/doc_classes/WebRTCDataChannel.xml
Normal file
111
modules/webrtc/doc_classes/WebRTCDataChannel.xml
Normal file
@@ -0,0 +1,111 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="WebRTCDataChannel" inherits="PacketPeer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="close">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Closes this data channel, notifying the other peer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_buffered_amount" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the number of bytes currently queued to be sent over this channel.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_id" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the ID assigned to this channel during creation (or auto-assigned during negotiation).
|
||||
If the channel is not negotiated out-of-band the ID will only be available after the connection is established (will return [code]65535[/code] until then).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_label" qualifiers="const">
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the label assigned to this channel during creation.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_max_packet_life_time" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the [code]maxPacketLifeTime[/code] value assigned to this channel during creation.
|
||||
Will be [code]65535[/code] if not specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_max_retransmits" qualifiers="const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
Returns the [code]maxRetransmits[/code] value assigned to this channel during creation.
|
||||
Will be [code]65535[/code] if not specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_protocol" qualifiers="const">
|
||||
<return type="String" />
|
||||
<description>
|
||||
Returns the sub-protocol assigned to this channel during creation. An empty string if not specified.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_ready_state" qualifiers="const">
|
||||
<return type="int" enum="WebRTCDataChannel.ChannelState" />
|
||||
<description>
|
||||
Returns the current state of this channel.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_negotiated" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this channel was created with out-of-band configuration.
|
||||
</description>
|
||||
</method>
|
||||
<method name="is_ordered" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if this channel was created with ordering enabled (default).
|
||||
</description>
|
||||
</method>
|
||||
<method name="poll">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
Reserved, but not used for now.
|
||||
</description>
|
||||
</method>
|
||||
<method name="was_string_packet" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the last received packet was transferred as text. See [member write_mode].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<members>
|
||||
<member name="write_mode" type="int" setter="set_write_mode" getter="get_write_mode" enum="WebRTCDataChannel.WriteMode" default="1">
|
||||
The transfer mode to use when sending outgoing packet. Either text or binary.
|
||||
</member>
|
||||
</members>
|
||||
<constants>
|
||||
<constant name="WRITE_MODE_TEXT" value="0" enum="WriteMode">
|
||||
Tells the channel to send data over this channel as text. An external peer (non-Godot) would receive this as a string.
|
||||
</constant>
|
||||
<constant name="WRITE_MODE_BINARY" value="1" enum="WriteMode">
|
||||
Tells the channel to send data over this channel as binary. An external peer (non-Godot) would receive this as array buffer or blob.
|
||||
</constant>
|
||||
<constant name="STATE_CONNECTING" value="0" enum="ChannelState">
|
||||
The channel was created, but it's still trying to connect.
|
||||
</constant>
|
||||
<constant name="STATE_OPEN" value="1" enum="ChannelState">
|
||||
The channel is currently open, and data can flow over it.
|
||||
</constant>
|
||||
<constant name="STATE_CLOSING" value="2" enum="ChannelState">
|
||||
The channel is being closed, no new messages will be accepted, but those already in queue will be flushed.
|
||||
</constant>
|
||||
<constant name="STATE_CLOSED" value="3" enum="ChannelState">
|
||||
The channel was closed, or connection failed.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
106
modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml
Normal file
106
modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml
Normal file
@@ -0,0 +1,106 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="WebRTCDataChannelExtension" inherits="WebRTCDataChannel" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_close" qualifiers="virtual required">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_available_packet_count" qualifiers="virtual required const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_buffered_amount" qualifiers="virtual required const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_id" qualifiers="virtual required const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_label" qualifiers="virtual required const">
|
||||
<return type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_max_packet_life_time" qualifiers="virtual required const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_max_packet_size" qualifiers="virtual required const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_max_retransmits" qualifiers="virtual required const">
|
||||
<return type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_packet" qualifiers="virtual">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="r_buffer" type="const uint8_t **" />
|
||||
<param index="1" name="r_buffer_size" type="int32_t*" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_protocol" qualifiers="virtual required const">
|
||||
<return type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_ready_state" qualifiers="virtual required const">
|
||||
<return type="int" enum="WebRTCDataChannel.ChannelState" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_write_mode" qualifiers="virtual required const">
|
||||
<return type="int" enum="WebRTCDataChannel.WriteMode" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_is_negotiated" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_is_ordered" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_poll" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_put_packet" qualifiers="virtual">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="p_buffer" type="const uint8_t*" />
|
||||
<param index="1" name="p_buffer_size" type="int" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_set_write_mode" qualifiers="virtual required">
|
||||
<return type="void" />
|
||||
<param index="0" name="p_write_mode" type="int" enum="WebRTCDataChannel.WriteMode" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_was_string_packet" qualifiers="virtual required const">
|
||||
<return type="bool" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
</class>
|
||||
78
modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml
Normal file
78
modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml
Normal file
@@ -0,0 +1,78 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="WebRTCMultiplayerPeer" inherits="MultiplayerPeer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
A simple interface to create a peer-to-peer mesh network composed of [WebRTCPeerConnection] that is compatible with the [MultiplayerAPI].
|
||||
</brief_description>
|
||||
<description>
|
||||
This class constructs a full mesh of [WebRTCPeerConnection] (one connection for each peer) that can be used as a [member MultiplayerAPI.multiplayer_peer].
|
||||
You can add each [WebRTCPeerConnection] via [method add_peer] or remove them via [method remove_peer]. Peers must be added in [constant WebRTCPeerConnection.STATE_NEW] state to allow it to create the appropriate channels. This class will not create offers nor set descriptions, it will only poll them, and notify connections and disconnections.
|
||||
When creating the peer via [method create_client] or [method create_server] the [method MultiplayerPeer.is_server_relay_supported] method will return [code]true[/code] enabling peer exchange and packet relaying when supported by the [MultiplayerAPI] implementation.
|
||||
[b]Note:[/b] When exporting to Android, make sure to enable the [code]INTERNET[/code] permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_peer">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="peer" type="WebRTCPeerConnection" />
|
||||
<param index="1" name="peer_id" type="int" />
|
||||
<param index="2" name="unreliable_lifetime" type="int" default="1" />
|
||||
<description>
|
||||
Add a new peer to the mesh with the given [param peer_id]. The [WebRTCPeerConnection] must be in state [constant WebRTCPeerConnection.STATE_NEW].
|
||||
Three channels will be created for reliable, unreliable, and ordered transport. The value of [param unreliable_lifetime] will be passed to the [code]"maxPacketLifetime"[/code] option when creating unreliable and ordered channels (see [method WebRTCPeerConnection.create_data_channel]).
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_client">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="peer_id" type="int" />
|
||||
<param index="1" name="channels_config" type="Array" default="[]" />
|
||||
<description>
|
||||
Initialize the multiplayer peer as a client with the given [param peer_id] (must be between 2 and 2147483647). In this mode, you should only call [method add_peer] once and with [param peer_id] of [code]1[/code]. This mode enables [method MultiplayerPeer.is_server_relay_supported], allowing the upper [MultiplayerAPI] layer to perform peer exchange and packet relaying.
|
||||
You can optionally specify a [param channels_config] array of [enum MultiplayerPeer.TransferMode] which will be used to create extra channels (WebRTC only supports one transfer mode per channel).
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_mesh">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="peer_id" type="int" />
|
||||
<param index="1" name="channels_config" type="Array" default="[]" />
|
||||
<description>
|
||||
Initialize the multiplayer peer as a mesh (i.e. all peers connect to each other) with the given [param peer_id] (must be between 1 and 2147483647).
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_server">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="channels_config" type="Array" default="[]" />
|
||||
<description>
|
||||
Initialize the multiplayer peer as a server (with unique ID of [code]1[/code]). This mode enables [method MultiplayerPeer.is_server_relay_supported], allowing the upper [MultiplayerAPI] layer to perform peer exchange and packet relaying.
|
||||
You can optionally specify a [param channels_config] array of [enum MultiplayerPeer.TransferMode] which will be used to create extra channels (WebRTC only supports one transfer mode per channel).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peer">
|
||||
<return type="Dictionary" />
|
||||
<param index="0" name="peer_id" type="int" />
|
||||
<description>
|
||||
Returns a dictionary representation of the peer with given [param peer_id] with three keys. [code]"connection"[/code] containing the [WebRTCPeerConnection] to this peer, [code]"channels"[/code] an array of three [WebRTCDataChannel], and [code]"connected"[/code] a boolean representing if the peer connection is currently connected (all three channels are open).
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_peers">
|
||||
<return type="Dictionary" />
|
||||
<description>
|
||||
Returns a dictionary which keys are the peer ids and values the peer representation as in [method get_peer].
|
||||
</description>
|
||||
</method>
|
||||
<method name="has_peer">
|
||||
<return type="bool" />
|
||||
<param index="0" name="peer_id" type="int" />
|
||||
<description>
|
||||
Returns [code]true[/code] if the given [param peer_id] is in the peers map (it might not be connected though).
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_peer">
|
||||
<return type="void" />
|
||||
<param index="0" name="peer_id" type="int" />
|
||||
<description>
|
||||
Remove the peer with given [param peer_id] from the mesh. If the peer was connected, and [signal MultiplayerPeer.peer_connected] was emitted for it, then [signal MultiplayerPeer.peer_disconnected] will be emitted.
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
</class>
|
||||
208
modules/webrtc/doc_classes/WebRTCPeerConnection.xml
Normal file
208
modules/webrtc/doc_classes/WebRTCPeerConnection.xml
Normal file
@@ -0,0 +1,208 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="WebRTCPeerConnection" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
Interface to a WebRTC peer connection.
|
||||
</brief_description>
|
||||
<description>
|
||||
A WebRTC connection between the local computer and a remote peer. Provides an interface to connect, maintain and monitor the connection.
|
||||
Setting up a WebRTC connection between two peers may not seem a trivial task, but it can be broken down into 3 main steps:
|
||||
- The peer that wants to initiate the connection ([code]A[/code] from now on) creates an offer and send it to the other peer ([code]B[/code] from now on).
|
||||
- [code]B[/code] receives the offer, generate and answer, and sends it to [code]A[/code]).
|
||||
- [code]A[/code] and [code]B[/code] then generates and exchange ICE candidates with each other.
|
||||
After these steps, the connection should become connected. Keep on reading or look into the tutorial for more information.
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="add_ice_candidate">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="media" type="String" />
|
||||
<param index="1" name="index" type="int" />
|
||||
<param index="2" name="name" type="String" />
|
||||
<description>
|
||||
Add an ice candidate generated by a remote peer (and received over the signaling server). See [signal ice_candidate_created].
|
||||
</description>
|
||||
</method>
|
||||
<method name="close">
|
||||
<return type="void" />
|
||||
<description>
|
||||
Close the peer connection and all data channels associated with it.
|
||||
[b]Note:[/b] You cannot reuse this object for a new connection unless you call [method initialize].
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_data_channel">
|
||||
<return type="WebRTCDataChannel" />
|
||||
<param index="0" name="label" type="String" />
|
||||
<param index="1" name="options" type="Dictionary" default="{}" />
|
||||
<description>
|
||||
Returns a new [WebRTCDataChannel] (or [code]null[/code] on failure) with given [param label] and optionally configured via the [param options] dictionary. This method can only be called when the connection is in state [constant STATE_NEW].
|
||||
There are two ways to create a working data channel: either call [method create_data_channel] on only one of the peer and listen to [signal data_channel_received] on the other, or call [method create_data_channel] on both peers, with the same values, and the [code]"negotiated"[/code] option set to [code]true[/code].
|
||||
Valid [param options] are:
|
||||
[codeblock]
|
||||
{
|
||||
"negotiated": true, # When set to true (default off), means the channel is negotiated out of band. "id" must be set too. "data_channel_received" will not be called.
|
||||
"id": 1, # When "negotiated" is true this value must also be set to the same value on both peer.
|
||||
|
||||
# Only one of maxRetransmits and maxPacketLifeTime can be specified, not both. They make the channel unreliable (but also better at real time).
|
||||
"maxRetransmits": 1, # Specify the maximum number of attempt the peer will make to retransmits packets if they are not acknowledged.
|
||||
"maxPacketLifeTime": 100, # Specify the maximum amount of time before giving up retransmitions of unacknowledged packets (in milliseconds).
|
||||
"ordered": true, # When in unreliable mode (i.e. either "maxRetransmits" or "maxPacketLifetime" is set), "ordered" (true by default) specify if packet ordering is to be enforced.
|
||||
|
||||
"protocol": "my-custom-protocol", # A custom sub-protocol string for this channel.
|
||||
}
|
||||
[/codeblock]
|
||||
[b]Note:[/b] You must keep a reference to channels created this way, or it will be closed.
|
||||
</description>
|
||||
</method>
|
||||
<method name="create_offer">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
Creates a new SDP offer to start a WebRTC connection with a remote peer. At least one [WebRTCDataChannel] must have been created before calling this method.
|
||||
If this functions returns [constant OK], [signal session_description_created] will be called when the session is ready to be sent.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_connection_state" qualifiers="const">
|
||||
<return type="int" enum="WebRTCPeerConnection.ConnectionState" />
|
||||
<description>
|
||||
Returns the connection state.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_gathering_state" qualifiers="const">
|
||||
<return type="int" enum="WebRTCPeerConnection.GatheringState" />
|
||||
<description>
|
||||
Returns the ICE [enum GatheringState] of the connection. This lets you detect, for example, when collection of ICE candidates has finished.
|
||||
</description>
|
||||
</method>
|
||||
<method name="get_signaling_state" qualifiers="const">
|
||||
<return type="int" enum="WebRTCPeerConnection.SignalingState" />
|
||||
<description>
|
||||
Returns the signaling state on the local end of the connection while connecting or reconnecting to another peer.
|
||||
</description>
|
||||
</method>
|
||||
<method name="initialize">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="configuration" type="Dictionary" default="{}" />
|
||||
<description>
|
||||
Re-initialize this peer connection, closing any previously active connection, and going back to state [constant STATE_NEW]. A dictionary of [param configuration] options can be passed to configure the peer connection.
|
||||
Valid [param configuration] options are:
|
||||
[codeblock]
|
||||
{
|
||||
"iceServers": [
|
||||
{
|
||||
"urls": [ "stun:stun.example.com:3478" ], # One or more STUN servers.
|
||||
},
|
||||
{
|
||||
"urls": [ "turn:turn.example.com:3478" ], # One or more TURN servers.
|
||||
"username": "a_username", # Optional username for the TURN server.
|
||||
"credential": "a_password", # Optional password for the TURN server.
|
||||
}
|
||||
]
|
||||
}
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
<method name="poll">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
Call this method frequently (e.g. in [method Node._process] or [method Node._physics_process]) to properly receive signals.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_default_extension" qualifiers="static">
|
||||
<return type="void" />
|
||||
<param index="0" name="extension_class" type="StringName" />
|
||||
<description>
|
||||
Sets the [param extension_class] as the default [WebRTCPeerConnectionExtension] returned when creating a new [WebRTCPeerConnection].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_local_description">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="type" type="String" />
|
||||
<param index="1" name="sdp" type="String" />
|
||||
<description>
|
||||
Sets the SDP description of the local peer. This should be called in response to [signal session_description_created].
|
||||
After calling this function the peer will start emitting [signal ice_candidate_created] (unless an [enum Error] different from [constant OK] is returned).
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_remote_description">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="type" type="String" />
|
||||
<param index="1" name="sdp" type="String" />
|
||||
<description>
|
||||
Sets the SDP description of the remote peer. This should be called with the values generated by a remote peer and received over the signaling server.
|
||||
If [param type] is [code]"offer"[/code] the peer will emit [signal session_description_created] with the appropriate answer.
|
||||
If [param type] is [code]"answer"[/code] the peer will start emitting [signal ice_candidate_created].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
<signals>
|
||||
<signal name="data_channel_received">
|
||||
<param index="0" name="channel" type="WebRTCDataChannel" />
|
||||
<description>
|
||||
Emitted when a new in-band channel is received, i.e. when the channel was created with [code]negotiated: false[/code] (default).
|
||||
The object will be an instance of [WebRTCDataChannel]. You must keep a reference of it or it will be closed automatically. See [method create_data_channel].
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="ice_candidate_created">
|
||||
<param index="0" name="media" type="String" />
|
||||
<param index="1" name="index" type="int" />
|
||||
<param index="2" name="name" type="String" />
|
||||
<description>
|
||||
Emitted when a new ICE candidate has been created. The three parameters are meant to be passed to the remote peer over the signaling server.
|
||||
</description>
|
||||
</signal>
|
||||
<signal name="session_description_created">
|
||||
<param index="0" name="type" type="String" />
|
||||
<param index="1" name="sdp" type="String" />
|
||||
<description>
|
||||
Emitted after a successful call to [method create_offer] or [method set_remote_description] (when it generates an answer). The parameters are meant to be passed to [method set_local_description] on this object, and sent to the remote peer over the signaling server.
|
||||
</description>
|
||||
</signal>
|
||||
</signals>
|
||||
<constants>
|
||||
<constant name="STATE_NEW" value="0" enum="ConnectionState">
|
||||
The connection is new, data channels and an offer can be created in this state.
|
||||
</constant>
|
||||
<constant name="STATE_CONNECTING" value="1" enum="ConnectionState">
|
||||
The peer is connecting, ICE is in progress, none of the transports has failed.
|
||||
</constant>
|
||||
<constant name="STATE_CONNECTED" value="2" enum="ConnectionState">
|
||||
The peer is connected, all ICE transports are connected.
|
||||
</constant>
|
||||
<constant name="STATE_DISCONNECTED" value="3" enum="ConnectionState">
|
||||
At least one ICE transport is disconnected.
|
||||
</constant>
|
||||
<constant name="STATE_FAILED" value="4" enum="ConnectionState">
|
||||
One or more of the ICE transports failed.
|
||||
</constant>
|
||||
<constant name="STATE_CLOSED" value="5" enum="ConnectionState">
|
||||
The peer connection is closed (after calling [method close] for example).
|
||||
</constant>
|
||||
<constant name="GATHERING_STATE_NEW" value="0" enum="GatheringState">
|
||||
The peer connection was just created and hasn't done any networking yet.
|
||||
</constant>
|
||||
<constant name="GATHERING_STATE_GATHERING" value="1" enum="GatheringState">
|
||||
The ICE agent is in the process of gathering candidates for the connection.
|
||||
</constant>
|
||||
<constant name="GATHERING_STATE_COMPLETE" value="2" enum="GatheringState">
|
||||
The ICE agent has finished gathering candidates. If something happens that requires collecting new candidates, such as a new interface being added or the addition of a new ICE server, the state will revert to gathering to gather those candidates.
|
||||
</constant>
|
||||
<constant name="SIGNALING_STATE_STABLE" value="0" enum="SignalingState">
|
||||
There is no ongoing exchange of offer and answer underway. This may mean that the [WebRTCPeerConnection] is new ([constant STATE_NEW]) or that negotiation is complete and a connection has been established ([constant STATE_CONNECTED]).
|
||||
</constant>
|
||||
<constant name="SIGNALING_STATE_HAVE_LOCAL_OFFER" value="1" enum="SignalingState">
|
||||
The local peer has called [method set_local_description], passing in SDP representing an offer (usually created by calling [method create_offer]), and the offer has been applied successfully.
|
||||
</constant>
|
||||
<constant name="SIGNALING_STATE_HAVE_REMOTE_OFFER" value="2" enum="SignalingState">
|
||||
The remote peer has created an offer and used the signaling server to deliver it to the local peer, which has set the offer as the remote description by calling [method set_remote_description].
|
||||
</constant>
|
||||
<constant name="SIGNALING_STATE_HAVE_LOCAL_PRANSWER" value="3" enum="SignalingState">
|
||||
The offer sent by the remote peer has been applied and an answer has been created and applied by calling [method set_local_description]. This provisional answer describes the supported media formats and so forth, but may not have a complete set of ICE candidates included. Further candidates will be delivered separately later.
|
||||
</constant>
|
||||
<constant name="SIGNALING_STATE_HAVE_REMOTE_PRANSWER" value="4" enum="SignalingState">
|
||||
A provisional answer has been received and successfully applied in response to an offer previously sent and established by calling [method set_local_description].
|
||||
</constant>
|
||||
<constant name="SIGNALING_STATE_CLOSED" value="5" enum="SignalingState">
|
||||
The [WebRTCPeerConnection] has been closed.
|
||||
</constant>
|
||||
</constants>
|
||||
</class>
|
||||
76
modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml
Normal file
76
modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml
Normal file
@@ -0,0 +1,76 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<class name="WebRTCPeerConnectionExtension" inherits="WebRTCPeerConnection" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
||||
<brief_description>
|
||||
</brief_description>
|
||||
<description>
|
||||
</description>
|
||||
<tutorials>
|
||||
</tutorials>
|
||||
<methods>
|
||||
<method name="_add_ice_candidate" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="p_sdp_mid_name" type="String" />
|
||||
<param index="1" name="p_sdp_mline_index" type="int" />
|
||||
<param index="2" name="p_sdp_name" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_close" qualifiers="virtual required">
|
||||
<return type="void" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_create_data_channel" qualifiers="virtual required">
|
||||
<return type="WebRTCDataChannel" />
|
||||
<param index="0" name="p_label" type="String" />
|
||||
<param index="1" name="p_config" type="Dictionary" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_create_offer" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_connection_state" qualifiers="virtual required const">
|
||||
<return type="int" enum="WebRTCPeerConnection.ConnectionState" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_gathering_state" qualifiers="virtual required const">
|
||||
<return type="int" enum="WebRTCPeerConnection.GatheringState" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_get_signaling_state" qualifiers="virtual required const">
|
||||
<return type="int" enum="WebRTCPeerConnection.SignalingState" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_initialize" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="p_config" type="Dictionary" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_poll" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_set_local_description" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="p_type" type="String" />
|
||||
<param index="1" name="p_sdp" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
<method name="_set_remote_description" qualifiers="virtual required">
|
||||
<return type="int" enum="Error" />
|
||||
<param index="0" name="p_type" type="String" />
|
||||
<param index="1" name="p_sdp" type="String" />
|
||||
<description>
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
</class>
|
||||
Reference in New Issue
Block a user