Class VideoIntelligenceServiceClient (2.28.0)

Service that implements the Video Intelligence 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

VideoIntelligenceServiceClient(VideoIntelligenceServiceClient const &)

Copy and move support

Parameter
Name Description
VideoIntelligenceServiceClient const &

VideoIntelligenceServiceClient(VideoIntelligenceServiceClient &&)

Copy and move support

Parameter
Name Description
VideoIntelligenceServiceClient &&

VideoIntelligenceServiceClient(std::shared_ptr< VideoIntelligenceServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< VideoIntelligenceServiceConnection >
opts Options

Operators

operator=(VideoIntelligenceServiceClient const &)

Copy and move support

Parameter
Name Description
VideoIntelligenceServiceClient const &
Returns
Type Description
VideoIntelligenceServiceClient &

operator=(VideoIntelligenceServiceClient &&)

Copy and move support

Parameter
Name Description
VideoIntelligenceServiceClient &&
Returns
Type Description
VideoIntelligenceServiceClient &

Functions

AnnotateVideo(std::string const &, std::vector< google::cloud::videointelligence::v1::Feature > const &, Options)

Performs asynchronous video annotation.

Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains AnnotateVideoProgress (progress). Operation.response contains AnnotateVideoResponse (results).

Parameters
Name Description
input_uri std::string const &

Input video location. Currently, only Cloud Storage URIs are supported. URIs must be specified in the following format: gs://bucket-id/object-id (other URI formats return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs. To identify multiple videos, a video URI may include wildcards in the object-id. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as input_content. If set, input_content must be unset.

features std::vector< google::cloud::videointelligence::v1::Feature > const &

Required. Requested video annotation features.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::videointelligence::v1::AnnotateVideoResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.videointelligence.v1.AnnotateVideoResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AnnotateVideo(NoAwaitTag, std::string const &, std::vector< google::cloud::videointelligence::v1::Feature > const &, Options)

Performs asynchronous video annotation.

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
input_uri std::string const &
features std::vector< google::cloud::videointelligence::v1::Feature > const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

AnnotateVideo(google::cloud::videointelligence::v1::AnnotateVideoRequest const &, Options)

Performs asynchronous video annotation.

Progress and results can be retrieved through the google.longrunning.Operations interface. Operation.metadata contains AnnotateVideoProgress (progress). Operation.response contains AnnotateVideoResponse (results).

Parameters
Name Description
request google::cloud::videointelligence::v1::AnnotateVideoRequest 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.videointelligence.v1.AnnotateVideoRequest. 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
future< StatusOr< google::cloud::videointelligence::v1::AnnotateVideoResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.videointelligence.v1.AnnotateVideoResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

AnnotateVideo(NoAwaitTag, google::cloud::videointelligence::v1::AnnotateVideoRequest const &, Options)

Performs asynchronous video annotation.

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::videointelligence::v1::AnnotateVideoRequest const &
opts Options
Returns
Type Description
StatusOr< google::longrunning::Operation >

AnnotateVideo(google::longrunning::Operation const &, Options)

Performs asynchronous video annotation.

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::videointelligence::v1::AnnotateVideoResponse > >