Interface CallState

Primary observable call state. This is the main state object consumers subscribe to via SerenadaSessionHandle.subscribe.

interface CallState {
    activeTransport: ActiveTransport | null;
    connectionStatus: ConnectionStatus;
    error: CallError | null;
    localParticipant: LocalParticipant | null;
    phase: CallPhase;
    remoteParticipants: Participant[];
    requiredPermissions: MediaCapability[] | null;
    roomId: string | null;
    roomUrl: string | null;
    signalingState: SignalingState;
}

Index

Properties

activeTransport connectionStatus error localParticipant phase remoteParticipants requiredPermissions roomId roomUrl signalingState

Properties

activeTransport

activeTransport: ActiveTransport | null

connectionStatus

connectionStatus: ConnectionStatus

error

error: CallError | null

localParticipant

localParticipant: LocalParticipant | null

phase

phase: CallPhase

remoteParticipants

remoteParticipants: Participant[]

requiredPermissions

requiredPermissions: MediaCapability[] | null

roomId

roomId: string | null

roomUrl

roomUrl: string | null

signalingState

signalingState: SignalingState

Richer signaling-transport state with timing details. Apps that don't need the extra detail can stick with connectionStatus.