Rate this page:

SayOptions

Options of the Call.say method.

Props

language

Copy URL
language: 

Voice

Language and voice to be used. Lists of all supported languages: VoiceList.Amazon, VoiceList.Google, VoiceList.IBM, VoiceList.Microsoft, VoiceList.SmartSpeech, VoiceList.Tinkoff, VoiceList.Yandex and VoiceList.Default. The default value is VoiceList.Amazon.en_US_Joanna.

Available for providers: Amazon, Google, IBM, Microsoft, SmartSpeech, Tinkoff, Yandex.

onPause

Copy URL
onPause: 

undefined

|

false

|

true

Specifies whether the player is on pause after creation. To continue the playback, use the Player.resume method. False by default.

progressivePlayback

Copy URL
progressivePlayback: 

undefined

|

false

|

true

Use progressive playback or not. If true, the generated speech is delivered in chunks which reduces delay before a method call and playback. False by default.

Available for providers: Amazon, Google, IBM, Microsoft, SmartSpeech, Tinkoff, Yandex.

request

Copy URL
request: 

Object

Provide the TTS parameters directly to the provider in this parameter. Find more information in the documentation.

Available for providers: Google, SmartSpeech, Tinkoff, YandexV3.

ttsOptions

Copy URL
ttsOptions: 

VoxEngine.TTSOptions

Optional parameters for TTS. Note that support of the VoxEngine.TTSOptions.pitch parameter depends on the language and dictionary used. For unsupported combinations the CallEvents.PlaybackFinished event is triggered with error 400.

Available for providers: Amazon, Google, IBM, Microsoft, SmartSpeech, Tinkoff, Yandex.