Member Junction
    Preparing search index...

    Interface LiveKitPreviewRoomOptions

    How a preview room runs. All optional.

    interface LiveKitPreviewRoomOptions {
        AgentWatches?: boolean;
        EventBus?: LiveKitRoomEventBus;
        LocalMedia?: () => ILocalMediaController;
        MeterFor?: (stream: MediaStream) => IRealtimeAudioMeter | null;
        People?: readonly LiveKitPreviewPerson[];
        RequestScreenShare?: (
            options: DisplayCaptureOptions,
        ) => Promise<DisplayCaptureResult>;
        TurnMs?: number;
    }
    Index

    Properties

    AgentWatches? EventBus? LocalMedia? MeterFor? People? RequestScreenShare? TurnMs?

    Properties

    AgentWatches?: boolean

    Whether the simulated agent watches the cameras and screens people let it see. Defaults to true.

    EventBus?: LiveKitRoomEventBus

    A shared event bus (e.g. so a host can subscribe before connecting).

    LocalMedia?: () => ILocalMediaController

    Makes the camera-and-microphone controller each join runs on. Defaults to the browser's LocalMediaController.

    MeterFor?: (stream: MediaStream) => IRealtimeAudioMeter | null

    Meters your microphone. Defaults to MediaPreview's meter; a test passes its own.

    People?: readonly LiveKitPreviewPerson[]

    The simulated people. Defaults to LIVEKIT_PREVIEW_PEOPLE.

    RequestScreenShare?: (
        options: DisplayCaptureOptions,
    ) => Promise<DisplayCaptureResult>

    Opens the browser's share picker. Defaults to RequestDisplayCapture; a test passes its own.

    TurnMs?: number

    How long each person speaks before the next one starts, in milliseconds. Defaults to 4000.

    Settings

    Member Visibility

    On This Page

    Properties