:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.5/modules/webrtc/doc_classes/WebRTCDataChannel.xml. .. _class_WebRTCDataChannel: WebRTCDataChannel ================= **Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` **Inherited By:** :ref:`WebRTCDataChannelGDNative` Properties ---------- +----------------------------------------------------+----------------------------------------------------------------+-------+ | :ref:`WriteMode` | :ref:`write_mode` | ``1`` | +----------------------------------------------------+----------------------------------------------------------------+-------+ Methods ------- +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_buffered_amount` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_id` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_label` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_max_packet_life_time` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_max_retransmits` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_protocol` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`ChannelState` | :ref:`get_ready_state` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_negotiated` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ordered` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`poll` **(** **)** | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`was_string_packet` **(** **)** |const| | +----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+ Enumerations ------------ .. _enum_WebRTCDataChannel_WriteMode: .. _class_WebRTCDataChannel_constant_WRITE_MODE_TEXT: .. _class_WebRTCDataChannel_constant_WRITE_MODE_BINARY: enum **WriteMode**: - **WRITE_MODE_TEXT** = **0** --- Tells the channel to send data over this channel as text. An external peer (non-Godot) would receive this as a string. - **WRITE_MODE_BINARY** = **1** --- Tells the channel to send data over this channel as binary. An external peer (non-Godot) would receive this as array buffer or blob. ---- .. _enum_WebRTCDataChannel_ChannelState: .. _class_WebRTCDataChannel_constant_STATE_CONNECTING: .. _class_WebRTCDataChannel_constant_STATE_OPEN: .. _class_WebRTCDataChannel_constant_STATE_CLOSING: .. _class_WebRTCDataChannel_constant_STATE_CLOSED: enum **ChannelState**: - **STATE_CONNECTING** = **0** --- The channel was created, but it's still trying to connect. - **STATE_OPEN** = **1** --- The channel is currently open, and data can flow over it. - **STATE_CLOSING** = **2** --- The channel is being closed, no new messages will be accepted, but those already in queue will be flushed. - **STATE_CLOSED** = **3** --- The channel was closed, or connection failed. Property Descriptions --------------------- .. _class_WebRTCDataChannel_property_write_mode: - :ref:`WriteMode` **write_mode** +-----------+-----------------------+ | *Default* | ``1`` | +-----------+-----------------------+ | *Setter* | set_write_mode(value) | +-----------+-----------------------+ | *Getter* | get_write_mode() | +-----------+-----------------------+ The transfer mode to use when sending outgoing packet. Either text or binary. Method Descriptions ------------------- .. _class_WebRTCDataChannel_method_close: - void **close** **(** **)** Closes this data channel, notifying the other peer. ---- .. _class_WebRTCDataChannel_method_get_buffered_amount: - :ref:`int` **get_buffered_amount** **(** **)** |const| Returns the number of bytes currently queued to be sent over this channel. ---- .. _class_WebRTCDataChannel_method_get_id: - :ref:`int` **get_id** **(** **)** |const| 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 ``65535`` until then). ---- .. _class_WebRTCDataChannel_method_get_label: - :ref:`String` **get_label** **(** **)** |const| Returns the label assigned to this channel during creation. ---- .. _class_WebRTCDataChannel_method_get_max_packet_life_time: - :ref:`int` **get_max_packet_life_time** **(** **)** |const| Returns the ``maxPacketLifeTime`` value assigned to this channel during creation. Will be ``65535`` if not specified. ---- .. _class_WebRTCDataChannel_method_get_max_retransmits: - :ref:`int` **get_max_retransmits** **(** **)** |const| Returns the ``maxRetransmits`` value assigned to this channel during creation. Will be ``65535`` if not specified. ---- .. _class_WebRTCDataChannel_method_get_protocol: - :ref:`String` **get_protocol** **(** **)** |const| Returns the sub-protocol assigned to this channel during creation. An empty string if not specified. ---- .. _class_WebRTCDataChannel_method_get_ready_state: - :ref:`ChannelState` **get_ready_state** **(** **)** |const| Returns the current state of this channel, see :ref:`ChannelState`. ---- .. _class_WebRTCDataChannel_method_is_negotiated: - :ref:`bool` **is_negotiated** **(** **)** |const| Returns ``true`` if this channel was created with out-of-band configuration. ---- .. _class_WebRTCDataChannel_method_is_ordered: - :ref:`bool` **is_ordered** **(** **)** |const| Returns ``true`` if this channel was created with ordering enabled (default). ---- .. _class_WebRTCDataChannel_method_poll: - :ref:`Error` **poll** **(** **)** Reserved, but not used for now. ---- .. _class_WebRTCDataChannel_method_was_string_packet: - :ref:`bool` **was_string_packet** **(** **)** |const| Returns ``true`` if the last received packet was transferred as text. See :ref:`write_mode`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`