Member Junction
    Preparing search index...

    Interface LiveKitRoomControllerOptions

    Construction options for the controller (all optional — sensible defaults applied).

    interface LiveKitRoomControllerOptions {
        EventBus?: LiveKitRoomEventBus;
        RequestScreenShare?: (
            options: DisplayCaptureOptions,
        ) => Promise<DisplayCaptureResult>;
        RoleResolver?: LiveKitRoleResolver;
        RoomFactory?: LiveKitRoomFactory;
    }
    Index

    Properties

    EventBus? RequestScreenShare? RoleResolver? RoomFactory?

    Properties

    EventBus?: LiveKitRoomEventBus

    Supply a shared event bus (e.g. so a host can subscribe before the controller connects).

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

    Opens the browser's share picker for a screen share. Defaults to /media's RequestDisplayCapture, as in the preview room; a test passes its own.

    RoleResolver?: LiveKitRoleResolver

    Override how a participant's role is derived.

    RoomFactory?: LiveKitRoomFactory

    Override the Room factory (tests inject a fake).

    Settings

    Member Visibility

    On This Page

    Properties