Member Junction
    Preparing search index...

    Interface LiveKitRoomEventMap

    The full event map: event name → payload type. Names use the before* prefix for cancelable events and a past-tense / noun form for notifications, matching the conversations-stack vocabulary.

    interface LiveKitRoomEventMap {
        activeSpeakersChanged: LiveKitActiveSpeakersEvent;
        audioPlaybackChanged: { CanPlayback: boolean };
        backgroundEffectChanged: { Effect: LiveKitBackgroundEffect };
        beforeConnect: LiveKitBeforeConnectEvent;
        beforeDeviceSwitch: LiveKitBeforeDeviceSwitchEvent;
        beforeDisconnect: LiveKitBeforeDisconnectEvent;
        beforeMediaToggle: LiveKitBeforeMediaToggleEvent;
        beforeSendData: LiveKitBeforeSendDataEvent;
        connected: { State: LiveKitRoomState };
        dataReceived: LiveKitDataMessage;
        disconnected: LiveKitDisconnectedEvent;
        error: LiveKitRoomError;
        localMediaChanged: LiveKitLocalMediaState;
        noiseFilterChanged: { Enabled: boolean };
        participantJoined: LiveKitParticipantJoinedEvent;
        participantLeft: LiveKitParticipantLeftEvent;
        reconnected: { State: LiveKitRoomState };
        reconnecting: Record<string, never>;
        stateChanged: LiveKitRoomState;
    }
    Index

    Properties

    activeSpeakersChanged audioPlaybackChanged backgroundEffectChanged beforeConnect beforeDeviceSwitch beforeDisconnect beforeMediaToggle beforeSendData connected dataReceived disconnected error localMediaChanged noiseFilterChanged participantJoined participantLeft reconnected reconnecting stateChanged

    Properties

    activeSpeakersChanged: LiveKitActiveSpeakersEvent
    audioPlaybackChanged: { CanPlayback: boolean }

    Browser autoplay policy changed whether remote audio can play (prompt the user to enable sound).

    backgroundEffectChanged: { Effect: LiveKitBackgroundEffect }

    The camera background effect changed.

    beforeConnect: LiveKitBeforeConnectEvent
    beforeDeviceSwitch: LiveKitBeforeDeviceSwitchEvent
    beforeDisconnect: LiveKitBeforeDisconnectEvent
    beforeMediaToggle: LiveKitBeforeMediaToggleEvent
    beforeSendData: LiveKitBeforeSendDataEvent
    connected: { State: LiveKitRoomState }
    dataReceived: LiveKitDataMessage
    disconnected: LiveKitDisconnectedEvent
    error: LiveKitRoomError
    localMediaChanged: LiveKitLocalMediaState
    noiseFilterChanged: { Enabled: boolean }

    The Krisp noise filter was toggled on the local microphone.

    participantJoined: LiveKitParticipantJoinedEvent
    participantLeft: LiveKitParticipantLeftEvent
    reconnected: { State: LiveKitRoomState }
    reconnecting: Record<string, never>
    stateChanged: LiveKitRoomState

    Settings

    Member Visibility

    On This Page

    Properties