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.
outputProtocol	Output protocol for avatar streaming. Default is 'webrtc'.
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

outputProtocol

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

outputProtocol?: string

Property Value

string

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