Member Junction
    Preparing search index...

    Interface RealtimeAvatarSettings

    A live avatar a session asks for. The tuning members carry the same names as a persona's avatar settings (IAIPersonaVendorSettings.Avatar), which is where a request usually comes from.

    interface RealtimeAvatarSettings {
        AvatarID: string;
        Background?: "default" | { ImageFileID: string } | "transparent" | "blur";
        Delivery?: "client" | "room";
        Kind?: "preset" | "custom";
        PersonaName?: string;
        ReferenceImageFileID?: string;
        Resolution?: "standard" | "low" | "high";
        Source?: "persona" | "override";
    }
    Index

    Properties

    AvatarID Background? Delivery? Kind? PersonaName? ReferenceImageFileID? Resolution? Source?

    Properties

    AvatarID: string

    The vendor's avatar id: a preset name (for example Gemini's "Ben"), or a custom avatar's id.

    Background?: "default" | { ImageFileID: string } | "transparent" | "blur"

    What shows behind the avatar, when the vendor can change it: a named treatment, or an image from MJ Storage.

    Delivery?: "client" | "room"

    Who shows the avatar's video. 'room': a server-side session whose host publishes it into a meeting room (the meeting bot decodes it and publishes a camera track), so the driver may render it there. 'client' or absent: the browser that opened the session shows it; a server-side session without 'room' stays audio only (reason 'bridged'). A phone call never carries a request (reason 'phone').

    Kind?: "preset" | "custom"

    'preset' (default): an avatar from the vendor's catalog. 'custom': one made from a reference image.

    PersonaName?: string

    The persona the avatar belongs to, for logs.

    ReferenceImageFileID?: string

    The MJ Storage file id of the reference image, when Kind is 'custom'.

    Resolution?: "standard" | "low" | "high"

    The preferred video resolution; a driver uses the nearest its vendor offers.

    Source?: "persona" | "override"

    Where the request came from: the voiced agent's persona, or an explicit override.

    Settings

    Member Visibility

    On This Page

    Properties