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 |
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 |
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 |
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 |
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 |
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 |
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 |
AsyncStreamingSynthesize(Options)
Performs bidirectional streaming speech synthesis: receive audio while sending text.
Parameter | |
---|---|
Name | Description |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc< google::cloud::texttospeech::v1::StreamingSynthesizeRequest, google::cloud::texttospeech::v1::StreamingSynthesizeResponse > > |
An object representing the bidirectional streaming RPC. Applications can send multiple request messages and receive multiple response messages through this API. Bidirectional streaming RPCs can impose restrictions on the sequence of request and response messages. Please consult the service documentation for details. The request message type (google.cloud.texttospeech.v1.StreamingSynthesizeRequest) and response messages (google.cloud.texttospeech.v1.StreamingSynthesizeResponse) are mapped to C++ classes using the Protobuf mapping rules. |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::ListOperationsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
google::longrunning::GetOperationRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |