Interface CreateOptions

Options for when creating a room

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

Properties

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

Properties

Optional departureTimeout

departureTimeout?: number

number of seconds to keep the room open after the last participant leaves

Optional egress

egress?: RoomEgress

add egress options

Optional emptyTimeout

emptyTimeout?: number

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

Optional maxParticipants

maxParticipants?: number

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

Optional maxPlayoutDelay

maxPlayoutDelay?: number

maximum playout delay in milliseconds

Optional metadata

metadata?: string

initial room metadata

Optional minPlayoutDelay

minPlayoutDelay?: number

minimum playout delay in milliseconds

name

name: string

name of the room. required

Optional nodeId

nodeId?: string

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

Optional syncStreams

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

Theme

On This Page

Generated using TypeDoc