WebRtcPeerConnection

public Error AddIceCandidate(string media, int index, string name);

Passes a remote ICE candidate to the implementation. Associate it with the correct signaling session and remote-description readiness.

public void Close();

Close the peer connection and all data channels associated with it. Note: You cannot reuse this object for a new connection unless you call WebRtcPeerConnection.Initialize.

public WebRtcDataChannel CreateDataChannel(string label, Reckfell.Collections.Dictionary options = null);

Creates a channel through the implementation. On the initiator create required channels before the offer; an object is not necessarily an open channel.

public Error CreateOffer();

Requests SDP offer creation; SessionDescriptionCreated supplies the result. The application supplies signaling and delivery to the other participant.

public WebRtcPeerConnection.ConnectionState GetConnectionState();

Returns the connection state.

public WebRtcPeerConnection.GatheringState GetGatheringState();

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

public WebRtcPeerConnection.SignalingState GetSignalingState();

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

public Error Initialize(Reckfell.Collections.Dictionary configuration = null);

Passes configuration to the selected implementation. A zero result on empty Extension does not prove implementation: inspect required-virtual diagnostics and actual exchange.

public Error Poll();

Call this method frequently (e.g. in Entity._Process or Entity._PhysicsProcess) to properly receive signals.

public static void SetDefaultExtension(StringName extensionClass);

Selects a registered implementation inheriting the required Extension class. Does not download a library or verify compatibility/operation.

public Error SetLocalDescription(string type, string sdp);

Sets the SDP description of the local peer. This should be called in response to WebRtcPeerConnection.SessionDescriptionCreated. After calling this function the peer will start emitting WebRtcPeerConnection.IceCandidateCreated (unless an Error different from OK is returned).

public Error SetRemoteDescription(string type, string sdp);

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 type is "offer" the peer will emit WebRtcPeerConnection.SessionDescriptionCreated with the appropriate answer. If type is "answer" the peer will start emitting WebRtcPeerConnection.IceCandidateCreated.

public event WebRtcPeerConnection.DataChannelReceivedEventHandler DataChannelReceived;

Emitted when a new in-band channel is received, i.e. when the channel was created with negotiated: false (default). The object will be an instance of WebRtcDataChannel. You must keep a reference of it or it will be closed automatically. See WebRtcPeerConnection.CreateDataChannel.

public event WebRtcPeerConnection.IceCandidateCreatedEventHandler IceCandidateCreated;

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.

public event WebRtcPeerConnection.SessionDescriptionCreatedEventHandler SessionDescriptionCreated;

Emitted after a successful call to WebRtcPeerConnection.CreateOffer or WebRtcPeerConnection.SetRemoteDescription (when it generates an answer). The parameters are meant to be passed to WebRtcPeerConnection.SetLocalDescription on this object, and sent to the remote peer over the signaling server.