Cloud Video Intelligence V1beta2 Client - Class AnnotateVideoRequest (1.13.1)

Version 1.13.1

• 2.0.1 (latest)
• 2.0.0
• 1.15.5
• 1.14.2
• 1.13.1
• 1.12.16

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Cloud Video Intelligence V1beta2 Client class AnnotateVideoRequest.

Video annotation request.

Generated from protobuf message google.cloud.videointelligence.v1beta2.AnnotateVideoRequest

Namespace

Google \ Cloud \ VideoIntelligence \ V1beta2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ input_uri	string Input video location. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs. A video URI may include wildcards in object-id, and thus identify multiple videos. 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 should be unset.
↳ input_content	string The video data bytes. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.
↳ features	array Required. Requested video annotation features.
↳ video_context	Google\Cloud\VideoIntelligence\V1beta2\VideoContext Additional video context and/or feature-specific parameters.
↳ output_uri	string Optional. Location where the output (in JSON format) should be stored. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs.
↳ location_id	string Optional. Cloud region where annotation should take place. Supported cloud regions: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, a region will be determined based on video file location.

getInputUri

Input video location. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs. A video URI may include wildcards in object-id, and thus identify multiple videos.

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 should be unset.

Returns
Type	Description
string

setInputUri

Input video location. Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs. A video URI may include wildcards in object-id, and thus identify multiple videos.

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 should be unset.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getInputContent

The video data bytes.

If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

Returns
Type	Description
string

setInputContent

The video data bytes.

If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFeatures

Required. Requested video annotation features.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setFeatures

Required. Requested video annotation features.

Parameter
Name	Description
var	int[]

Returns
Type	Description
$this

getVideoContext

Additional video context and/or feature-specific parameters.

Returns
Type	Description
Google\Cloud\VideoIntelligence\V1beta2\VideoContext|null

hasVideoContext

clearVideoContext

setVideoContext

Additional video context and/or feature-specific parameters.

Parameter
Name	Description
var	Google\Cloud\VideoIntelligence\V1beta2\VideoContext

Returns
Type	Description
$this

getOutputUri

Optional. Location where the output (in JSON format) should be stored.

Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs.

Returns
Type	Description
string

setOutputUri

Optional. Location where the output (in JSON format) should be stored.

Currently, only Google Cloud Storage URIs are supported, which must be specified in the following format: gs://bucket-id/object-id (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLocationId

Optional. Cloud region where annotation should take place. Supported cloud regions: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, a region will be determined based on video file location.

Returns
Type	Description
string

setLocationId

Optional. Cloud region where annotation should take place. Supported cloud regions: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, a region will be determined based on video file location.

Parameter
Name	Description
var	string

Returns
Type	Description
$this