Rate this page:

TTSOptions

Options for Text-to-speech usage. 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 on top of each other in the order they are given.

Available for providers: Google.

emotion

Copy URL
emotion: 

undefined

|

string

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

Available for providers: Yandex.

pitch

Copy URL
pitch: 

string

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

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

Available for providers: Google, Yandex.

volume

Copy URL
volume: 

string

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

Available for providers: Google.

yandexCustomModelName

Copy URL
yandexCustomModelName: 

undefined

|

string

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.