Rate this page:

TTSPlayerParameters

TTS Player parameters. Can be passed as arguments to the VoxEngine.createTTSPlayer method.

Props

language

Copy URL
language: 

Voice

Optional. Language and voice for TTS. List of all supported voices: VoiceList. The default value is VoiceList.Amazon.en_US_Joanna.

Available for providers: Amazon, Google, IBM, Microsoft, SaluteSpeech, T-Bank,Yandex.

onPause

Copy URL
onPause: 

false

|

undefined

|

true

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

Available for providers: Amazon, Google, IBM, Microsoft, SaluteSpeech, T-Bank,Yandex, YandexV3.

progressivePlayback

Copy URL
progressivePlayback: 

false

|

undefined

|

true

Optional. 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, T-Bank,Yandex.

request

Copy URL
request: 

Object

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

Available for providers: Google, SaluteSpeech, T-Bank,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, T-Bank,Yandex.