Class SerenadaSession

constructor

• new SerenadaSession(
      config: SerenadaConfig,
      roomId: string,
      roomUrl: string | null,
      deps?: {
          media?: MediaEngine;
          signaling?: SignalingEngine;
          statsCollector?: CallStatsCollector;
      },
  ): SerenadaSession

  Parameters

  • config: SerenadaConfig
  • roomId: string
  • roomUrl: string | null
  • Optionaldeps: {
        media?: MediaEngine;
        signaling?: SignalingEngine;
        statsCollector?: CallStatsCollector;
    }

  Returns SerenadaSession

onPermissionsRequired

callStats

• get callStats(): CallStats | null

  Current WebRTC call statistics, or null if not yet collecting.

  Returns CallStats | null

canScreenShare

• get canScreenShare(): boolean

  Returns boolean

hasMultipleCameras

• get hasMultipleCameras(): boolean

  Returns boolean

iceConnectionState

• get iceConnectionState(): RTCIceConnectionState

  Returns RTCIceConnectionState

isSignalingConnected

• get isSignalingConnected(): boolean

  Returns boolean

localStream

• get localStream(): MediaStream | null

  Local media stream (camera/microphone), or null before media is acquired.

  Returns MediaStream | null

peerConnectionState

• get peerConnectionState(): RTCPeerConnectionState

  Returns RTCPeerConnectionState

remoteStreams

• get remoteStreams(): Map<string, MediaStream>

  Map of remote participant CID to their media stream.

  Returns Map<string, MediaStream>

rtcSignalingState

• get rtcSignalingState(): RTCSignalingState

  Returns RTCSignalingState

state

• get state(): CallState

  Current call state. Subscribe via subscribe for updates.

  Returns CallState

cancelJoin

• cancelJoin(): void

  Cancel an in-progress join and destroy the session.

  Returns void

destroy

• destroy(): void

  Clean up all resources. Call when done with the session.

  Returns void

end

• end(): void

  End the call for all participants.

  Returns void

flipCamera

• flipCamera(): Promise<void>

  Cycle to the next camera mode (selfie to world or vice versa).

  Returns Promise<void>

leave

• leave(): void

  Leave the call gracefully. The other participant stays connected.

  Returns void

resumeJoin

• resumeJoin(): Promise<void>

  Resume joining after media permissions have been granted.

  Returns Promise<void>

setAudioEnabled

• setAudioEnabled(enabled: boolean): void

  Set local audio enabled state explicitly.

  Parameters

  • enabled: boolean

  Returns void

setCameraMode

• setCameraMode(_mode: CameraMode): void

  Switch camera mode (selfie/world). Composite is not available on web.

  Parameters

  • _mode: CameraMode

  Returns void

setVideoEnabled

• setVideoEnabled(enabled: boolean): void

  Set local video enabled state explicitly.

  Parameters

  • enabled: boolean

  Returns void

startScreenShare

• startScreenShare(): Promise<void>

  Start sharing the screen, replacing the camera video track.

  Returns Promise<void>

stopScreenShare

• stopScreenShare(): Promise<void>

  Stop screen sharing and restore the camera video track.

  Returns Promise<void>

subscribe

• subscribe(callback: (state: CallState) => void): () => void

  Subscribe to state changes. Returns an unsubscribe function.

  Parameters

  • callback: (state: CallState) => void

  Returns () => void

subscribeToMessages

• subscribeToMessages(callback: (message: SignalingMessage) => void): () => void

  Parameters

  • callback: (message: SignalingMessage) => void

  Returns () => void

toggleAudio

• toggleAudio(): void

  Toggle local audio on/off.

  Returns void

toggleVideo

• toggleVideo(): void

  Toggle local video on/off.

  Returns void