Interface AvatarSessionOptions

Options for configuring an AvatarSession.

interface AvatarSessionOptions {
    agentId: string;
    apiKey?: string;
    apiUrl?: string;
    audioConfig?: AudioConfig;
    avatarParticipantIdentity?: string;
    avatarParticipantName?: string;
    connOptions?: APIConnectOptions;
}

Properties

agentId apiKey? apiUrl? audioConfig? avatarParticipantIdentity? avatarParticipantName? connOptions?

Properties

agentId

agentId: string

D-ID agent id. Required. See the plugin README for how to create one.

Optional apiKey

apiKey?: string

D-ID API key. Falls back to DID_API_KEY.

Optional apiUrl

apiUrl?: string

Override the D-ID API base URL.

Optional audioConfig

audioConfig?: AudioConfig

Audio configuration for the stream sent to the D-ID avatar.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: string

Identity for the avatar participant. Defaults to d-id-avatar-agent.

Optional avatarParticipantName

avatarParticipantName?: string

Display name for the avatar participant. Defaults to d-id-avatar-agent.

Optional connOptions

connOptions?: APIConnectOptions

API retry/timeout options.

Settings

Member Visibility

Theme

On This Page

agentIdapiKeyapiUrlaudioConfigavatarParticipantIdentityavatarParticipantNameconnOptions