@videosdk.live/server-sdk
    Preparing search index...

    Interface CreateRoomOptions

    Options for RoomsResource.create.

    interface CreateRoomOptions {
        allowedParticipantIds?: string[];
        autoCloseConfig?: AutoCloseConfigInput;
        autoStartConfig?: AutoStartConfig;
        customRoomId?: string;
        geoFence?: GeoFence;
        multiComposition?: { hls?: boolean; recording?: boolean; rtmp?: boolean };
        webhook?: RoomWebhookInput;
    }
    Index
    allowedParticipantIds? autoCloseConfig? autoStartConfig? customRoomId? geoFence? multiComposition? webhook?
    allowedParticipantIds?: string[]

    Restrict which participant ids may join.

    autoCloseConfig?: AutoCloseConfigInput

    Auto-close behavior when the session ends.

    autoStartConfig?: AutoStartConfig

    Compositions to start automatically when a session begins.

    customRoomId?: string

    Caller-supplied stable id. Creation is idempotent on this value.

    geoFence?: GeoFence

    Region to pin the room to. Falls back to the API key's region.

    multiComposition?: { hls?: boolean; recording?: boolean; rtmp?: boolean }

    Independently start multiple compositions of the same type.

    webhook?: RoomWebhookInput

    Webhook subscription for room/session events.

    Settings
    Member Visibility

    On This Page
    Properties