Cloud Video Intelligence V1 API - Class Google::Cloud::VideoIntelligence::V1::VideoAnnotationResults (v1.0.0)

Reference documentation and code samples for the Cloud Video Intelligence V1 API class Google::Cloud::VideoIntelligence::V1::VideoAnnotationResults.

Annotation results for a single video.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#error

def error() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

#error=

def error=(value) -> ::Google::Rpc::Status

Parameter

value (::Google::Rpc::Status) — If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

Returns

(::Google::Rpc::Status) — If set, indicates an error. Note that for a single AnnotateVideoRequest some videos may succeed and some may fail.

#explicit_annotation

def explicit_annotation() -> ::Google::Cloud::VideoIntelligence::V1::ExplicitContentAnnotation

Returns

(::Google::Cloud::VideoIntelligence::V1::ExplicitContentAnnotation) — Explicit content annotation.

#explicit_annotation=

def explicit_annotation=(value) -> ::Google::Cloud::VideoIntelligence::V1::ExplicitContentAnnotation

Parameter

value (::Google::Cloud::VideoIntelligence::V1::ExplicitContentAnnotation) — Explicit content annotation.

Returns

(::Google::Cloud::VideoIntelligence::V1::ExplicitContentAnnotation) — Explicit content annotation.

#face_annotations

def face_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::FaceAnnotation>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::FaceAnnotation>) — Deprecated. Please use face_detection_annotations instead.

#face_annotations=

def face_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::FaceAnnotation>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::FaceAnnotation>) — Deprecated. Please use face_detection_annotations instead.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::FaceAnnotation>) — Deprecated. Please use face_detection_annotations instead.

#face_detection_annotations

def face_detection_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::FaceDetectionAnnotation>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::FaceDetectionAnnotation>) — Face detection annotations.

#face_detection_annotations=

def face_detection_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::FaceDetectionAnnotation>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::FaceDetectionAnnotation>) — Face detection annotations.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::FaceDetectionAnnotation>) — Face detection annotations.

#frame_label_annotations

def frame_label_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>) — Label annotations on frame level. There is exactly one element for each unique label.

#frame_label_annotations=

def frame_label_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>) — Label annotations on frame level. There is exactly one element for each unique label.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>) — Label annotations on frame level. There is exactly one element for each unique label.

#input_uri

def input_uri() -> ::String

Returns

(::String) — Video file location in Cloud Storage.

#input_uri=

def input_uri=(value) -> ::String

Parameter

value (::String) — Video file location in Cloud Storage.

Returns

(::String) — Video file location in Cloud Storage.

#logo_recognition_annotations

def logo_recognition_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::LogoRecognitionAnnotation>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::LogoRecognitionAnnotation>) — Annotations for list of logos detected, tracked and recognized in video.

#logo_recognition_annotations=

def logo_recognition_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::LogoRecognitionAnnotation>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::LogoRecognitionAnnotation>) — Annotations for list of logos detected, tracked and recognized in video.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::LogoRecognitionAnnotation>) — Annotations for list of logos detected, tracked and recognized in video.

#object_annotations

def object_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::ObjectTrackingAnnotation>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::ObjectTrackingAnnotation>) — Annotations for list of objects detected and tracked in video.

#object_annotations=

def object_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::ObjectTrackingAnnotation>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::ObjectTrackingAnnotation>) — Annotations for list of objects detected and tracked in video.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::ObjectTrackingAnnotation>) — Annotations for list of objects detected and tracked in video.

#person_detection_annotations

def person_detection_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::PersonDetectionAnnotation>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::PersonDetectionAnnotation>) — Person detection annotations.

#person_detection_annotations=

def person_detection_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::PersonDetectionAnnotation>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::PersonDetectionAnnotation>) — Person detection annotations.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::PersonDetectionAnnotation>) — Person detection annotations.

#segment

def segment() -> ::Google::Cloud::VideoIntelligence::V1::VideoSegment

Returns

(::Google::Cloud::VideoIntelligence::V1::VideoSegment) — Video segment on which the annotation is run.

#segment=

def segment=(value) -> ::Google::Cloud::VideoIntelligence::V1::VideoSegment

Parameter

value (::Google::Cloud::VideoIntelligence::V1::VideoSegment) — Video segment on which the annotation is run.

Returns

(::Google::Cloud::VideoIntelligence::V1::VideoSegment) — Video segment on which the annotation is run.

#segment_label_annotations

def segment_label_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Returns

(::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_label_annotations=

def segment_label_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Parameter

value (::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.

Returns

(::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

def segment_presence_label_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Returns

(::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.

#segment_presence_label_annotations=

def segment_presence_label_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Parameter

value (::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.

Returns

(::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_annotations

def shot_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::VideoSegment>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::VideoSegment>) — Shot annotations. Each shot is represented as a video segment.

#shot_annotations=

def shot_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::VideoSegment>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::VideoSegment>) — Shot annotations. Each shot is represented as a video segment.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::VideoSegment>) — Shot annotations. Each shot is represented as a video segment.

#shot_label_annotations

def shot_label_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>) — Topical label annotations on shot level. There is exactly one element for each unique label.

#shot_label_annotations=

def shot_label_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>) — Topical label annotations on shot level. There is exactly one element for each unique label.

Returns

(::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

def shot_presence_label_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Returns

(::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.

#shot_presence_label_annotations=

def shot_presence_label_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::LabelAnnotation>

Parameter

value (::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.

Returns

(::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.

#speech_transcriptions

def speech_transcriptions() -> ::Array<::Google::Cloud::VideoIntelligence::V1::SpeechTranscription>

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::SpeechTranscription>) — Speech transcription.

#speech_transcriptions=

def speech_transcriptions=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::SpeechTranscription>

Parameter

value (::Array<::Google::Cloud::VideoIntelligence::V1::SpeechTranscription>) — Speech transcription.

Returns

(::Array<::Google::Cloud::VideoIntelligence::V1::SpeechTranscription>) — Speech transcription.

#text_annotations

def text_annotations() -> ::Array<::Google::Cloud::VideoIntelligence::V1::TextAnnotation>

Returns

(::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.

#text_annotations=

def text_annotations=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1::TextAnnotation>

Parameter

value (::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.

Returns

(::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.