ConnectionState

Types

• enum GatheringState
• class Signal1

  Signal support.

• class Signal2

  Signal support.

• class Signal3

  Signal support.

• enum SignalingState

Type members

• static func setDefaultExtension(extensionClass: StringName)

  Sets the extensionClass as the default WebRTCPeerConnectionExtension returned when creating a new WebRTCPeerConnection.

• class var godotClassName: StringName

Instance members

• var dataChannelReceived: Signal3

  Emitted when a new in-band channel is received, i.e. when the channel was created with negotiated: false (default).

• var iceCandidateCreated: Signal2

  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.

• var sessionDescriptionCreated: Signal1

  Emitted after a successful call to createOffer or setRemoteDescription(type:sdp:) (when it generates an answer). The parameters are meant to be passed to setLocalDescription(type:sdp:) on this object, and sent to the remote peer over the signaling server.

• func addIceCandidate(media: String, index: Int32, name: String) -> GodotError

  Add an ice candidate generated by a remote peer (and received over the signaling server). See [signal ice_candidate_created].

• func close()

  Close the peer connection and all data channels associated with it.

• func createDataChannel(label: String, options: GDictionary) -> WebRTCDataChannel?

  Returns a new WebRTCDataChannel (or null on failure) with given label and optionally configured via the options dictionary. This method can only be called when the connection is in state .stateNew.

• func createOffer() -> GodotError

  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.

• func getConnectionState() -> WebRTCPeerConnection.ConnectionState

  Returns the connection state. See ConnectionState.

• func getGatheringState() -> WebRTCPeerConnection.GatheringState

  Returns the ICE GatheringState of the connection. This lets you detect, for example, when collection of ICE candidates has finished.

• func getSignalingState() -> WebRTCPeerConnection.SignalingState

  Returns the signaling state on the local end of the connection while connecting or reconnecting to another peer.

• func initialize(configuration: GDictionary) -> GodotError

  Re-initialize this peer connection, closing any previously active connection, and going back to state .stateNew. A dictionary of configuration options can be passed to configure the peer connection.

• func poll() -> GodotError

  Call this method frequently (e.g. in _process(delta:) or _physicsProcess(delta:)) to properly receive signals.

• func setLocalDescription(type: String, sdp: String) -> GodotError

  Sets the SDP description of the local peer. This should be called in response to [signal session_description_created].

• func setRemoteDescription(type: String, sdp: String) -> GodotError

  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.