SignalingClient is the top-level interface for opening a signaling connection over WebSocket.
Closes any existing connection.
Prior to closing, it delivers a WebSocketClosing event. Upon receipt of the final WebSocket close event, the connection request queue is serviced. If there is no connection to close, this function just services the connection request queue and returns.
Sends a join frame with the given settings.
How to configure the Join frame.
Sends a leave frame.
Mute or unmute the client
Whether the client is to be muted (true) or unmuted (false)
Enqueues an attempt to open a signaling connection over WebSocket.
Once initiated, a WebSocketConnecting event is sent to observers. If successful, a WebSocketOpen event is sent out. If the connection could not be established for any reason, a WebSocketFailed event is sent followed by WebSocketClosed event. If any existing connection is open, then that is first closed (and the WebSocketClosed event is sent out) before the open is tried.
The request to enqueue.
Sends a pause frame with the given stream ids.
Sends a ping or pong with an id.
ping or pong frame to send.
the ms timestamp when the message was sent.
Returns whether the client has a connection open in the ready state
Whether the client has a connection open in the ready state
Adds an observer to the observer queue with immediate effect.
The observer to add to the queue.
Removes an observer from the observer queue with immediate effect.
The observer to remove from the queue.
Sends a resume frame with the given stream ids.
Sends a client stats frame.
Send a message frame to data channel
Sends a subscribe frame with the given settings.
How to configure the Subscribe frame.
Generated using TypeDoc