Language

VoiceAgentAvatarConfig Class

Definition

Avatar configuration for a voice agent. These values are session defaults and may be overridden when connecting.

public class VoiceAgentAvatarConfig : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.VoiceAgentAvatarConfig>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.VoiceAgentAvatarConfig>
type VoiceAgentAvatarConfig = class
    interface IJsonModel<VoiceAgentAvatarConfig>
    interface IPersistableModel<VoiceAgentAvatarConfig>
Public Class VoiceAgentAvatarConfig
Implements IJsonModel(Of VoiceAgentAvatarConfig), IPersistableModel(Of VoiceAgentAvatarConfig)
Inheritance
VoiceAgentAvatarConfig
Implements

Constructors

Name Description
VoiceAgentAvatarConfig(VoiceAgentAvatarType, String)

Initializes a new instance of VoiceAgentAvatarConfig.

Properties

Name Description
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.

OutputAuditAudio

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

OutputProtocol

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.

Methods

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

Explicit Interface Implementations

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

Applies to