LiveKit JS Server SDK - v2.14.0
    Preparing search index...

    Interface CreateOptions

    Options for when creating a room

    interface CreateOptions {
        agents?: RoomAgentDispatch[];
        departureTimeout?: number;
        egress?: RoomEgress;
        emptyTimeout?: number;
        maxParticipants?: number;
        maxPlayoutDelay?: number;
        metadata?: string;
        minPlayoutDelay?: number;
        name: string;
        nodeId?: string;
        syncStreams?: boolean;
    }
    Index

    Properties

    agents? departureTimeout? egress? emptyTimeout? maxParticipants? maxPlayoutDelay? metadata? minPlayoutDelay? name nodeId? syncStreams?

    Properties

    agents?: RoomAgentDispatch[]

    agents that should be dispatched to this room

    departureTimeout?: number

    number of seconds to keep the room open after the last participant leaves this option is helpful to give a grace period for participants to re-join

    egress?: RoomEgress

    add egress options

    emptyTimeout?: number

    number of seconds to keep the room open before any participant joins

    maxParticipants?: number

    limit to the number of participants in a room at a time

    maxPlayoutDelay?: number

    maximum playout delay in milliseconds

    metadata?: string

    initial room metadata

    minPlayoutDelay?: number

    minimum playout delay in milliseconds

    name: string

    name of the room. required

    nodeId?: string

    override the node room is allocated to, for debugging does not work with Cloud

    syncStreams?: boolean

    improves A/V sync when min_playout_delay set to a value larger than 200ms. It will disables transceiver re-use -- this option is not recommended for rooms with frequent subscription changes

    Settings

    Member Visibility

    On This Page

    Properties