Cloud Video Intelligence V1 Client - Class VideoAnnotationResults (1.14.2)

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

Annotation results for a single video.

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

Namespace

Google \ Cloud \ VideoIntelligence \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ input_uri
string

Video file location in Cloud Storage .

↳ segment
Google\Cloud\VideoIntelligence\V1\VideoSegment

Video segment on which the annotation is run.

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

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

↳ segment_presence_label_annotations
array< Google\Cloud\VideoIntelligence\V1\LabelAnnotation >

Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical segment_label_annotations , this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets LabelDetectionConfig.model to "builtin/latest" in the request.

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

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

↳ shot_presence_label_annotations
array< Google\Cloud\VideoIntelligence\V1\LabelAnnotation >

Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical shot_label_annotations , this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets LabelDetectionConfig.model to "builtin/latest" in the request.

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

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

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

Deprecated. Please use face_detection_annotations instead.

↳ face_detection_annotations
array< Google\Cloud\VideoIntelligence\V1\FaceDetectionAnnotation >

Face detection annotations.

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

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

↳ explicit_annotation
↳ speech_transcriptions
↳ text_annotations
array< Google\Cloud\VideoIntelligence\V1\TextAnnotation >

OCR text detection and tracking. Annotations for list of detected text snippets. Each will have list of frame information associated with it.

↳ object_annotations
array< Google\Cloud\VideoIntelligence\V1\ObjectTrackingAnnotation >

Annotations for list of objects detected and tracked in video.

↳ logo_recognition_annotations
array< Google\Cloud\VideoIntelligence\V1\LogoRecognitionAnnotation >

Annotations for list of logos detected, tracked and recognized in video.

↳ person_detection_annotations
array< Google\Cloud\VideoIntelligence\V1\PersonDetectionAnnotation >

Person detection annotations.

↳ 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 Cloud Storage .

Returns
Type
Description
string

setInputUri

Video file location in Cloud Storage .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSegment

Video segment on which the annotation is run.

Returns
Type
Description

hasSegment

clearSegment

setSegment

Video segment on which the annotation is run.

Parameter
Name
Description
Returns
Type
Description
$this

getSegmentLabelAnnotations

Topical label annotations on video level or user-specified segment level.

There is exactly one element for each unique label.

Returns
Type
Description

setSegmentLabelAnnotations

Topical label annotations on video level or user-specified segment level.

There is exactly one element for each unique label.

Parameter
Name
Description
Returns
Type
Description
$this

getSegmentPresenceLabelAnnotations

Presence label annotations on video level or user-specified segment level.

There is exactly one element for each unique label. Compared to the existing topical segment_label_annotations , this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets LabelDetectionConfig.model to "builtin/latest" in the request.

Returns
Type
Description

setSegmentPresenceLabelAnnotations

Presence label annotations on video level or user-specified segment level.

There is exactly one element for each unique label. Compared to the existing topical segment_label_annotations , this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets LabelDetectionConfig.model to "builtin/latest" in the request.

Parameter
Name
Description
Returns
Type
Description
$this

getShotLabelAnnotations

Topical label annotations on shot level.

There is exactly one element for each unique label.

Returns
Type
Description

setShotLabelAnnotations

Topical label annotations on shot level.

There is exactly one element for each unique label.

Parameter
Name
Description
Returns
Type
Description
$this

getShotPresenceLabelAnnotations

Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical shot_label_annotations , this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets LabelDetectionConfig.model to "builtin/latest" in the request.

Returns
Type
Description

setShotPresenceLabelAnnotations

Presence label annotations on shot level. There is exactly one element for each unique label. Compared to the existing topical shot_label_annotations , this field presents more fine-grained, shot-level labels detected in video content and is made available only when the client sets LabelDetectionConfig.model to "builtin/latest" in the request.

Parameter
Name
Description
Returns
Type
Description
$this

getFrameLabelAnnotations

Label annotations on frame level.

There is exactly one element for each unique label.

Returns
Type
Description

setFrameLabelAnnotations

Label annotations on frame level.

There is exactly one element for each unique label.

Parameter
Name
Description
Returns
Type
Description
$this

getFaceAnnotations

Deprecated. Please use face_detection_annotations instead.

Returns
Type
Description

setFaceAnnotations

Deprecated. Please use face_detection_annotations instead.

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

getFaceDetectionAnnotations

Face detection annotations.

Returns
Type
Description

setFaceDetectionAnnotations

Face detection annotations.

Parameter
Name
Description
Returns
Type
Description
$this

getShotAnnotations

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

Returns
Type
Description

setShotAnnotations

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

Parameter
Name
Description
Returns
Type
Description
$this

getExplicitAnnotation

Explicit content annotation.

hasExplicitAnnotation

clearExplicitAnnotation

setExplicitAnnotation

Explicit content annotation.

Returns
Type
Description
$this

getSpeechTranscriptions

Speech transcription.

Returns
Type
Description

setSpeechTranscriptions

Speech transcription.

Parameter
Name
Description
Returns
Type
Description
$this

getTextAnnotations

OCR text detection and tracking.

Annotations for list of detected text snippets. Each will have list of frame information associated with it.

Returns
Type
Description

setTextAnnotations

OCR text detection and tracking.

Annotations for list of detected text snippets. Each will have list of frame information associated with it.

Parameter
Name
Description
Returns
Type
Description
$this

getObjectAnnotations

Annotations for list of objects detected and tracked in video.

Returns
Type
Description

setObjectAnnotations

Annotations for list of objects detected and tracked in video.

Parameter
Name
Description
Returns
Type
Description
$this

getLogoRecognitionAnnotations

Annotations for list of logos detected, tracked and recognized in video.

Returns
Type
Description

setLogoRecognitionAnnotations

Annotations for list of logos detected, tracked and recognized in video.

Parameter
Name
Description
Returns
Type
Description
$this

getPersonDetectionAnnotations

Person detection annotations.

Returns
Type
Description

setPersonDetectionAnnotations

Person detection annotations.

Parameter
Name
Description
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

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
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: