Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window. Try Gemini 1.5 Pro, our most advanced multimodal model in Vertex AI, and see what you can build with a 1M token context window.

SynthesizeSpeechConfig

JSON representation
VoiceSelectionParams
- JSON representation
SsmlVoiceGender

Configuration of how speech should be synthesized.

JSON representation
{ "speakingRate": number, "pitch": number, "volumeGainDb": number, "effectsProfileId": [ string ], "voice": { object (`VoiceSelectionParams`) } }

Fields
`speakingRate`	`number` Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error.
`pitch`	`number` Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.
`volumeGainDb`	`number` Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that.
`effectsProfileId[]`	`string` Optional. 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.
`voice`	`object (VoiceSelectionParams)` Optional. The desired voice of the synthesized audio.

VoiceSelectionParams

Description of which voice to use for speech synthesis.

JSON representation
{ "name": string, "ssmlGender": enum (`SsmlVoiceGender`) }

Fields

Fields
`name`	`string` Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and `ssmlGender`.
`ssmlGender`	`enum (SsmlVoiceGender)` Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and `name`. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.

name

string

Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and ssmlGender.

ssmlGender

enum (SsmlVoiceGender)

Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as languageCode and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.

SsmlVoiceGender

Gender of the voice as described in SSML voice element.

Enums
`SSML_VOICE_GENDER_UNSPECIFIED`	An unspecified gender, which means that the client doesn't care which gender the selected voice will have.
`SSML_VOICE_GENDER_MALE`	A male voice.
`SSML_VOICE_GENDER_FEMALE`	A female voice.
`SSML_VOICE_GENDER_NEUTRAL`	A gender-neutral voice.