Home Manual Reference Source Repository

Typedef

Static Public Summary
public	MessageHeader: Object Header of the metadata of the messages sent/received over the `WebChannel`.
public	OpenData: Object Necessary data to join the `WebChannel`.
public	UserMessage: string \| ArrayBuffer \| TypedArray
public	WebChannelSettings: Object WebChannel settings

Static Public

public MessageHeader: Object source

Header of the metadata of the messages sent/received over the WebChannel.

Properties:

Name	Type	Attribute	Description
code	number		Message type code
senderId	number		Id of the sender peer
recipientId	number		Id of the recipient peer

public OpenData: Object source

Necessary data to join the WebChannel.

Properties:

Name	Type	Attribute	Description
url	string		Signaling server url
key	string		The unique key to join the `WebChannel`

public UserMessage: string | ArrayBuffer | TypedArray source

public WebChannelSettings: Object source

WebChannel settings

Properties:

Name	Type	Attribute	Description
connector	WEB_RTC \| WEB_SOCKET		Which connector is preferable during connection establishment
topology	FULLY_CONNECTED		Fully connected topology is the only one available for now
signalingURL	string		Signaling server url
iceServers	RTCIceServer		Set of ice servers for WebRTC
listenOn	string		Server url when the peer is listen on web socket