Rate this page:

TTSPlayerOptions

Options for the createTTSPlayer 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.Tinkoff, VoiceList.Yandex, and VoiceList.Default. The default value is VoiceList.Amazon.en_US_Joanna.

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 will be delivered in chunks which reduces delay before a method call and playback. It's false by default.

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 will be triggered with error 400.