Cloud Video Intelligence V1beta2 Client - Class VideoAnnotationResults (1.15.4)

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

Annotation results for a single video.

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

Namespace

Google \ Cloud \ VideoIntelligence \ V1beta2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ input_uri string

Video file location in Google Cloud Storage.

↳ segment_label_annotations array<Google\Cloud\VideoIntelligence\V1beta2\LabelAnnotation>

Label annotations on video level or user specified segment level. There is exactly one element for each unique label.

↳ shot_label_annotations array<Google\Cloud\VideoIntelligence\V1beta2\LabelAnnotation>

Label annotations on shot level. There is exactly one element for each unique label.

↳ frame_label_annotations array<Google\Cloud\VideoIntelligence\V1beta2\LabelAnnotation>

Label annotations on frame level. There is exactly one element for each unique label.

↳ face_annotations array<Google\Cloud\VideoIntelligence\V1beta2\FaceAnnotation>

Face annotations. There is exactly one element for each unique face.

↳ shot_annotations array<Google\Cloud\VideoIntelligence\V1beta2\VideoSegment>

Shot annotations. Each shot is represented as a video segment.

↳ explicit_annotation Google\Cloud\VideoIntelligence\V1beta2\ExplicitContentAnnotation

Explicit content annotation.

↳ error Google\Rpc\Status

If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

getInputUri

Video file location in Google Cloud Storage.

Returns
Type Description
string

setInputUri

Video file location in Google Cloud Storage.

Parameter
Name Description
var string
Returns
Type Description
$this

getSegmentLabelAnnotations

Label annotations on video level or user specified segment level.

There is exactly one element for each unique label.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSegmentLabelAnnotations

Label annotations on video level or user specified segment level.

There is exactly one element for each unique label.

Parameter
Name Description
var array<Google\Cloud\VideoIntelligence\V1beta2\LabelAnnotation>
Returns
Type Description
$this

getShotLabelAnnotations

Label annotations on shot level.

There is exactly one element for each unique label.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setShotLabelAnnotations

Label annotations on shot level.

There is exactly one element for each unique label.

Parameter
Name Description
var array<Google\Cloud\VideoIntelligence\V1beta2\LabelAnnotation>
Returns
Type Description
$this

getFrameLabelAnnotations

Label annotations on frame level.

There is exactly one element for each unique label.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFrameLabelAnnotations

Label annotations on frame level.

There is exactly one element for each unique label.

Parameter
Name Description
var array<Google\Cloud\VideoIntelligence\V1beta2\LabelAnnotation>
Returns
Type Description
$this

getFaceAnnotations

Face annotations. There is exactly one element for each unique face.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFaceAnnotations

Face annotations. There is exactly one element for each unique face.

Parameter
Name Description
var array<Google\Cloud\VideoIntelligence\V1beta2\FaceAnnotation>
Returns
Type Description
$this

getShotAnnotations

Shot annotations. Each shot is represented as a video segment.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setShotAnnotations

Shot annotations. Each shot is represented as a video segment.

Parameter
Name Description
var array<Google\Cloud\VideoIntelligence\V1beta2\VideoSegment>
Returns
Type Description
$this

getExplicitAnnotation

Explicit content annotation.

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

hasExplicitAnnotation

clearExplicitAnnotation

setExplicitAnnotation

Explicit content annotation.

Parameter
Name Description
var Google\Cloud\VideoIntelligence\V1beta2\ExplicitContentAnnotation
Returns
Type Description
$this

getError

If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this