Service that implements Google Cloud 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
SpeechClient(SpeechClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient const &
|
SpeechClient(SpeechClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient &&
|
SpeechClient(std::shared_ptr< SpeechConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< SpeechConnection >
|
opts |
Options
|
Operators
operator=(SpeechClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient const &
|
Returns | |
---|---|
Type | Description |
SpeechClient & |
operator=(SpeechClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
SpeechClient &&
|
Returns | |
---|---|
Type | Description |
SpeechClient & |
Functions
Recognize(google::cloud::speech::v1::RecognitionConfig const &, google::cloud::speech::v1::RecognitionAudio const &, Options)
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
Parameters | |
---|---|
Name | Description |
config |
google::cloud::speech::v1::RecognitionConfig const &
Required. Provides information to the recognizer that specifies how to process the request. |
audio |
google::cloud::speech::v1::RecognitionAudio const &
Required. The audio data to be recognized. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::speech::v1::RecognizeResponse > |
the result of the RPC. The response message type (google.cloud.speech.v1.RecognizeResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
Recognize(google::cloud::speech::v1::RecognizeRequest const &, Options)
Performs synchronous speech recognition: receive results after all audio has been sent and processed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v1::RecognizeRequest 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::speech::v1::RecognizeResponse > |
the result of the RPC. The response message type (google.cloud.speech.v1.RecognizeResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
LongRunningRecognize(google::cloud::speech::v1::RecognitionConfig const &, google::cloud::speech::v1::RecognitionAudio const &, Options)
Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface.
Returns either an Operation.error
or an Operation.response
which contains a LongRunningRecognizeResponse
message. For more information on asynchronous speech recognition, see the how-to.
Parameters | |
---|---|
Name | Description |
config |
google::cloud::speech::v1::RecognitionConfig const &
Required. Provides information to the recognizer that specifies how to process the request. |
audio |
google::cloud::speech::v1::RecognitionAudio const &
Required. The audio data to be recognized. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v1::LongRunningRecognizeResponse > > |
A |
LongRunningRecognize(NoAwaitTag, google::cloud::speech::v1::RecognitionConfig const &, google::cloud::speech::v1::RecognitionAudio const &, Options)
Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
config |
google::cloud::speech::v1::RecognitionConfig const &
|
audio |
google::cloud::speech::v1::RecognitionAudio const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
LongRunningRecognize(google::cloud::speech::v1::LongRunningRecognizeRequest const &, Options)
Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface.
Returns either an Operation.error
or an Operation.response
which contains a LongRunningRecognizeResponse
message. For more information on asynchronous speech recognition, see the how-to.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::speech::v1::LongRunningRecognizeRequest 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 |
future< StatusOr< google::cloud::speech::v1::LongRunningRecognizeResponse > > |
A |
LongRunningRecognize(NoAwaitTag, google::cloud::speech::v1::LongRunningRecognizeRequest const &, Options)
Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::speech::v1::LongRunningRecognizeRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
LongRunningRecognize(google::longrunning::Operation const &, Options)
Performs asynchronous speech recognition: receive results via the google.longrunning.Operations interface.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::speech::v1::LongRunningRecognizeResponse > > |
AsyncStreamingRecognize(Options)
Performs bidirectional streaming speech recognition: receive results while sending audio.
This method is only available via the gRPC API (not REST).
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::speech::v1::StreamingRecognizeRequest, google::cloud::speech::v1::StreamingRecognizeResponse > > |
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.speech.v1.StreamingRecognizeRequest) and response messages (google.cloud.speech.v1.StreamingRecognizeResponse) are mapped to C++ classes using the Protobuf mapping rules. |