Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DefaultSignalingClient

DefaultSignalingClient implements the SignalingClient interface.

Hierarchy

  • DefaultSignalingClient

Implements

Index

Constructors

constructor

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

demoteFromPrimaryMeeting

  • demoteFromPrimaryMeeting(): 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

promoteToPrimaryMeeting

  • Allows an attendee in a replica meeting to join the primary meeting as if they were a normal attendee. Once successfully joined they will receive a callback on SignalingClientObserver.handleSignalingClientEvent. See documentation of observer for more information.

    They may also receive another callback on SignalingClientObserver.handleSignalingClientEvent to indicate they can begin to share video.

    Failure will also be indicated through the SignalingClientObserver.handleSignalingClientEvent callback.

    Parameters

    Returns void

ready

  • ready(): boolean

registerObserver

remoteVideoUpdate

removeObserver

resume

  • resume(streamIds: number[]): void

sendClientMetrics

  • sendClientMetrics(clientMetricFrame: SdkClientMetricFrame): void

sendDataMessage

  • sendDataMessage(messageFrame: SdkDataMessageFrame): void

subscribe

Generated using TypeDoc