VoiceAgentSessionAvatarConfig interface

Package:

@azure/ai-projects

Avatar settings accepted by the stable voice-agent WebSocket contract.

Extends

VoiceAgentAvatarConfig

Properties

ice_servers

The ICE servers used to negotiate the avatar's WebRTC connection.

Inherited Properties

character	The avatar character identifier, e.g. 'lisa'.
customized	Whether the avatar is a customer-customized avatar. Defaults to false.
model	The avatar model identifier.
output_audit_audio	Whether audit audio is emitted with avatar output. Defaults to false.
output_protocol	The transport used to deliver the avatar video stream.
scene	Avatar placement and motion settings.
style	The avatar style, e.g. 'casual-sitting'.
type	The avatar type.
video	Avatar video encoder and presentation settings.

Property Details

ice_servers

The ICE servers used to negotiate the avatar's WebRTC connection.

ice_servers?: VoiceAgentAvatarIceServer[]

Property Value

VoiceAgentAvatarIceServer[]

Inherited Property Details

character

The avatar character identifier, e.g. 'lisa'.

character: string

Property Value

string

Inherited From VoiceAgentAvatarConfig.character

customized

Whether the avatar is a customer-customized avatar. Defaults to false.

customized?: boolean

Property Value

boolean

Inherited From VoiceAgentAvatarConfig.customized

model

The avatar model identifier.

model?: string

Property Value

string

Inherited From VoiceAgentAvatarConfig.model

output_audit_audio

Whether audit audio is emitted with avatar output. Defaults to false.

output_audit_audio?: boolean

Property Value

boolean

Inherited From VoiceAgentAvatarConfig.output_audit_audio

output_protocol

The transport used to deliver the avatar video stream.

output_protocol?: VoiceAgentAvatarOutputProtocol

Property Value

VoiceAgentAvatarOutputProtocol

Inherited From VoiceAgentAvatarConfig.output_protocol

scene

Avatar placement and motion settings.

scene?: VoiceAgentAvatarScene

Property Value

VoiceAgentAvatarScene

Inherited From VoiceAgentAvatarConfig.scene

style

The avatar style, e.g. 'casual-sitting'.

style?: string

Property Value

string

Inherited From VoiceAgentAvatarConfig.style

type

The avatar type.

type: VoiceAgentAvatarType

Property Value

VoiceAgentAvatarType

Inherited From VoiceAgentAvatarConfig.type

video

Avatar video encoder and presentation settings.

video?: VoiceAgentAvatarVideoParams

Property Value

VoiceAgentAvatarVideoParams

Inherited From VoiceAgentAvatarConfig.video