@jambonz/sdk
    Preparing search index...

    Interface ConferenceVerb

    interface ConferenceVerb {
        verb: "conference";
        id?: string;
        name: string;
        beep?: boolean;
        memberTag?: string;
        speakOnlyTo?: string;
        startConferenceOnEnter?: boolean;
        endConferenceOnExit?: boolean;
        endConferenceDuration?: number;
        maxParticipants?: number;
        joinMuted?: boolean;
        actionHook?: ActionHook;
        waitHook?: ActionHook;
        statusEvents?: string[];
        statusHook?: ActionHook;
        enterHook?: ActionHook;
        record?: Record<string, unknown>;
        stream?: Omit<StreamVerb, "verb">;
        listen?: Omit<ListenVerb, "verb">;
        distributeDtmf?: boolean;
    }
    Index

    Properties

    verb id? name beep? memberTag? speakOnlyTo? startConferenceOnEnter? endConferenceOnExit? endConferenceDuration? maxParticipants? joinMuted? actionHook? waitHook? statusEvents? statusHook? enterHook? record? stream? listen? distributeDtmf?

    Properties

    verb: "conference"
    id?: string
    name: string

    Conference room name.

    beep?: boolean

    Beep on join/leave.

    memberTag?: string

    Tag to identify this participant.

    speakOnlyTo?: string

    Whisper to specific participant by tag.

    startConferenceOnEnter?: boolean

    Start conference when this participant joins.

    endConferenceOnExit?: boolean

    End conference when this participant leaves.

    endConferenceDuration?: number

    Max conference duration in seconds.

    maxParticipants?: number

    Max participants allowed.

    joinMuted?: boolean

    Join muted.

    actionHook?: ActionHook

    Webhook when participant leaves.

    waitHook?: ActionHook

    Webhook while waiting for conference to start.

    statusEvents?: string[]

    Conference event types to receive on statusHook: 'start', 'end', 'join', 'leave', 'start-talking', 'stop-talking', and the room media lifecycle 'say-start', 'say-done', 'play-start', 'play-done' (see WebsocketSession.injectSay/injectPlay).

    statusHook?: ActionHook

    Webhook for conference status events.

    enterHook?: ActionHook

    Webhook when participant enters.

    record?: Record<string, unknown>

    Conference recording config.

    stream?: Omit<StreamVerb, "verb">

    Fork the room's mixed audio to a WebSocket. Prefer stream; listen is a synonym.

    listen?: Omit<ListenVerb, "verb">

    Audio streaming config (synonym for stream).

    distributeDtmf?: boolean

    Distribute DTMF to all participants.

    Settings

    Member Visibility

    On This Page

    Properties