Class VideoAnnotationResults (3.0.0)

public sealed class VideoAnnotationResults : IMessage<VideoAnnotationResults>, IEquatable<VideoAnnotationResults>, IDeepCloneable<VideoAnnotationResults>, IBufferMessage, IMessage

Annotation results for a single video.

Inheritance

Object > VideoAnnotationResults

Namespace

Google.Cloud.VideoIntelligence.V1

Assembly

Google.Cloud.VideoIntelligence.V1.dll

Constructors

VideoAnnotationResults()

public VideoAnnotationResults()

VideoAnnotationResults(VideoAnnotationResults)

public VideoAnnotationResults(VideoAnnotationResults other)
Parameter
NameDescription
otherVideoAnnotationResults

Properties

Error

public Status Error { get; set; }

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

Property Value
TypeDescription
Status

ExplicitAnnotation

public ExplicitContentAnnotation ExplicitAnnotation { get; set; }

Explicit content annotation.

Property Value
TypeDescription
ExplicitContentAnnotation

FaceAnnotations

[Obsolete]
public RepeatedField<FaceAnnotation> FaceAnnotations { get; }

Deprecated. Please use face_detection_annotations instead.

Property Value
TypeDescription
RepeatedField<FaceAnnotation>

FaceDetectionAnnotations

public RepeatedField<FaceDetectionAnnotation> FaceDetectionAnnotations { get; }

Face detection annotations.

Property Value
TypeDescription
RepeatedField<FaceDetectionAnnotation>

FrameLabelAnnotations

public RepeatedField<LabelAnnotation> FrameLabelAnnotations { get; }

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

Property Value
TypeDescription
RepeatedField<LabelAnnotation>

InputUri

public string InputUri { get; set; }

Video file location in Cloud Storage.

Property Value
TypeDescription
String

LogoRecognitionAnnotations

public RepeatedField<LogoRecognitionAnnotation> LogoRecognitionAnnotations { get; }

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

Property Value
TypeDescription
RepeatedField<LogoRecognitionAnnotation>

ObjectAnnotations

public RepeatedField<ObjectTrackingAnnotation> ObjectAnnotations { get; }

Annotations for list of objects detected and tracked in video.

Property Value
TypeDescription
RepeatedField<ObjectTrackingAnnotation>

PersonDetectionAnnotations

public RepeatedField<PersonDetectionAnnotation> PersonDetectionAnnotations { get; }

Person detection annotations.

Property Value
TypeDescription
RepeatedField<PersonDetectionAnnotation>

Segment

public VideoSegment Segment { get; set; }

Video segment on which the annotation is run.

Property Value
TypeDescription
VideoSegment

SegmentLabelAnnotations

public RepeatedField<LabelAnnotation> SegmentLabelAnnotations { get; }

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

Property Value
TypeDescription
RepeatedField<LabelAnnotation>

SegmentPresenceLabelAnnotations

public RepeatedField<LabelAnnotation> SegmentPresenceLabelAnnotations { get; }

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.

Property Value
TypeDescription
RepeatedField<LabelAnnotation>

ShotAnnotations

public RepeatedField<VideoSegment> ShotAnnotations { get; }

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

Property Value
TypeDescription
RepeatedField<VideoSegment>

ShotLabelAnnotations

public RepeatedField<LabelAnnotation> ShotLabelAnnotations { get; }

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

Property Value
TypeDescription
RepeatedField<LabelAnnotation>

ShotPresenceLabelAnnotations

public RepeatedField<LabelAnnotation> ShotPresenceLabelAnnotations { get; }

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.

Property Value
TypeDescription
RepeatedField<LabelAnnotation>

SpeechTranscriptions

public RepeatedField<SpeechTranscription> SpeechTranscriptions { get; }

Speech transcription.

Property Value
TypeDescription
RepeatedField<SpeechTranscription>

TextAnnotations

public RepeatedField<TextAnnotation> TextAnnotations { get; }

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

Property Value
TypeDescription
RepeatedField<TextAnnotation>

Methods

ThrowOnError()

public VideoAnnotationResults ThrowOnError()

If the Error property is non-null, throws an AnnotateVideoException. Otherwise, returns this (so that the method can be called in a fluent manner).

Returns
TypeDescription
VideoAnnotationResults

this if the message has no error.

Exceptions
TypeDescription
AnnotateVideoException

The Error property is non-null.