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.
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.
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud Video Intelligence V1 Client - Class AnnotateVideoRequest (2.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.5 (latest)](/php/docs/reference/cloud-videointelligence/latest/V1.AnnotateVideoRequest)\n- [2.0.4](/php/docs/reference/cloud-videointelligence/2.0.4/V1.AnnotateVideoRequest)\n- [1.15.5](/php/docs/reference/cloud-videointelligence/1.15.5/V1.AnnotateVideoRequest)\n- [1.14.2](/php/docs/reference/cloud-videointelligence/1.14.2/V1.AnnotateVideoRequest)\n- [1.13.1](/php/docs/reference/cloud-videointelligence/1.13.1/V1.AnnotateVideoRequest)\n- [1.12.16](/php/docs/reference/cloud-videointelligence/1.12.16/V1.AnnotateVideoRequest) \nReference documentation and code samples for the Cloud Video Intelligence V1 Client class AnnotateVideoRequest.\n\nVideo annotation request.\n\nGenerated from protobuf message `google.cloud.videointelligence.v1.AnnotateVideoRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ VideoIntelligence \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getInputUri\n\nInput video location. Currently, only\n[Cloud Storage](https://cloud.google.com/storage/) URIs are\nsupported. URIs must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\n[google.rpc.Code.INVALID_ARGUMENT](https://cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT)). For\nmore information, see [Request\nURIs](https://cloud.google.com/storage/docs/request-endpoints). To identify\nmultiple videos, a video URI may include wildcards in the `object-id`.\n\nSupported wildcards: '\\*' to match 0 or more characters;\n'?' to match 1 character. If unset, the input video should be embedded\nin the request as `input_content`. If set, `input_content` must be unset.\n\n### setInputUri\n\nInput video location. Currently, only\n[Cloud Storage](https://cloud.google.com/storage/) URIs are\nsupported. URIs must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\n[google.rpc.Code.INVALID_ARGUMENT](https://cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT)). For\nmore information, see [Request\nURIs](https://cloud.google.com/storage/docs/request-endpoints). To identify\nmultiple videos, a video URI may include wildcards in the `object-id`.\n\nSupported wildcards: '\\*' to match 0 or more characters;\n'?' to match 1 character. If unset, the input video should be embedded\nin the request as `input_content`. If set, `input_content` must be unset.\n\n### getInputContent\n\nThe video data bytes.\n\nIf unset, the input video(s) should be specified via the `input_uri`.\nIf set, `input_uri` must be unset.\n\n### setInputContent\n\nThe video data bytes.\n\nIf unset, the input video(s) should be specified via the `input_uri`.\nIf set, `input_uri` must be unset.\n\n### getFeatures\n\nRequired. Requested video annotation features.\n\n### setFeatures\n\nRequired. Requested video annotation features.\n\n### getVideoContext\n\nAdditional video context and/or feature-specific parameters.\n\n### hasVideoContext\n\n### clearVideoContext\n\n### setVideoContext\n\nAdditional video context and/or feature-specific parameters.\n\n### getOutputUri\n\nOptional. Location where the output (in JSON format) should be stored.\n\nCurrently, only [Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported. These must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\n[google.rpc.Code.INVALID_ARGUMENT](https://cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT)). For\nmore information, see [Request\nURIs](https://cloud.google.com/storage/docs/request-endpoints).\n\n### setOutputUri\n\nOptional. Location where the output (in JSON format) should be stored.\n\nCurrently, only [Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported. These must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\n[google.rpc.Code.INVALID_ARGUMENT](https://cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT)). For\nmore information, see [Request\nURIs](https://cloud.google.com/storage/docs/request-endpoints).\n\n### getLocationId\n\nOptional. Cloud region where annotation should take place. Supported cloud\nregions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no\nregion is specified, the region will be determined based on video file\nlocation.\n\n### setLocationId\n\nOptional. Cloud region where annotation should take place. Supported cloud\nregions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no\nregion is specified, the region will be determined based on video file\nlocation.\n\n### static::build"]]
