TsgcRTCPeerConnection › Events

TsgcRTCPeerConnection Events

Events you can handle, grouped by purpose, followed by the full alphabetical list.

Signalling (WebSocket)

Name	Description
OnRTCWebSocketBeforeConnect	Fired before the signalling WebSocket client connects; lets you tweak the client.
OnRTCWebSocketConnect	Fired when the signalling WebSocket has connected to the server.
OnRTCWebSocketDisconnect	Fired when the signalling WebSocket disconnects; the close code is provided.
OnRTCWebSocketRemoteDisconnect	Fired when the remote peer requests a disconnect via signalling.
OnRTCWebSocketMessage	Fired when a raw signalling text message is received on the WebSocket.

SDP / candidates

Name	Description
OnRTCLocalCandidate	Fired when a local ICE candidate has been gathered; set Accept to False to drop it.
OnRTCLocalDescription	Fired when the local SDP offer/answer has been generated and can be edited.
OnRTCRemoteCandidate	Fired when a remote ICE candidate is received; set Accept to False to drop it.
OnRTCRemoteDescription	Fired when the remote SDP offer/answer is received through signalling.
OnRTCCandidatePairNominated	Fired when ICE connectivity checks nominate a candidate pair; set Accept to False to reject.
OnRTCCandidatePairFailed	Fired when an ICE candidate pair fails the connectivity check; the reason is provided.

Data channel

Name	Description
OnRTCConnect	Fired when the data channel is open and ready to send and receive data.
OnRTCMessage	Fired when data is received from the remote peer through the data channel.
OnRTCException	Fired when an exception is raised inside the peer-connection pipeline.

All Events (alphabetical)

Name	Description
OnRTCCandidatePairFailed	Fired when an ICE candidate pair fails the connectivity check; the reason is provided.
OnRTCCandidatePairNominated	Fired when ICE connectivity checks nominate a candidate pair; set Accept to False to reject.
OnRTCConnect	Fired when the data channel is open and ready to send and receive data.
OnRTCException	Fired when an exception is raised inside the peer-connection pipeline.
OnRTCLocalCandidate	Fired when a local ICE candidate has been gathered; set Accept to False to drop it.
OnRTCLocalDescription	Fired when the local SDP offer/answer has been generated and can be edited.
OnRTCMessage	Fired when data is received from the remote peer through the data channel.
OnRTCRemoteCandidate	Fired when a remote ICE candidate is received; set Accept to False to drop it.
OnRTCRemoteDescription	Fired when the remote SDP offer/answer is received through signalling.
OnRTCWebSocketBeforeConnect	Fired before the signalling WebSocket client connects; lets you tweak the client.
OnRTCWebSocketConnect	Fired when the signalling WebSocket has connected to the server.
OnRTCWebSocketDisconnect	Fired when the signalling WebSocket disconnects; the close code is provided.
OnRTCWebSocketMessage	Fired when a raw signalling text message is received on the WebSocket.
OnRTCWebSocketRemoteDisconnect	Fired when the remote peer requests a disconnect via signalling.