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

    Interface GeneralDispatchAgentOptions

    Options for a managed/low-code dispatch. versionId is required. Unlike dispatch/connect, this variant ignores versionTag and wait, so they are omitted here.

    interface GeneralDispatchAgentOptions {
        agentId: string;
        meetingId?: string;
        metadata?: Record<string, unknown>;
        roomId?: string;
        roomOptions?: AgentRoomOptions;
        sipOptions?: AgentSipOptions;
        versionId: string;
    }

    Hierarchy

    Index
    agentId meetingId? metadata? roomId? roomOptions? sipOptions? versionId
    agentId: string

    The deployed agent to dispatch. Required.

    meetingId?: string

    The room/meeting to join. Provide meetingId or roomId (at least one).

    metadata?: Record<string, unknown>
    roomId?: string
    roomOptions?: AgentRoomOptions
    sipOptions?: AgentSipOptions
    versionId: string

    Pin a specific deployment version (cloud / no-code).

    Settings
    Member Visibility

    On This Page
    Properties