.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/modules/webrtc/doc_classes/WebRTCPeerConnection.xml. .. _class_WebRTCPeerConnection: WebRTCPeerConnection ==================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`WebRTCPeerConnectionExtension` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`add_ice_candidate` **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`WebRTCDataChannel` | :ref:`create_data_channel` **(** :ref:`String` label, :ref:`Dictionary` options={} **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_offer` **(** **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ConnectionState` | :ref:`get_connection_state` **(** **)** |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GatheringState` | :ref:`get_gathering_state` **(** **)** |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`SignalingState` | :ref:`get_signaling_state` **(** **)** |const| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`initialize` **(** :ref:`Dictionary` configuration={} **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`poll` **(** **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_extension` **(** :ref:`StringName` extension_class **)** |static| | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`set_local_description` **(** :ref:`String` type, :ref:`String` sdp **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`set_remote_description` **(** :ref:`String` type, :ref:`String` sdp **)** | +-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_WebRTCPeerConnection_signal_data_channel_received: .. rst-class:: classref-signal **data_channel_received** **(** :ref:`WebRTCDataChannel` channel **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_signal_ice_candidate_created: .. rst-class:: classref-signal **ice_candidate_created** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_signal_session_description_created: .. rst-class:: classref-signal **session_description_created** **(** :ref:`String` type, :ref:`String` sdp **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_WebRTCPeerConnection_ConnectionState: .. rst-class:: classref-enumeration enum **ConnectionState**: .. _class_WebRTCPeerConnection_constant_STATE_NEW: .. rst-class:: classref-enumeration-constant :ref:`ConnectionState` **STATE_NEW** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_STATE_CONNECTING: .. rst-class:: classref-enumeration-constant :ref:`ConnectionState` **STATE_CONNECTING** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_STATE_CONNECTED: .. rst-class:: classref-enumeration-constant :ref:`ConnectionState` **STATE_CONNECTED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_STATE_DISCONNECTED: .. rst-class:: classref-enumeration-constant :ref:`ConnectionState` **STATE_DISCONNECTED** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_STATE_FAILED: .. rst-class:: classref-enumeration-constant :ref:`ConnectionState` **STATE_FAILED** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_STATE_CLOSED: .. rst-class:: classref-enumeration-constant :ref:`ConnectionState` **STATE_CLOSED** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_WebRTCPeerConnection_GatheringState: .. rst-class:: classref-enumeration enum **GatheringState**: .. _class_WebRTCPeerConnection_constant_GATHERING_STATE_NEW: .. rst-class:: classref-enumeration-constant :ref:`GatheringState` **GATHERING_STATE_NEW** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_GATHERING_STATE_GATHERING: .. rst-class:: classref-enumeration-constant :ref:`GatheringState` **GATHERING_STATE_GATHERING** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_GATHERING_STATE_COMPLETE: .. rst-class:: classref-enumeration-constant :ref:`GatheringState` **GATHERING_STATE_COMPLETE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_WebRTCPeerConnection_SignalingState: .. rst-class:: classref-enumeration enum **SignalingState**: .. _class_WebRTCPeerConnection_constant_SIGNALING_STATE_STABLE: .. rst-class:: classref-enumeration-constant :ref:`SignalingState` **SIGNALING_STATE_STABLE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_SIGNALING_STATE_HAVE_LOCAL_OFFER: .. rst-class:: classref-enumeration-constant :ref:`SignalingState` **SIGNALING_STATE_HAVE_LOCAL_OFFER** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_SIGNALING_STATE_HAVE_REMOTE_OFFER: .. rst-class:: classref-enumeration-constant :ref:`SignalingState` **SIGNALING_STATE_HAVE_REMOTE_OFFER** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_SIGNALING_STATE_HAVE_LOCAL_PRANSWER: .. rst-class:: classref-enumeration-constant :ref:`SignalingState` **SIGNALING_STATE_HAVE_LOCAL_PRANSWER** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_SIGNALING_STATE_HAVE_REMOTE_PRANSWER: .. rst-class:: classref-enumeration-constant :ref:`SignalingState` **SIGNALING_STATE_HAVE_REMOTE_PRANSWER** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_WebRTCPeerConnection_constant_SIGNALING_STATE_CLOSED: .. rst-class:: classref-enumeration-constant :ref:`SignalingState` **SIGNALING_STATE_CLOSED** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_WebRTCPeerConnection_method_add_ice_candidate: .. rst-class:: classref-method :ref:`Error` **add_ice_candidate** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_close: .. rst-class:: classref-method void **close** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_create_data_channel: .. rst-class:: classref-method :ref:`WebRTCDataChannel` **create_data_channel** **(** :ref:`String` label, :ref:`Dictionary` options={} **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_create_offer: .. rst-class:: classref-method :ref:`Error` **create_offer** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_get_connection_state: .. rst-class:: classref-method :ref:`ConnectionState` **get_connection_state** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_get_gathering_state: .. rst-class:: classref-method :ref:`GatheringState` **get_gathering_state** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_get_signaling_state: .. rst-class:: classref-method :ref:`SignalingState` **get_signaling_state** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_initialize: .. rst-class:: classref-method :ref:`Error` **initialize** **(** :ref:`Dictionary` configuration={} **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_poll: .. rst-class:: classref-method :ref:`Error` **poll** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_set_default_extension: .. rst-class:: classref-method void **set_default_extension** **(** :ref:`StringName` extension_class **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_set_local_description: .. rst-class:: classref-method :ref:`Error` **set_local_description** **(** :ref:`String` type, :ref:`String` sdp **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_WebRTCPeerConnection_method_set_remote_description: .. rst-class:: classref-method :ref:`Error` **set_remote_description** **(** :ref:`String` type, :ref:`String` sdp **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`