class AnnotateVideoRequest extends Message

Video annotation request.

Protobuf type Google\Cloud\Videointelligence\V1beta1\AnnotateVideoRequest

Methods

__construct()

No description

string
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][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

setInputUri(string $var)

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][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

string
getInputContent()

The video data bytes. Encoding: base64. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

setInputContent(string $var)

The video data bytes. Encoding: base64. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

RepeatedField
getFeatures()

Requested video annotation features.

setFeatures(array|RepeatedField $var)

Requested video annotation features.

getVideoContext()

Additional video context and/or feature-specific parameters.

setVideoContext(VideoContext $var)

Additional video context and/or feature-specific parameters.

string
getOutputUri()

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

setOutputUri(string $var)

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

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

setLocationId(string $var)

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.

Details

at line 72
__construct()

at line 92
string 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][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.

Generated from protobuf field string input_uri = 1;

Return Value

string

at line 112
setInputUri(string $var)

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

Generated from protobuf field string input_uri = 1;

Parameters

string $var

at line 125
string getInputContent()

The video data bytes. Encoding: base64. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

Generated from protobuf field string input_content = 6;

Return Value

string

at line 137
setInputContent(string $var)

The video data bytes. Encoding: base64. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

Generated from protobuf field string input_content = 6;

Parameters

string $var

at line 149
RepeatedField getFeatures()

Requested video annotation features.

Generated from protobuf field repeated .google.cloud.videointelligence.v1beta1.Feature features = 2;

Return Value

RepeatedField

at line 160
setFeatures(array|RepeatedField $var)

Requested video annotation features.

Generated from protobuf field repeated .google.cloud.videointelligence.v1beta1.Feature features = 2;

Parameters

array|RepeatedField $var

at line 172
VideoContext getVideoContext()

Additional video context and/or feature-specific parameters.

Generated from protobuf field .google.cloud.videointelligence.v1beta1.VideoContext video_context = 3;

Return Value

VideoContext

at line 183
setVideoContext(VideoContext $var)

Additional video context and/or feature-specific parameters.

Generated from protobuf field .google.cloud.videointelligence.v1beta1.VideoContext video_context = 3;

Parameters

VideoContext $var

at line 200
string 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][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

Generated from protobuf field string output_uri = 4;

Return Value

string

at line 216
setOutputUri(string $var)

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][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

Generated from protobuf field string output_uri = 4;

Parameters

string $var

at line 230
string 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.

Generated from protobuf field string location_id = 5;

Return Value

string

at line 243
setLocationId(string $var)

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.

Generated from protobuf field string location_id = 5;

Parameters

string $var