Cloud Video Intelligence V1 Client - Class AnnotateVideoRequest (2.0.1)

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

Video annotation request.

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

Namespace

Google \ Cloud \ VideoIntelligence \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ input_uri string

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). 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.
↳ input_content string

The video data bytes. If unset, the input video(s) should be specified via the input_uri. If set, input_uri must be unset.
↳ features array

Required. Requested video annotation features.
↳ video_context 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 Cloud Storage URIs are supported. These 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 are: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, the region will be determined based on video file location.

getInputUri

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). 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.

Returns
Type Description
string

setInputUri

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). 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.

Parameter
Name Description
var string
Returns
Type Description
$this

getInputContent

The video data bytes.

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

Returns
Type Description
string

setInputContent

The video data bytes.

If unset, the input video(s) should be specified via the input_uri. If set, input_uri must 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
VideoContext|null

hasVideoContext

clearVideoContext

setVideoContext

Additional video context and/or feature-specific parameters.

Parameter
Name Description
var VideoContext
Returns
Type Description
$this

getOutputUri

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

Currently, only Cloud Storage URIs are supported. These 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 Cloud Storage URIs are supported. These 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 are: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, the 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 are: us-east1, us-west1, europe-west1, asia-east1. If no region is specified, the region will be determined based on video file location.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
inputUri string

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). 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 int[]

Required. Requested video annotation features. For allowed values, use constants defined on Feature
Returns
Type Description
AnnotateVideoRequest