AvatarConfiguration Class

Definition

Namespace:

Azure.AI.VoiceLive

Assembly:

Azure.AI.VoiceLive.dll

Package:

Azure.AI.VoiceLive v1.1.0

Source:

AvatarConfiguration.cs

Configuration for avatar streaming and behavior during the session.

public class AvatarConfiguration : System.ClientModel.Primitives.IJsonModel<Azure.AI.VoiceLive.AvatarConfiguration>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.VoiceLive.AvatarConfiguration>

type AvatarConfiguration = class
    interface IJsonModel<AvatarConfiguration>
    interface IPersistableModel<AvatarConfiguration>

Public Class AvatarConfiguration
Implements IJsonModel(Of AvatarConfiguration), IPersistableModel(Of AvatarConfiguration)

Inheritance

Object

AvatarConfiguration

Implements

IJsonModel<AvatarConfiguration> IPersistableModel<AvatarConfiguration> IPersistableModel<T>

Constructors

Name	Description
AvatarConfiguration(String, Boolean)	Initializes a new instance of AvatarConfiguration.

Properties

Name	Description
AuditOutputAudio	When enabled, forwards audit audio via WebSocket for review/debugging purposes, even when avatar output is delivered via WebRTC.
AvatarKind	Type of avatar to use.
BaseMode	Base model to use for the avatar. Required for photo avatar.
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.
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.
Video	Optional video configuration including resolution, bitrate, and codec.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<AvatarConfiguration>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AvatarConfiguration>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AvatarConfiguration>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AvatarConfiguration>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AvatarConfiguration>.Write(ModelReaderWriterOptions)