Member Junction
    Preparing search index...

    Interface LiveKitRoomConnectOptions

    Options for opening a room connection.

    interface LiveKitRoomConnectOptions {
        BackgroundEffect?: LiveKitBackgroundEffect;
        CameraDeviceId?: string;
        DisplayName?: string;
        E2EE?: LiveKitE2EEOptions;
        EnableCamera?: boolean;
        EnableMicrophone?: boolean;
        MicrophoneDeviceId?: string;
        NoiseFilterEnabled?: boolean;
        RoomOptions?: RoomOptions;
    }
    Index

    Properties

    BackgroundEffect? CameraDeviceId? DisplayName? E2EE? EnableCamera? EnableMicrophone? MicrophoneDeviceId? NoiseFilterEnabled? RoomOptions?

    Properties

    BackgroundEffect?: LiveKitBackgroundEffect

    Start with a camera background effect (requires @livekit/track-processors).

    CameraDeviceId?: string

    Preferred camera device id.

    DisplayName?: string

    The display name to publish as the local participant's name.

    E2EE?: LiveKitE2EEOptions

    Enable end-to-end encryption for this connection.

    EnableCamera?: boolean

    Start with the camera enabled (default: false — voice-first).

    EnableMicrophone?: boolean

    Start with the microphone enabled (default: true).

    MicrophoneDeviceId?: string

    Preferred microphone device id.

    NoiseFilterEnabled?: boolean

    Start with the Krisp noise filter enabled (LiveKit Cloud; requires @livekit/krisp-noise-filter).

    RoomOptions?: RoomOptions

    Advanced livekit-client room options merged into the constructed Room.

    Settings

    Member Visibility

    On This Page

    Properties