TTMSFNCWXWebRTCCommunication Class
Published WebRTC communication component for media capture, peer connections, signaling, and data channels.
API unit family: TMSFNCWXWebRTC
Inherits from: TTMSFNCWXCustomWebRTCCommunication
Syntax
TTMSFNCWXWebRTCCommunication = class(TTMSFNCWXCustomWebRTCCommunication)
Properties
| Name |
Description |
| AutoRequestAudioDevices |
When True, audio device access is requested automatically during initialization. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| AutoRequestVideoDevices |
When True, video device access is requested automatically during initialization. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| CSS |
Gets or sets the CSS content applied to the browser-hosted WebRTC surface. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| DefaultIceServers |
Gets or sets the default STUN and TURN servers assigned to new peer connections. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| DeviceList |
Gets the media devices discovered by the latest device enumeration. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| HTML |
Gets or sets the HTML content used to initialize the browser-hosted WebRTC surface. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| LocalVideoSettings |
Gets or sets the local media capture settings used by request methods. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| Peers |
Gets or sets the peer connections managed by the component. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
Methods
| Name |
Description |
| AcceptAnswer |
Accepts a remote answer for the specified peer connection. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| AcceptOffer |
Accepts a remote offer for the specified peer connection and prepares a local answer. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| AddDataChannel |
Adds a data channel to the specified peer connection. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| AddIceCandidate |
Adds a remote ICE candidate to the specified peer connection. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| AddPeerConnection |
Adds a peer connection and creates its browser-side video surface. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| CloseConnection |
Closes the peer connection with the specified identifier. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| CreateOffer |
Creates a local offer for the peer connection with the specified identifier. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| RemovePeerConnection |
Removes the peer connection with the specified identifier. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| RequestDevices |
Requests browser permission and enumerates available media devices. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| RequestDisplay |
Requests display capture from the browser. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| RequestUserMedia |
Requests local media capture using the configured video settings. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| RestartIce |
Restarts ICE negotiation for the specified peer connection. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| SendData |
Sends a text message over a data channel of the specified peer connection. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
Events
| Name |
Description |
| OnAnswer |
Occurs when a local answer must be sent to the remote peer. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnAnswerWithCandidates |
Occurs when a local answer with gathered candidates must be sent to the remote peer. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnDataChannelBinaryMessage |
Occurs when a binary message is received on a data channel. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnDataChannelOpen |
Occurs when a data channel becomes open and ready to exchange data. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnDataChannelStringMessage |
Occurs when a text message is received on a data channel. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnDeviceListInitialized |
Occurs after media device enumeration has populated DeviceList. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnIceCandidate |
Occurs when a local ICE candidate must be sent to the remote peer. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnIceConnectionStateChange |
Occurs when the ICE connection state of a peer changes. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnNegotiationNeeded |
Occurs when a peer connection requires renegotiation. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnOffer |
Occurs when a local offer must be sent to the remote peer. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnOfferWithCandidates |
Occurs when a local offer with gathered candidates must be sent to the remote peer. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnUserMediaError |
Occurs when a request for camera or microphone access fails. (inherited from TTMSFNCWXCustomWebRTCCommunication) |
| OnUserMediaStart |
Occurs when local media capture starts successfully. (inherited from TTMSFNCWXCustomWebRTCCommunication) |