Member Junction
    Preparing search index...

    Interface LiveKitRoomState

    A snapshot of the whole room state, emitted whenever anything material changes.

    interface LiveKitRoomState {
        ActiveSpeakerIdentities: string[];
        AudioPlaybackBlocked: boolean;
        BackgroundEffect: LiveKitBackgroundEffect;
        DisconnectReason?: LiveKitDisconnectReason;
        E2EEEnabled: boolean;
        Local?: LiveKitParticipantView;
        LocalMedia: LiveKitLocalMediaState;
        NoiseFilterEnabled: boolean;
        Remote: LiveKitParticipantView[];
        RoomName?: string;
        Status: LiveKitConnectionStatus;
    }
    Index

    Properties

    ActiveSpeakerIdentities AudioPlaybackBlocked BackgroundEffect DisconnectReason? E2EEEnabled Local? LocalMedia NoiseFilterEnabled Remote RoomName? Status

    Properties

    ActiveSpeakerIdentities: string[]

    Identities currently flagged as active speakers, most-recent first.

    AudioPlaybackBlocked: boolean

    Whether browser autoplay policy is blocking remote audio (the UI should prompt to enable sound).

    BackgroundEffect: LiveKitBackgroundEffect

    The active camera background effect.

    DisconnectReason?: LiveKitDisconnectReason

    The reason for disconnect, once disconnected.

    E2EEEnabled: boolean

    Whether end-to-end encryption is enabled for this connection.

    Local?: LiveKitParticipantView

    The local participant's view, once connected.

    LocalMedia: LiveKitLocalMediaState

    The local-media toggle state.

    NoiseFilterEnabled: boolean

    Whether the Krisp noise filter is currently applied to the local microphone.

    Remote: LiveKitParticipantView[]

    All remote participants.

    RoomName?: string

    The room name once connected.

    Status: LiveKitConnectionStatus

    The connection lifecycle status.

    Settings

    Member Visibility

    On This Page

    Properties