Rate this page:

VoiceAvatarConfig

VoiceAvatar configuration.

Props

asrEndOfPhraseDetectorTimeout

Copy URL
asrEndOfPhraseDetectorTimeout: 

number

|

undefined

Time in milliseconds. If the ASR is running in the interim mode, we may not wait for the final response from the ASR, but instead, take the last interim, after which there are no new ones during this timeout. It allows us to reduce the time of voice recognition. This parameter should be set individually for each ASR vendor. 1000ms is a good default value not to interrupt the user too aggressively

asrNoInputTimeout

Copy URL
asrNoInputTimeout: 

number

|

undefined

Time in milliseconds. If no user input came from ASR during this period of time - then avatar is notified, that timeout occurred. Default value is 10 seconds

asrParameters

Copy URL
asrParameters: 

ASRParameters

ASR parameters

avatarConfig

Copy URL
avatarConfig: 

AvatarConfig

Avatar configuration

call

Copy URL
call: 

Call

Current call object

onErrorCallback

Copy URL
onErrorCallback: 

(avatarErrorEvent: Events.Error) => void,Promise<void>

|

undefined

Event handler that defines what happens to the call in case of internal errors of the avatar (for example, playing an error phrase or transferring the call to an operator)

onFinishCallback

Copy URL
onFinishCallback: 

(avatarFinishEvent: Events.Finish) => void,Promise<void>

|

undefined

Triggers when an avatar finishes talking. Returns a dictionary with the data collected during the avatar working process

ttsPlayerOptions

Copy URL
ttsPlayerOptions: 

TTSPlayerOptions

TTS options