Share via

AvatarConfig class

  • Reference
Package:
microsoft-cognitiveservices-speech-sdk

Defines the talking avatar configuration.

Constructors

AvatarConfig(string, string, AvatarVideoFormat)

Creates and initializes an instance of this class.

Properties

backgroundColor

Gets the background color.
backgroundImage

Gets the background image.
character

Defines the avatar character.
customized

Indicates if the talking avatar is customized.
remoteIceServers

Gets the remote ICE servers.
style

Defines the avatar style.
videoFormat

Defines the talking avatar output video format.

Constructor Details

AvatarConfig(string, string, AvatarVideoFormat)

Creates and initializes an instance of this class.

new AvatarConfig(character: string, style: string, videoFormat: AvatarVideoFormat)

Parameters

character

string

The avatar character.

style

string

The avatar style.

videoFormat
AvatarVideoFormat

The talking avatar output video format.

Property Details

backgroundColor

Gets the background color.

string backgroundColor

Property Value

string

backgroundImage

Gets the background image.

URL backgroundImage

Property Value

URL

character

Defines the avatar character.

character: string

Property Value

string

customized

Indicates if the talking avatar is customized.

boolean customized

Property Value

boolean

remoteIceServers

Gets the remote ICE servers.

RTCIceServer[] remoteIceServers

Property Value

RTCIceServer[]

The remote ICE servers.

style

Defines the avatar style.

style: string

Property Value

string

videoFormat

Defines the talking avatar output video format.

videoFormat: AvatarVideoFormat

Property Value

AvatarVideoFormat