Class SerenadaSession

constructor

• new SerenadaSession(
      config: SerenadaConfig,
      roomId: string,
      roomUrl: string | null,
      signaling: SignalingProvider,
      deps?: SessionDependencies,
  ): SerenadaSession

  Parameters

  • config: SerenadaConfig
  • roomId: string
  • roomUrl: string | null
  • signaling: SignalingProvider
  • deps: SessionDependencies = {}

  Returns SerenadaSession

onPermissionsRequired

callQualitySummary

• get callQualitySummary(): CallQualitySummary | null

  Aggregate call-quality summary. Reflects the live tracker while in-call and the finalized snapshot after the call ends; stays readable after teardown.

  Returns CallQualitySummary | null

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

independentContentVideoEnabled

• get independentContentVideoEnabled(): boolean

  Whether this session negotiated the independent content video path.

  Returns boolean

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

captureSnapshot

• captureSnapshot(source?: SnapshotSource): Promise<SnapshotResult>

  Capture the current video frame from the chosen stream as an image/jpeg Blob at the source track's full intrinsic resolution. Rejects with a SnapshotError if the stream is missing/inactive, the chosen participant has video off, or no frame arrives in time.

  Parameters

  • source: SnapshotSource = ...

  Returns Promise<SnapshotResult>

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 in the configured order.

  Returns Promise<void>

getLocalContentStream

• getLocalContentStream(): MediaStream | null

  Local content (screen share) stream for optional local preview.

  Returns MediaStream | null

getRemoteCameraStream

• getRemoteCameraStream(cid: string): MediaStream | undefined

  Remote camera stream for a participant (independent mode), else legacy.

  Parameters

  • cid: string

  Returns MediaStream | undefined

getRemoteContentStream

• getRemoteContentStream(cid: string): MediaStream | undefined

  Remote content (screen share) stream for a participant, if negotiated.

  Parameters

  • cid: string

  Returns MediaStream | undefined

getRemoteIndependentContentVideo

• getRemoteIndependentContentVideo(cid: string): boolean

  Read a remote participant's effective capabilities with contract defaults applied (missing independentContentVideo → false).

  Parameters

  • cid: string

  Returns boolean

getRemoteStream

• getRemoteStream(cid: string): MediaStream | undefined

  Legacy camera stream accessor (same as remoteStreams.get(cid)).

  Parameters

  • cid: string

  Returns MediaStream | undefined

getRemoteVideoMediaEnabled

• getRemoteVideoMediaEnabled(cid: string): boolean

  Read a remote participant's effective videoMediaEnabled with contract defaults applied (missing → true).

  Parameters

  • cid: string

  Returns boolean

leave

• leave(): void

  Leave the call gracefully. The other participant stays connected.

  Returns void

onConnectionEvent

• onConnectionEvent(callback: (event: ConnectionEvent) => void): () => void

  Subscribe to connection-quality events (reconnected / reconnect failed). Returns an unsubscribe function. Mirrors onPeerMessage.

  Parameters

  • callback: (event: ConnectionEvent) => void

  Returns () => void

onPeerMessage

• onPeerMessage(callback: (message: PeerMessage) => void): () => void

  Parameters

  • callback: (message: PeerMessage) => void

  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

toggleAudio

• toggleAudio(): void

  Toggle local audio on/off.

  Returns void

toggleVideo

• toggleVideo(): void

  Toggle local video on/off.

  Returns void