Package google.cloud.texttospeech.v1beta1

Index

TextToSpeech

Service that implements Google Cloud Text-to-Speech API.

ListVoices

rpc ListVoices(ListVoicesRequest) returns (ListVoicesResponse)

Returns a list of Voice supported for synthesis.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

SynthesizeSpeech

rpc SynthesizeSpeech(SynthesizeSpeechRequest) returns (SynthesizeSpeechResponse)

Synthesizes speech synchronously: receive results after all text input has been processed.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

AudioConfig

Description of audio data to be synthesized.

Fields
audio_encoding

AudioEncoding

Required. The format of the audio byte stream.

speaking_rate

double

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

double

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

double

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

int32

The synthesis sample rate (in hertz) for this audio. Optional. 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.

effects_profile_id[]

string

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

AudioEncoding

Configuration to set up audio encoder. The encoding determines the output audio format that we'd like.

Enums
AUDIO_ENCODING_UNSPECIFIED Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.
LINEAR16 Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.
MP3 MP3 audio at 32kbps.
OGG_OPUS Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.

ListVoicesRequest

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

Fields
language_code

string

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.

ListVoicesResponse

The message returned to the client by the ListVoices method.

Fields
voices[]

Voice

The list of voices.

SsmlVoiceGender

Gender of the voice as described in SSML voice element.

Enums
SSML_VOICE_GENDER_UNSPECIFIED An unspecified gender. In VoiceSelectionParams, this means that the client doesn't care which gender the selected voice will have. In the Voice field of ListVoicesResponse, this may mean that the voice doesn't fit any of the other categories in this enum, or that the gender of the voice isn't known.
MALE A male voice.
FEMALE A female voice.
NEUTRAL A gender-neutral voice.

SynthesisInput

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.

Fields
Union field input_source. The input source, which is either plain text or SSML. input_source can be only one of the following:
text

string

The raw text to be synthesized.

ssml

string

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.

SynthesizeSpeechRequest

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

Fields
input

SynthesisInput

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

voice

VoiceSelectionParams

Required. The desired voice of the synthesized audio.

audio_config

AudioConfig

Required. The configuration of the synthesized audio.

SynthesizeSpeechResponse

The message returned to the client by the SynthesizeSpeech method.

Fields
audio_content

bytes

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.

Voice

Description of a voice supported by the TTS service.

Fields
language_codes[]

string

The languages that this voice supports, expressed as BCP-47 language tags (e.g. "en-US", "es-419", "cmn-tw").

name

string

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

ssml_gender

SsmlVoiceGender

The gender of this voice.

natural_sample_rate_hertz

int32

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

VoiceSelectionParams

Description of which voice to use for a synthesis request.

Fields
language_code

string

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

string

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

SsmlVoiceGender

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.

هل كانت هذه الصفحة مفيدة؟ يرجى تقييم أدائنا:

إرسال تعليقات حول...

Cloud Text-to-Speech API
هل تحتاج إلى مساعدة؟ انتقل إلى صفحة الدعم.