Types for Cloud Text-to-Speech API Client#
-
class
google.cloud.texttospeech_v1beta1.types.
AudioConfig
# Description of audio data to be synthesized.
-
audio_encoding
# Required. The format of the requested audio byte stream.
-
speaking_rate
# 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
# 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.
-
volume_gain_db
# 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. Strongly recommend not to exceed +10 (dB) as there’s usually no effective increase in loudness for any value greater than that.
-
sample_rate_hertz
# The synthesis sample rate (in hertz) for this audio. Optional. If this is different from the voice’s natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return [google.rpc.Code.INVALID_ARGUMENT][].
-
effects_profile_id
# 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.
-
audio_encoding
Field google.cloud.texttospeech.v1beta1.AudioConfig.audio_encoding
-
effects_profile_id
Field google.cloud.texttospeech.v1beta1.AudioConfig.effects_profile_id
-
pitch
Field google.cloud.texttospeech.v1beta1.AudioConfig.pitch
-
sample_rate_hertz
Field google.cloud.texttospeech.v1beta1.AudioConfig.sample_rate_hertz
-
speaking_rate
Field google.cloud.texttospeech.v1beta1.AudioConfig.speaking_rate
-
volume_gain_db
Field google.cloud.texttospeech.v1beta1.AudioConfig.volume_gain_db
-
-
class
google.cloud.texttospeech_v1beta1.types.
ListVoicesRequest
# The top-level message sent by the client for the
ListVoices
method.-
language_code
# Optional (but recommended) BCP-47 language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying “en- NZ”, you will get supported “en-” voices; when specifying “no”, you will get supported “no-” (Norwegian) and “nb-” (Norwegian Bokmal) voices; specifying “zh” will also get supported “cmn-” voices; specifying “zh-hk” will also get supported “yue-*” voices.
-
language_code
Field google.cloud.texttospeech.v1beta1.ListVoicesRequest.language_code
-
-
class
google.cloud.texttospeech_v1beta1.types.
ListVoicesResponse
# The message returned to the client by the
ListVoices
method.-
voices
# The list of voices.
-
voices
Field google.cloud.texttospeech.v1beta1.ListVoicesResponse.voices
-
-
class
google.cloud.texttospeech_v1beta1.types.
SynthesisInput
# Contains text input to be synthesized. Either
text
orssml
must be supplied. Supplying both or neither returns [google.rpc.Code.INVALID_ARGUMENT][]. The input size is limited to 5000 characters.-
input_source
# The input source, which is either plain text or SSML.
-
text
# The raw text to be synthesized.
-
ssml
# The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return [google.rpc.Code.INVALID_ARGUMENT][]. For more information, see SSML.
-
ssml
Field google.cloud.texttospeech.v1beta1.SynthesisInput.ssml
-
text
Field google.cloud.texttospeech.v1beta1.SynthesisInput.text
-
-
class
google.cloud.texttospeech_v1beta1.types.
SynthesizeSpeechRequest
# The top-level message sent by the client for the
SynthesizeSpeech
method.-
input
# Required. The Synthesizer requires either plain text or SSML as input.
-
voice
# Required. The desired voice of the synthesized audio.
-
audio_config
# Required. The configuration of the synthesized audio.
-
audio_config
Field google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.audio_config
-
input
Field google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.input
-
voice
Field google.cloud.texttospeech.v1beta1.SynthesizeSpeechRequest.voice
-
-
class
google.cloud.texttospeech_v1beta1.types.
SynthesizeSpeechResponse
# The message returned to the client by the
SynthesizeSpeech
method.-
audio_content
# The audio data bytes encoded as specified in the request, including the header (For LINEAR16 audio, we include the WAV header). Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
-
audio_content
Field google.cloud.texttospeech.v1beta1.SynthesizeSpeechResponse.audio_content
-
-
class
google.cloud.texttospeech_v1beta1.types.
Voice
# Description of a voice supported by the TTS service.
-
language_codes
# The languages that this voice supports, expressed as BCP-47 language tags (e.g. “en-US”, “es-419”, “cmn-tw”).
-
name
# The name of this voice. Each distinct voice has a unique name.
-
ssml_gender
# The gender of this voice.
-
natural_sample_rate_hertz
# The natural sample rate (in hertz) for this voice.
-
language_codes
Field google.cloud.texttospeech.v1beta1.Voice.language_codes
-
name
Field google.cloud.texttospeech.v1beta1.Voice.name
-
natural_sample_rate_hertz
Field google.cloud.texttospeech.v1beta1.Voice.natural_sample_rate_hertz
-
ssml_gender
Field google.cloud.texttospeech.v1beta1.Voice.ssml_gender
-
-
class
google.cloud.texttospeech_v1beta1.types.
VoiceSelectionParams
# Description of which voice to use for a synthesis request.
-
language_code
# The language (and optionally also the region) of the voice expressed as a BCP-47 language tag, e.g. “en-US”. Required. This should not include a script tag (e.g. use “cmn- cn” rather than “cmn-Hant-cn”), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en- US rather than en-CA if there isn’t a Canadian voice available), or even a different language, e.g. using “nb” (Norwegian Bokmal) instead of “no” (Norwegian)”.
-
name
# The name of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code and gender.
-
ssml_gender
# The preferred gender of the voice. Optional; if not set, the service will choose a voice based on the other parameters such as language_code 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.
-
language_code
Field google.cloud.texttospeech.v1beta1.VoiceSelectionParams.language_code
-
name
Field google.cloud.texttospeech.v1beta1.VoiceSelectionParams.name
-
ssml_gender
Field google.cloud.texttospeech.v1beta1.VoiceSelectionParams.ssml_gender
-