As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Texttospeech v1 API

class google.cloud.texttospeech_v1.types.AudioConfig(mapping=None, **kwargs)[source]

Description of audio data to be synthesized.

audio_encoding

Required. The format of the audio byte stream.

Type

AudioEncoding

speaking_rate

Optional. Input only. 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.

Type

float

pitch

Optional. Input only. 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.

Type

float

volume_gain_db

Optional. Input only. 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.

Type

float

sample_rate_hertz

Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, 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][].

Type

int

effects_profile_id

Optional. Input only. 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. See audio profiles for current supported profile ids.

Type

Sequence[str]

class google.cloud.texttospeech_v1.types.ListVoicesRequest(mapping=None, **kwargs)[source]

The top-level message sent by the client for the ListVoices method.

language_code

Optional. 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.

Type

str

class google.cloud.texttospeech_v1.types.ListVoicesResponse(mapping=None, **kwargs)[source]

The message returned to the client by the ListVoices method.

voices

The list of voices.

Type

Sequence[Voice]

class google.cloud.texttospeech_v1.types.SynthesisInput(mapping=None, **kwargs)[source]

Contains text input to be synthesized. Either text or ssml must be supplied. Supplying both or neither returns [google.rpc.Code.INVALID_ARGUMENT][]. The input size is limited to 5000 characters.

text

The raw text to be synthesized.

Type

str

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.

Type

str

class google.cloud.texttospeech_v1.types.SynthesizeSpeechRequest(mapping=None, **kwargs)[source]

The top-level message sent by the client for the SynthesizeSpeech method.

input

Required. The Synthesizer requires either plain text or SSML as input.

Type

SynthesisInput

voice

Required. The desired voice of the synthesized audio.

Type

VoiceSelectionParams

audio_config

Required. The configuration of the synthesized audio.

Type

AudioConfig

class google.cloud.texttospeech_v1.types.SynthesizeSpeechResponse(mapping=None, **kwargs)[source]

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 encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). 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.

Type

bytes

class google.cloud.texttospeech_v1.types.Voice(mapping=None, **kwargs)[source]

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”).

Type

Sequence[str]

name

The name of this voice. Each distinct voice has a unique name.

Type

str

ssml_gender

The gender of this voice.

Type

SsmlVoiceGender

natural_sample_rate_hertz

The natural sample rate (in hertz) for this voice.

Type

int

class google.cloud.texttospeech_v1.types.VoiceSelectionParams(mapping=None, **kwargs)[source]

Description of which voice to use for a synthesis request.

language_code

Required. The language (and potentially also the region) of the voice expressed as a BCP-47 language tag, e.g. “en-US”. 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)”.

Type

str

name

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

Type

str

ssml_gender

The preferred gender of the voice. 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.

Type

SsmlVoiceGender