D-ID Client SDK - v3.0.0-0
    Preparing search index...

    Interface AgentAvatar

    The avatar an agent speaks through: its rendering tier and the language of its voice.

    The value of Agent.avatar. Its type is the single most important field on an agent: it decides which transport the session uses and therefore which SDK features work.

    interface AgentAvatar {
        type: "clip" | "talk" | "expressive";
        voice?: { language?: string };
    }
    Index
    type: "clip" | "talk" | "expressive"

    The kind of avatar: talk for Talks (V2), clip for Clips (V3), expressive for Expressive (V4).

    Talks (V2) and Clips (V3) agents stream over WebRTC and receive their events on the notifications web socket; Expressive (V4) agents connect to a real-time session instead, which is what makes the microphone, camera, client tool and data-channel methods of AgentManager available.

    Either an AvatarType member or its string value — AvatarType.Talk and 'talk' are both accepted, so an Agent restored from your own storage does not have to import the enum.

    voice?: { language?: string }

    The voice the agent speaks with.

    Type Declaration

    • Optionallanguage?: string

      Language of the configured voice. The SDK reports it in analytics; it does not change how the session behaves.