Class SerenadaServerProvider

constructor

• new SerenadaServerProvider(
      config: SerenadaServerProviderConfig,
  ): SerenadaServerProvider

  Parameters

  • config: SerenadaServerProviderConfig

  Returns SerenadaServerProvider

Readonlycapabilities

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
  • Optionaloptions: JoinOptions

  Returns void

leaveRoom

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

setTurnRefreshGate

• setTurnRefreshGate(gate: (() => Promise<boolean>) | null): void

  Install (or clear) a gate consulted before each periodic TURN refresh. The gate returns false to skip the refresh — used by the session to suppress refreshes while every peer is on a direct ICE path, so the call remains independent of signaling for the refresh cadence.

  Parameters

  • gate: (() => Promise<boolean>) | null

  Returns void