Google.Cloud.TextToSpeech.V1

Holder for reflection information generated from google/cloud/texttospeech/v1/cloud_tts.proto

File descriptor for google/cloud/texttospeech/v1/cloud_tts.proto

Gender of the voice as described in [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice).

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.

A male voice.

A female voice.

A gender-neutral voice. This voice is not yet supported.

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

Not specified. Will return result [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].

Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.

MP3 audio at 32kbps.

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.

8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. Audio content returned as MULAW also contains a WAV header.

8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law. Audio content returned as ALAW also contains a WAV header.

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

Field number for the "language_code" field.

Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the API will return all supported voices. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. For example, if you specify `"en-NZ"`, all `"en-NZ"` voices will be returned. If you specify `"no"`, both `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be returned.

The message returned to the client by the `ListVoices` method.

Field number for the "voices" field.

The list of voices.

Description of a voice supported by the TTS service.

Field number for the "language_codes" field.

The languages that this voice supports, expressed as [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw").

Field number for the "name" field.

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

Field number for the "ssml_gender" field.

The gender of this voice.

Field number for the "natural_sample_rate_hertz" field.

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

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

Field number for the "input" field.

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

Field number for the "voice" field.

Required. The desired voice of the synthesized audio.

Field number for the "audio_config" field.

Required. The configuration of the synthesized audio.

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

Field number for the "text" field.

The raw text to be synthesized.

Gets whether the "text" field is set

Clears the value of the oneof if it's currently set to "text"

Field number for the "ssml" field.

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][google.rpc.Code.INVALID_ARGUMENT]. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).

Gets whether the "ssml" field is set

Clears the value of the oneof if it's currently set to "ssml"

Enum of possible cases for the "input_source" oneof.

Description of which voice to use for a synthesis request.

Field number for the "language_code" field.

Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) 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)".

Field number for the "name" field.

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.

Field number for the "ssml_gender" field.

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.

Field number for the "custom_voice" field.

The configuration for a custom voice. If [CustomVoiceParams.model] is set, the service will choose the custom voice matching the specified configuration.

Description of audio data to be synthesized.

Field number for the "audio_encoding" field.

Required. The format of the audio byte stream.

Field number for the "speaking_rate" field.

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.

Field number for the "pitch" field.

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.

Field number for the "volume_gain_db" field.

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.

Field number for the "sample_rate_hertz" field.

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][google.rpc.Code.INVALID_ARGUMENT].

Field number for the "effects_profile_id" field.

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](https://cloud.google.com/text-to-speech/docs/audio-profiles) for current supported profile ids.

Description of the custom voice to be synthesized.

Field number for the "model" field.

Required. The name of the AutoML model that synthesizes the custom voice.

Field number for the "reported_usage" field.

Optional. Deprecated. The usage of the synthesized audio to be reported.

Container for nested types declared in the CustomVoiceParams message type.

Deprecated. The usage of the synthesized audio. Usage does not affect billing.

Request with reported usage unspecified will be rejected.

For scenarios where the synthesized audio is not downloadable and can only be used once. For example, real-time request in IVR system.

For scenarios where the synthesized audio is downloadable and can be reused. For example, the synthesized audio is downloaded, stored in customer service system and played repeatedly.

-typed view over the resource name property.

The message returned to the client by the `SynthesizeSpeech` method.

Field number for the "audio_content" field.

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.

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

Service descriptor

Base class for server-side implementations of TextToSpeech

Returns a list of Voice supported for synthesis.

The request received from the client. The context of the server-side call handler being invoked. The response to send back to the client (wrapped by a task).

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

The request received from the client. The context of the server-side call handler being invoked. The response to send back to the client (wrapped by a task).

Client for TextToSpeech

Creates a new client for TextToSpeech

The channel to use to make remote calls.

Creates a new client for TextToSpeech that uses a custom CallInvoker.

The callInvoker to use to make remote calls.

Protected parameterless constructor to allow creation of test doubles.

Protected constructor to allow creation of configured clients.

The client configuration.

Returns a list of Voice supported for synthesis.

The request to send to the server. The initial metadata to send with the call. This parameter is optional. An optional deadline for the call. The call will be cancelled if deadline is hit. An optional token for canceling the call. The response received from the server.

Returns a list of Voice supported for synthesis.

The request to send to the server. The options for the call. The response received from the server.

Returns a list of Voice supported for synthesis.

The request to send to the server. The options for the call. The call object.

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

The request to send to the server. The options for the call. The response received from the server.

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

The request to send to the server. The options for the call. The call object.

Creates a new instance of client from given ClientBaseConfiguration.

Creates service definition that can be registered with a server

An object implementing the server-side handling logic.

Register service method with a service binder with or without implementation. Useful when customizing the service binding logic. Note: this method is part of an experimental API that can change or be removed without any prior notice.

Service methods will be bound by calling AddMethod on this object. An object implementing the server-side handling logic.

Holder for reflection information generated from google/cloud/texttospeech/v1/cloud_tts_lrs.proto

File descriptor for google/cloud/texttospeech/v1/cloud_tts_lrs.proto

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

Field number for the "parent" field.

The resource states of the request in the form of `projects/*/locations/*`.

Field number for the "input" field.

Required. The Synthesizer requires either plain text or SSML as input. While Long Audio is in preview, SSML is temporarily unsupported.

Field number for the "audio_config" field.

Required. The configuration of the synthesized audio.

Field number for the "output_gcs_uri" field.

Required. Specifies a Cloud Storage URI for the synthesis results. Must be specified in the format: `gs://bucket_name/object_name`, and the bucket must already exist.

Field number for the "voice" field.

Required. The desired voice of the synthesized audio.

The message returned to the client by the `SynthesizeLongAudio` method.

Metadata for response returned by the `SynthesizeLongAudio` method.

Field number for the "start_time" field.

Time when the request was received.

Field number for the "last_update_time" field.

Deprecated. Do not use.

Field number for the "progress_percentage" field.

The progress of the most recent processing update in percentage, ie. 70.0%.

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

Service descriptor

Base class for server-side implementations of TextToSpeechLongAudioSynthesize

Synthesizes long form text asynchronously.

The request received from the client. The context of the server-side call handler being invoked. The response to send back to the client (wrapped by a task).

Client for TextToSpeechLongAudioSynthesize

Creates a new client for TextToSpeechLongAudioSynthesize

The channel to use to make remote calls.

Creates a new client for TextToSpeechLongAudioSynthesize that uses a custom CallInvoker.

The callInvoker to use to make remote calls.

Protected parameterless constructor to allow creation of test doubles.

Protected constructor to allow creation of configured clients.

The client configuration.

Synthesizes long form text asynchronously.

The request to send to the server. The options for the call. The response received from the server.

Synthesizes long form text asynchronously.

The request to send to the server. The options for the call. The call object.

Creates a new instance of client from given ClientBaseConfiguration.

Creates a new instance of using the same call invoker as this client.

A new Operations client for the same target as this client.

Creates service definition that can be registered with a server

An object implementing the server-side handling logic.

Service methods will be bound by calling AddMethod on this object. An object implementing the server-side handling logic.

Resource name for the Model resource.

The possible contents of .

An unparsed resource name.

A resource name with pattern projects/{project}/locations/{location}/models/{model}.

Creates a containing an unparsed resource name.

The unparsed resource name. Must not be null. A new instance of containing the provided .

Creates a with the pattern projects/{project}/locations/{location}/models/{model} .

The Project ID. Must not be null or empty. The Location ID. Must not be null or empty. The Model ID. Must not be null or empty. A new instance of constructed from the provided ids.

Formats the IDs into the string representation of this with pattern projects/{project}/locations/{location}/models/{model}.

The Project ID. Must not be null or empty. The Location ID. Must not be null or empty. The Model ID. Must not be null or empty. The string representation of this with pattern projects/{project}/locations/{location}/models/{model}.

Formats the IDs into the string representation of this with pattern projects/{project}/locations/{location}/models/{model}.

Parses the given resource name string into a new instance.

Parses the given resource name string into a new instance; optionally allowing an unparseable resource name.

To parse successfully, the resource name must be formatted as one of the following: projects/{project}/locations/{location}/models/{model} Or may be in any format if is true. The resource name in string form. Must not be null. If true will successfully store an unparseable resource name into the property; otherwise will throw an if an unparseable resource name is specified. The parsed if successful.

Tries to parse the given resource name string into a new instance.

To parse successfully, the resource name must be formatted as one of the following: projects/{project}/locations/{location}/models/{model} The resource name in string form. Must not be null. When this method returns, the parsed , or null if parsing failed. true if the name was parsed successfully; false otherwise.

Tries to parse the given resource name string into a new instance; optionally allowing an unparseable resource name.

Constructs a new instance of a class from the component parts of pattern projects/{project}/locations/{location}/models/{model}

The Project ID. Must not be null or empty. The Location ID. Must not be null or empty. The Model ID. Must not be null or empty.

The of the contained resource name.

The contained . Only non-null if this instance contains an unparsed resource name.

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

The Model ID. Will not be null, unless this instance contains an unparsed resource name.

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Whether this instance contains a resource name with a known pattern.

The string representation of the resource name.

Returns a hash code for this resource name.

Determines whether two specified resource names have the same value.

The first resource name to compare, or null. The second resource name to compare, or null. true if the value of is the same as the value of ; otherwise, false.

Determines whether two specified resource names have different values.

The first resource name to compare, or null. The second resource name to compare, or null. true if the value of is different from the value of ; otherwise, false.

Static class to provide common access to package-wide API metadata.

The for services in this package.

Settings for instances.

Get a new instance of the default .

A new instance of the default .

Constructs a new object with default settings.

for synchronous and asynchronous calls to TextToSpeechClient.ListVoices and TextToSpeechClient.ListVoicesAsync.

Initial retry delay: 100 milliseconds. Retry delay multiplier: 1.3 Retry maximum delay: 60000 milliseconds. Maximum attempts: Unlimited Retriable status codes: , . Timeout: 300 seconds.

for synchronous and asynchronous calls to TextToSpeechClient.SynthesizeSpeech and TextToSpeechClient.SynthesizeSpeechAsync.

Initial retry delay: 100 milliseconds. Retry delay multiplier: 1.3 Retry maximum delay: 60000 milliseconds. Maximum attempts: Unlimited Retriable status codes: , . Timeout: 300 seconds.

Creates a deep clone of this object, with all the same property values.

A deep clone of this object.

Builder class for to provide simple configuration of credentials, endpoint etc.

The settings to use for RPCs, or null for the default settings.

Creates a new builder with default settings.

Builds the resulting client.

Builds the resulting client asynchronously.

Returns the channel pool to use when no other options are specified.

TextToSpeech client wrapper, for convenient use.

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

The default endpoint for the TextToSpeech service, which is a host of "texttospeech.googleapis.com" and a port of 443.

The default TextToSpeech scopes.

The default TextToSpeech scopes are: https://www.googleapis.com/auth/cloud-platform

The service metadata associated with this client type.

Asynchronously creates a using the default credentials, endpoint and settings. To specify custom credentials or other settings, use .

The to use while creating the client. The task representing the created .

Synchronously creates a using the default credentials, endpoint and settings. To specify custom credentials or other settings, use .

The created .

Creates a which uses the specified call invoker for remote operations.

The for remote operations. Must not be null. Optional . Optional . The created .

Shuts down any channels automatically created by and . Channels which weren't automatically created are not affected.

After calling this method, further calls to and will create new channels, which could in turn be shut down by another call to this method. A task representing the asynchronous shutdown operation.

The underlying gRPC TextToSpeech client

Returns a list of Voice supported for synthesis.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. The RPC response.

Returns a list of Voice supported for synthesis.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. A Task containing the RPC response.

Returns a list of Voice supported for synthesis.

The request object containing all of the parameters for the API call. A to use for this RPC. A Task containing the RPC response.

Returns a list of Voice supported for synthesis.

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

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. The RPC response.

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

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. A Task containing the RPC response.

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

The request object containing all of the parameters for the API call. A to use for this RPC. A Task containing the RPC response.

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

Required. The Synthesizer requires either plain text or SSML as input. Required. The desired voice of the synthesized audio. Required. The configuration of the synthesized audio. If not null, applies overrides to this RPC call. The RPC response.

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

Required. The Synthesizer requires either plain text or SSML as input. Required. The desired voice of the synthesized audio. Required. The configuration of the synthesized audio. A to use for this RPC. A Task containing the RPC response.

TextToSpeech client wrapper implementation, for convenient use.

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

Constructs a client wrapper for the TextToSpeech service, with the specified gRPC client and settings.

The underlying gRPC client. The base used within this client. Optional to use within this client.

The underlying gRPC TextToSpeech client

Returns a list of Voice supported for synthesis.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. The RPC response.

Returns a list of Voice supported for synthesis.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. A Task containing the RPC response.

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

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. The RPC response.

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

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. A Task containing the RPC response.

Settings for instances.

Get a new instance of the default .

A new instance of the default .

Constructs a new object with default settings.

for synchronous and asynchronous calls to TextToSpeechLongAudioSynthesizeClient.SynthesizeLongAudio and TextToSpeechLongAudioSynthesizeClient.SynthesizeLongAudioAsync.

This call will not be retried. Timeout: 5000 seconds.

Long Running Operation settings for calls to TextToSpeechLongAudioSynthesizeClient.SynthesizeLongAudio and TextToSpeechLongAudioSynthesizeClient.SynthesizeLongAudioAsync.

Uses default of: Initial delay: 20 seconds. Delay multiplier: 1.5 Maximum delay: 45 seconds. Total timeout: 24 hours.

Creates a deep clone of this object, with all the same property values.

A deep clone of this object.

Builder class for to provide simple configuration of credentials, endpoint etc.

The settings to use for RPCs, or null for the default settings.

Creates a new builder with default settings.

Builds the resulting client.

Builds the resulting client asynchronously.

Returns the channel pool to use when no other options are specified.

TextToSpeechLongAudioSynthesize client wrapper, for convenient use.

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

The default endpoint for the TextToSpeechLongAudioSynthesize service, which is a host of "texttospeech.googleapis.com" and a port of 443.

The default TextToSpeechLongAudioSynthesize scopes.

The default TextToSpeechLongAudioSynthesize scopes are: https://www.googleapis.com/auth/cloud-platform

The service metadata associated with this client type.

Asynchronously creates a using the default credentials, endpoint and settings. To specify custom credentials or other settings, use .

The to use while creating the client. The task representing the created .

Synchronously creates a using the default credentials, endpoint and settings. To specify custom credentials or other settings, use .

The created .

Creates a which uses the specified call invoker for remote operations.

The for remote operations. Must not be null. Optional . Optional . The created .

Shuts down any channels automatically created by and . Channels which weren't automatically created are not affected.

After calling this method, further calls to and will create new channels, which could in turn be shut down by another call to this method. A task representing the asynchronous shutdown operation.

The underlying gRPC TextToSpeechLongAudioSynthesize client

Synthesizes long form text asynchronously.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. The RPC response.

Synthesizes long form text asynchronously.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. A Task containing the RPC response.

Synthesizes long form text asynchronously.

The request object containing all of the parameters for the API call. A to use for this RPC. A Task containing the RPC response.

The long-running operations client for SynthesizeLongAudio.

Poll an operation once, using an operationName from a previous invocation of SynthesizeLongAudio .

The name of a previously invoked operation. Must not be null or empty. If not null, applies overrides to this RPC call. The result of polling the operation.

Asynchronously poll an operation once, using an operationName from a previous invocation of SynthesizeLongAudio.

The name of a previously invoked operation. Must not be null or empty. If not null, applies overrides to this RPC call. A task representing the result of polling the operation.

TextToSpeechLongAudioSynthesize client wrapper implementation, for convenient use.

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

Constructs a client wrapper for the TextToSpeechLongAudioSynthesize service, with the specified gRPC client and settings.

The underlying gRPC client. The base used within this client. Optional to use within this client.

The underlying gRPC TextToSpeechLongAudioSynthesize client

The long-running operations client for SynthesizeLongAudio.

Synthesizes long form text asynchronously.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. The RPC response.

Synthesizes long form text asynchronously.

The request object containing all of the parameters for the API call. If not null, applies overrides to this RPC call. A Task containing the RPC response.

Static class to provide extension methods to configure API clients.

Adds a singleton to .

The service collection to add the client to. The services are used to configure the client when requested. An optional action to invoke on the client builder. This is invoked before services from are used.

Adds a singleton to .