Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SignalingClient

SignalingClient is the top-level interface for opening a signaling connection over WebSocket.

Hierarchy

  • SignalingClient

Implemented by

Index

Methods

closeConnection

  • closeConnection(): void
  • 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.

    Returns void

join

leave

  • leave(): void

mute

  • mute(muted: boolean): void

openConnection

  • 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.

    Parameters

    Returns void

pause

  • pause(streamIds: number[]): void

pingPong

  • pingPong(pingPongFrame: SdkPingPongFrame): number
  • Sends a ping or pong with an id.

    Parameters

    • pingPongFrame: SdkPingPongFrame

      ping or pong frame to send.

    Returns number

    the ms timestamp when the message was sent.

ready

  • ready(): boolean

registerObserver

removeObserver

resume

  • resume(streamIds: number[]): void

sendClientMetrics

  • sendClientMetrics(clientMetricFrame: SdkClientMetricFrame): void

sendDataMessage

  • sendDataMessage(messageFrame: SdkDataMessageFrame): void

subscribe

Generated using TypeDoc