Class Sfu

Constructors

constructor

Properties

#_nickname #_room #_state #_webRTCMetricsServerDescription #connection #logger #loggerPrefix #notifier #url

Methods

connect createRoom disconnect nickname off on room state

Constructors

constructor

Properties

Private #_nickname

#_nickname: string

Private #_room

#_room: Room

Private #_state

#_state: State = State.NEW

Private #_webRTCMetricsServerDescription

#_webRTCMetricsServerDescription: RTCMetricsServerDescription

Private #connection

#connection: Connection

Private #logger

#logger: default = ...

Private #loggerPrefix

#loggerPrefix: PrefixFunction

Private #notifier

#notifier: Notifier<SfuEvent, InternalMessage> = ...

Private #url

#url: string

Methods

connect

  • connect(options): Promise<void>

  • Parameters

    • options: {
          failedProbesThreshold?: number;
          logGroup: string;
          nickname: string;
          pingInterval?: number;
          timeout?: number;
          url: string;
      }
      • Optional failedProbesThreshold?: number
      • logGroup: string
      • nickname: string
      • Optional pingInterval?: number
      • Optional timeout?: number
      • url: string

    Returns Promise<void>

createRoom

  • createRoom(options): Room

  • Parameters

    • options: {
          name: string;
          pin: string;
      }
      • name: string
      • pin: string

    Returns Room

disconnect

  • disconnect(): Promise<void>

  • Returns Promise<void>

nickname

  • nickname(): string

  • Returns string

off

  • off(event, callback): Sfu

  • Parameters

    Returns Sfu

on

  • on(event, callback): Sfu

  • Parameters

    Returns Sfu

room

  • room(): Room

  • Returns Room

state

Settings

Member Visibility

Theme

On This Page

constructor#_nickname#_room#_state#_webRTCMetricsServerDescription#connection#logger#loggerPrefix#notifier#urlconnectcreateRoomdisconnectnicknameoffonroomstate