Class SignalingProviderEmitter

constructor

• new SignalingProviderEmitter(): SignalingProviderEmitter

  Returns SignalingProviderEmitter

Optional Readonlycapabilities

Readonlyversion

broadcast

• broadcast(_type: string, _payload: unknown): void

  Parameters

  • _type: string
  • _payload: unknown

  Returns void

connect

• connect(): void

  Returns void

disconnect

• disconnect(): void

  Returns void

endRoom

• endRoom(): void

  Returns void

getIceServers

• getIceServers(): Promise<RTCIceServer[]>

  Returns Promise<RTCIceServer[]>

joinRoom

• joinRoom(_roomId: string, _options?: JoinOptions): void

  Parameters

  • _roomId: string
  • Optional_options: JoinOptions

  Returns void

leaveRoom

• leaveRoom(): void

  Returns void

off

• off<K extends keyof SignalingProviderEventMap>(
      event: K,
      cb: (data: SignalingProviderEventMap[K]) => void,
  ): void

  Type Parameters

  • K extends keyof SignalingProviderEventMap

  Parameters

  • event: K
  • cb: (data: SignalingProviderEventMap[K]) => void

  Returns void

on

• on<K extends keyof SignalingProviderEventMap>(
      event: K,
      cb: (data: SignalingProviderEventMap[K]) => void,
  ): void

  Type Parameters

  • K extends keyof SignalingProviderEventMap

  Parameters

  • event: K
  • cb: (data: SignalingProviderEventMap[K]) => void

  Returns void

sendToPeer

• sendToPeer(_peerId: string, _type: string, _payload: unknown): void

  Deliver a message only to peerId. In particular, a targeted participant_media_state is ephemeral compatibility state: providers and their relays must not broadcast it, persist it, or replay it in room snapshots.

  Parameters

  • _peerId: string
  • _type: string
  • _payload: unknown

  Returns void