Rate this page:

TTSOptions

Text-to-speech options. Can be passed via the CallSayParameters.ttsOptions and TTSPlayerParameters.ttsOptions parameter. See the details in the official specs.

Props

effectsProfileId

Copy URL
effectsProfileId: 

TTSEffectsProfile[]

An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied additionally to each other in the order they are provided.

Available for providers: Google.

emotion

Copy URL
emotion: 

string

|

undefined

Voice sentiment. For Yandex voices, works only for ru_RU voices.

Available for providers: Yandex.

pitch

Copy URL
pitch: 

string

|

undefined

Voice pitch. Acceptable ranges: 1) the numbers followed by "Hz" from 0.5Hz to 2Hz 2) x-low, low, medium, high, x-high, default

Available for providers: Google.

rate

Copy URL
rate: 

string

|

undefined

Speech speed. Possible values are x-slow, slow, medium, fast, x-fast, default.

Available for providers: Google, Yandex.

volume

Copy URL
volume: 

string

|

undefined

Speech volume. Possible values are silent, x-soft, soft, medium, loud, x-loud, default.

Available for providers: Google.

yandexCustomModelName

Copy URL
yandexCustomModelName: 

string

|

undefined

If you have a custom Yandex engine voice, specify it in this field. Please contact support to activate this feature for your account.

Available for providers: Yandex.