Class TextToSpeechClient (2.23.0)

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

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

TextToSpeechClient(TextToSpeechClient const &)

Copy and move support

Parameter
Name	Description
	`TextToSpeechClient const &`

TextToSpeechClient(TextToSpeechClient &&)

Copy and move support

Parameter
Name	Description
	`TextToSpeechClient &&`

TextToSpeechClient(std::shared_ptr< TextToSpeechConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< TextToSpeechConnection >`
`opts`	`Options`

Operators

operator=(TextToSpeechClient const &)

Copy and move support

Parameter
Name	Description
	`TextToSpeechClient const &`

Returns
Type	Description
`TextToSpeechClient &`

operator=(TextToSpeechClient &&)

Copy and move support

Parameter
Name	Description
	`TextToSpeechClient &&`

Returns
Type	Description
`TextToSpeechClient &`

Functions

ListVoices(std::string const &, Options)

Returns a list of Voice supported for synthesis.

Parameters
Name	Description
`language_code`	`std::string const &` Optional. Recommended. BCP-47 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::texttospeech::v1::ListVoicesResponse >`	the result of the RPC. The response message type (google.cloud.texttospeech.v1.ListVoicesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListVoices(google::cloud::texttospeech::v1::ListVoicesRequest const &, Options)

Returns a list of Voice supported for synthesis.

Parameters
Name	Description
`request`	`google::cloud::texttospeech::v1::ListVoicesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.texttospeech.v1.ListVoicesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::texttospeech::v1::ListVoicesResponse >`	the result of the RPC. The response message type (google.cloud.texttospeech.v1.ListVoicesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SynthesizeSpeech(google::cloud::texttospeech::v1::SynthesisInput const &, google::cloud::texttospeech::v1::VoiceSelectionParams const &, google::cloud::texttospeech::v1::AudioConfig const &, Options)

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

Parameters
Name	Description
`input`	`google::cloud::texttospeech::v1::SynthesisInput const &` Required. The Synthesizer requires either plain text or SSML as input.
`voice`	`google::cloud::texttospeech::v1::VoiceSelectionParams const &` Required. The desired voice of the synthesized audio.
`audio_config`	`google::cloud::texttospeech::v1::AudioConfig const &` Required. The configuration of the synthesized audio.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::texttospeech::v1::SynthesizeSpeechResponse >`	the result of the RPC. The response message type (google.cloud.texttospeech.v1.SynthesizeSpeechResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

SynthesizeSpeech(google::cloud::texttospeech::v1::SynthesizeSpeechRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::cloud::texttospeech::v1::SynthesizeSpeechRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.texttospeech.v1.SynthesizeSpeechRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::texttospeech::v1::SynthesizeSpeechResponse >`	the result of the RPC. The response message type (google.cloud.texttospeech.v1.SynthesizeSpeechResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.