Member Junction
    Preparing search index...

    Interface RealtimeVideoConfig

    Video configuration: whether the agent asks for a live avatar, which one, and whether it watches LiveKit meetings. Absent / enabled !== true ⇒ the agent asks for no avatar. The user's camera and screen share do not depend on it; they start only when the user turns them on.

    interface RealtimeVideoConfig {
        avatarId?: string;
        enabled?: boolean;
        provider?: string;
        providers?: Record<string, JSONObjectLike>;
        watchMeetings?: boolean;
    }
    Index

    Properties

    avatarId? enabled? provider? providers? watchMeetings?

    Properties

    avatarId?: string

    The avatar to show instead of the one the agents' personas give: the APIName of one of the model's Active Video persona bindings (MJ: AI Persona Vendors) on the session's vendor, matched without regard to case, such as Google's preset Ben. Read only when enabled is true, which the call's avatar picker (a runtime override) sets this key without and can't turn on: a picked avatar with the agent's setting off gives the call no avatar (reason video-off). A name with no such binding gives the call no avatar (reason unknown-avatar). The avatar's settings (Kind, Resolution, Background) are that binding's VendorSettings.Avatar.

    enabled?: boolean

    Whether the agent asks for a live avatar. Default (absent / non-boolean): false. When true, and the call can show an avatar (a browser call, or a meeting whose host publishes it into the room), a session with no explicit model (no preferredModelId and no RealtimeConfigSection.modelPreference) takes the first realtime model that shows one; when none does, it keeps its default model, audio only. The avatar is the one avatarId names when it is set; otherwise the voiced agent's persona's, else the co-agent's.

    It does not turn on the camera: capture starts only when the user turns the camera or a screen share on.

    provider?: string

    Nothing reads it. Choose the model with RealtimeConfigSection.modelPreference; with enabled on and no model chosen, the session takes the first model that shows an avatar. A session whose configuration sets it logs one line naming the agent.

    providers?: Record<string, JSONObjectLike>

    Nothing reads it. An avatar's settings (Kind, Resolution, Background) are its persona binding's VendorSettings.Avatar (MJ: AI Persona Vendors, Video modality), which each driver maps onto its vendor. A session whose configuration sets it logs one line naming the agent.

    watchMeetings?: boolean

    Whether this agent watches LiveKit meetings: its bot reads the cameras and shared screens of the people who let agents see them, and the room offers everyone that choice. Default (absent / non-boolean): false. Set it on the VOICED agent (the Realtime type's schema does not allow video on the co-agent). Needs a model that takes video (Gemini 3.8 Live); on an audio-only model it does nothing.

    Settings

    Member Visibility

    On This Page

    Properties