@serenada/core
    Preparing search index...

    Interface SerenadaSessionHandle

    Public interface for an active call session. Consumers should use this instead of the concrete SerenadaSession class.

    interface SerenadaSessionHandle {
        callStats: CallStats | null;
        canScreenShare: boolean;
        hasMultipleCameras: boolean;
        iceConnectionState: RTCIceConnectionState;
        isSignalingConnected: boolean;
        localStream: MediaStream | null;
        onPermissionsRequired: ((permissions: MediaCapability[]) => void) | null;
        peerConnectionState: RTCPeerConnectionState;
        remoteStreams: Map<string, MediaStream>;
        rtcSignalingState: RTCSignalingState;
        state: CallState;
        cancelJoin(): void;
        destroy(): void;
        end(): void;
        flipCamera(): Promise<void>;
        leave(): void;
        resumeJoin(): Promise<void>;
        setAudioEnabled(enabled: boolean): void;
        setCameraMode(mode: CameraMode): void;
        setVideoEnabled(enabled: boolean): void;
        startScreenShare(): Promise<void>;
        stopScreenShare(): Promise<void>;
        subscribe(callback: (state: CallState) => void): () => void;
        subscribeToMessages(
            callback: (message: SignalingMessage) => void,
        ): () => void;
        toggleAudio(): void;
        toggleVideo(): void;
    }

    Implemented by

    Index

    Properties

    callStats canScreenShare hasMultipleCameras iceConnectionState isSignalingConnected localStream onPermissionsRequired peerConnectionState remoteStreams rtcSignalingState state

    Methods

    cancelJoin destroy end flipCamera leave resumeJoin setAudioEnabled setCameraMode setVideoEnabled startScreenShare stopScreenShare subscribe subscribeToMessages toggleAudio toggleVideo

    Properties

    callStats: CallStats | null
    canScreenShare: boolean
    hasMultipleCameras: boolean
    iceConnectionState: RTCIceConnectionState
    isSignalingConnected: boolean
    localStream: MediaStream | null
    onPermissionsRequired: ((permissions: MediaCapability[]) => void) | null
    peerConnectionState: RTCPeerConnectionState
    remoteStreams: Map<string, MediaStream>
    rtcSignalingState: RTCSignalingState
    state: CallState

    Methods

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      • enabled: boolean

      Returns void

    • Parameters

      • enabled: boolean

      Returns void

    • Returns Promise<void>

    • Returns Promise<void>

    • Parameters

      Returns () => void

    • Parameters

      • callback: (message: SignalingMessage) => void

      Returns () => void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods