.. 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/jam_launch/JamWebRTCHelper.xml. .. _class_JamWebRTCHelper: JamWebRTCHelper =============== **Inherits:** :ref:`Node` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------------+--------------------------------------------------------------+-----------+ | :ref:`JamWebRTCSignalling` | :ref:`signalling` | | +-----------------------------------------------------------+--------------------------------------------------------------+-----------+ | :ref:`WebRTCMultiplayerPeer` | :ref:`rtc_mp` | ``new()`` | +-----------------------------------------------------------+--------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`sealed` | ``false`` | +-----------------------------------------------------------+--------------------------------------------------------------+-----------+ | :ref:`Dictionary` | :ref:`peers` | ``{}`` | +-----------------------------------------------------------+--------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`local_pid` | ``-1`` | +-----------------------------------------------------------+--------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_init` **(** **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`JamError` | :ref:`start` **(** :ref:`String` url **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`stop` **(** **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`_add_webrtc_peer` **(** :ref:`int` id **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_new_ice_candidate` **(** :ref:`String` mid_name, :ref:`int` index_name, :ref:`String` sdp_name, :ref:`int` id **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_offer_created` **(** :ref:`String` type, :ref:`String` data, :ref:`int` id **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_connected` **(** :ref:`int` pid, :ref:`Dictionary` pinfo **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_disconnected` **(** **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_peer_connected` **(** :ref:`int` pid, :ref:`Dictionary` pinfo **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_peer_disconnected` **(** :ref:`int` id **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_session_sealed` **(** **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_offer_received` **(** :ref:`int` id, :ref:`String` offer **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_answer_received` **(** :ref:`int` id, :ref:`String` answer **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_candidate_received` **(** :ref:`int` id, :ref:`String` mid, :ref:`int` index, :ref:`String` sdp **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_err` **(** :ref:`String` msg, :ref:`Error` code=0 **)** | +---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_JamWebRTCHelper_signal_errored: .. rst-class:: classref-signal **errored** **(** :ref:`String` msg **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_signal_multiplayer_initialized: .. rst-class:: classref-signal **multiplayer_initialized** **(** :ref:`int` pid, :ref:`Dictionary` pinfo **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_signal_multiplayer_terminating: .. rst-class:: classref-signal **multiplayer_terminating** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_signal_peer_added: .. rst-class:: classref-signal **peer_added** **(** :ref:`int` pid **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_signal_peer_removed: .. rst-class:: classref-signal **peer_removed** **(** :ref:`int` pid **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_signal_session_sealed: .. rst-class:: classref-signal **session_sealed** **(** **)** .. 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 Property Descriptions --------------------- .. _class_JamWebRTCHelper_property_signalling: .. rst-class:: classref-property :ref:`JamWebRTCSignalling` **signalling** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_property_rtc_mp: .. rst-class:: classref-property :ref:`WebRTCMultiplayerPeer` **rtc_mp** = ``new()`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_property_sealed: .. rst-class:: classref-property :ref:`bool` **sealed** = ``false`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_property_peers: .. rst-class:: classref-property :ref:`Dictionary` **peers** = ``{}`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_property_local_pid: .. rst-class:: classref-property :ref:`int` **local_pid** = ``-1`` .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_JamWebRTCHelper_private_method__init: .. rst-class:: classref-method void **_init** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_method_start: .. rst-class:: classref-method :ref:`JamError` **start** **(** :ref:`String` url **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_method_stop: .. rst-class:: classref-method void **stop** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__add_webrtc_peer: .. rst-class:: classref-method :ref:`Variant` **_add_webrtc_peer** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__new_ice_candidate: .. rst-class:: classref-method void **_new_ice_candidate** **(** :ref:`String` mid_name, :ref:`int` index_name, :ref:`String` sdp_name, :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__offer_created: .. rst-class:: classref-method void **_offer_created** **(** :ref:`String` type, :ref:`String` data, :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__connected: .. rst-class:: classref-method void **_connected** **(** :ref:`int` pid, :ref:`Dictionary` pinfo **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__disconnected: .. rst-class:: classref-method void **_disconnected** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__peer_connected: .. rst-class:: classref-method void **_peer_connected** **(** :ref:`int` pid, :ref:`Dictionary` pinfo **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__peer_disconnected: .. rst-class:: classref-method void **_peer_disconnected** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__session_sealed: .. rst-class:: classref-method void **_session_sealed** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__offer_received: .. rst-class:: classref-method void **_offer_received** **(** :ref:`int` id, :ref:`String` offer **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__answer_received: .. rst-class:: classref-method void **_answer_received** **(** :ref:`int` id, :ref:`String` answer **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_JamWebRTCHelper_private_method__candidate_received: .. rst-class:: classref-method void **_candidate_received** **(** :ref:`int` id, :ref:`String` mid, :ref:`int` index, :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_JamWebRTCHelper_private_method__err: .. rst-class:: classref-method void **_err** **(** :ref:`String` msg, :ref:`Error` code=0 **)** .. 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.)`