Member Junction
    Preparing search index...

    Interface RealtimeSessionStartOptions

    Per-start options of RealtimeSessionRuntime.StartRealtimeSession that are not part of the mint contract. Every field is optional; omit the whole object for the behavior hosts always had.

    interface RealtimeSessionStartOptions {
        CameraCheck?: boolean;
        ConversationBranchID?: string | null;
        HostChannels?: RealtimeHostChannelDeclaration[];
    }
    Index

    Properties

    CameraCheck? ConversationBranchID? HostChannels?

    Properties

    CameraCheck?: boolean

    Have the user check the camera before the agent sees it. The call's first camera start opens the camera for the user only: the camera's state is starting with Checking set and the stream to preview, and nothing reaches the agent until the host calls ConfirmCamera. Later starts in the same call skip the check. Set it only when the host shows the check; otherwise the camera waits for a confirmation that never comes.

    ConversationBranchID?: string | null

    The fork (MJ: Conversation Branches.ID) the session starts on; omitted or null is Main.

    HostChannels?: RealtimeHostChannelDeclaration[]

    Channels the host brings to this session (see RealtimeHostChannelDeclaration).

    Settings

    Member Visibility

    On This Page

    Properties