Rate this page:

TTSPlayerParameters

Optional. parameters. Can be passed as arguments to the [VoxEngine.createTTSPlayer] method.

Props

language

Copy URL
language: 

Voice

Language and voice. Lists of all supported languages: [VoiceList.Amazon], [VoiceList.Google], [VoiceList.IBM], [VoiceList.Microsoft], [VoiceList.SaluteSpeech], [VoiceList.Tinkoff], [VoiceList.Yandex] and [VoiceList.Default]. The default value is VoiceList.Amazon.en_US_Joanna.

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

onPause

Copy URL
onPause: 

false

|

undefined

|

true

Whether the player is on pause after creation. To continue the playback, use the [Player.resume] method. The default value is false.

progressivePlayback

Copy URL
progressivePlayback: 

false

|

undefined

|

true

Whether to use progressive playback. If true, the generated speech is delivered in chunks which reduces delay before a method call and playback. The default value is false.

Available for providers: Amazon, Google, IBM, Microsoft, SaluteSpeech, 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, SaluteSpeech, Tinkoff, YandexV3.

ttsOptions

Copy URL
ttsOptions: 

TTSOptions

Optional. Parameters for TTS. Note that support of the 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, SaluteSpeech, Tinkoff, Yandex.