Skip to main content

Class: WebRTCConnection

Constructors​

constructor​

• new WebRTCConnection(): WebRTCConnection

Returns​

WebRTCConnection

Properties​

onClose​

• onClose: () => void = null

Type declaration​

▸ (): void

Returns​

void


onMessage​

• onMessage: (data: ArrayBuffer) => void = null

Type declaration​

▸ (data): void

Parameters​
NameType
dataArrayBuffer
Returns​

void


onOpen​

• onOpen: () => void = null

Type declaration​

▸ (): void

Returns​

void

Accessors​

isConnected​

• get isConnected(): boolean

Returns​

boolean

Methods​

close​

▸ close(): void

Returns​

void


connect​

▸ connect(serverUrl, clientId, ticket?): Promise<void>

Open the data channel for an already-registered session. ticket is the same signed session credential the WebSocket upgrade carried; the server derives the acting client id from it, so without one the offer is only accepted on servers that trust client-chosen ids.

Parameters​

NameType
serverUrlstring
clientIdstring
ticket?string

Returns​

Promise<void>