Instantiate the WSController, connect to the WebSocket endpoint and call _open() to create the RTCPeerConnection.
By default, a listener channel is negotiated. To create a streamer channel, pass a stream parameter.
Optional
stream: MediaStreamPrivate
Optional
_promisePrivate
Optional
_reportPrivate
Optional
_reportPrivate
_wsStart a log
a Log object with the levels of log to call
True when connector is closed, in other words when onClose event is fired
Indicate codecs supported, should be set before than onOpen happen
True when connector is opened, in other words when onOpen event is fired
Media Stream description delivred from the server if we are player, or build from the local camera if we are the streamer.
Stream name, for example as+bc3f535f-37f3-458b-8171-b4c5e77a6137
Private
_clearProtected
_eventProtected
_openProtected
_sipPrivate
_startClose the connector
Optional
error: ConnectorErrorthe error reason if is not a proper close
Returns connection info, such as round trip time, requests sent and received, bytes sent and received, and bitrates NOTE: This call is resource-intensive for the CPU.
A promise that resolves to an RTCStatsReport object
Event unsubscription
Name of event without the 'on' prefix (ex: 'log' to 'onLog' event declared)
Event subscription
Name of event without the on
prefix (ex: log
to onLog
event declared)
Subscriber Function
Optional
options: { Optional
signal?: AbortSignalOptional AbortSignal
to stop this or multiple subscriptions in same time
Event subscription only one time, once time fired it's automatically unsubscribe
Name of event without the on
prefix (ex: log
to onLog
event declared)
Subscriber Function
Optional
options: { Optional
signal?: AbortSignalSets server properties for packet error (nack) and delayed packet loss (drop) for a streamer controller and fires an onRTPProps event if changed successfully. NOTE: Method can also retrieve current server values if called without arguments.
Optional
nack: numberWaiting period before declaring a packet error
Optional
drop: numberWaiting period before considering delayed packets as lost
Call when connector is closed
Optional
error: ConnectorErrorerror description on an improper closure
Call to distribute MediaReport
Media report informations
Call to distribute PlayingInfos
Current playing informations
Generated using TypeDoc
Use WSController to negotiate a new RTCPeerConnection connection with the server using WebSocket custom signaling and keep that connection open for communication.
Example