Skip to main content

customVoice

The parameter customVoice allows you to specify a voice for speech synthesis, or the gender of the voice used in speech synthesis. A voice chosen with the voice field will be used in each speech synthesis, even when switching languages, so be wary when using multiple languages. ATM there two multilingual voices by Microsoft :

  • JennyMultilingualNeural : female voice, available for any subscription
  • RyanMultilingualNeural : male voice, limitations exist depending on the region of your subscription, see here
NameRequiredTypeDefault valueDescription
voiceNostringName of the voice (ex: DeniseNeural)
genderNo'male' | 'female'-Gender of the voice

If the field voice is filled, the corresponding voice will be used. If the field voice is not filled, but the field gender is, the selected voice will be the first one with corresponding language and gender.