AvatarConfig interface

Package:

@azure/ai-voicelive

Configuration for avatar streaming and behavior during the session.

Properties

character	The character name or ID used for the avatar.
customized	Indicates whether the avatar is customized or not.
iceServers	Optional list of ICE servers to use for WebRTC connection establishment.
model	Base model to use for the avatar. Required for photo avatar.
outputAuditAudio	When enabled, forwards audit audio via WebSocket for review/debugging purposes, even when avatar output is delivered via WebRTC.
outputProtocol	Output protocol for avatar streaming. Default is 'webrtc'.
scene	Configuration for the avatar's zoom level, position, rotation and movement amplitude in the video frame.
style	Optional avatar style, such as emotional tone or speaking style.
type	Type of avatar to use.
video	Optional video configuration including resolution, bitrate, and codec.

Property Details

character

The character name or ID used for the avatar.

character: string

Property Value

string

customized

Indicates whether the avatar is customized or not.

customized: boolean

Property Value

boolean

iceServers

Optional list of ICE servers to use for WebRTC connection establishment.

iceServers?: IceServer[]

Property Value

IceServer[]

model

Base model to use for the avatar. Required for photo avatar.

model?: string

Property Value

string

outputAuditAudio

When enabled, forwards audit audio via WebSocket for review/debugging purposes, even when avatar output is delivered via WebRTC.

outputAuditAudio?: boolean

Property Value

boolean

outputProtocol

Output protocol for avatar streaming. Default is 'webrtc'.

outputProtocol?: string

Property Value

string

scene

Configuration for the avatar's zoom level, position, rotation and movement amplitude in the video frame.

scene?: Scene

Property Value

Scene

style

Optional avatar style, such as emotional tone or speaking style.

style?: string

Property Value

string

type

Type of avatar to use.

type?: string

Property Value

string

video

Optional video configuration including resolution, bitrate, and codec.

video?: VideoParams

Property Value

VideoParams