Class protos.google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults

Represents a VideoAnnotationResults.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.videointelligence.v1p3beta1.IVideoAnnotationResults);

Constructs a new VideoAnnotationResults.

Parameter
TypeNameDescription
IVideoAnnotationResultsproperties

Properties to set

Properties

celebrityRecognitionAnnotations

public celebrityRecognitionAnnotations?: (google.cloud.videointelligence.v1p3beta1.ICelebrityRecognitionAnnotation|null);

VideoAnnotationResults celebrityRecognitionAnnotations.

Property Value
TypeDescription
(google.cloud.videointelligence.v1p3beta1.ICelebrityRecognitionAnnotation|null)

error

public error?: (google.rpc.IStatus|null);

VideoAnnotationResults error.

Property Value
TypeDescription
(google.rpc.IStatus|null)

explicitAnnotation

public explicitAnnotation?: (google.cloud.videointelligence.v1p3beta1.IExplicitContentAnnotation|null);

VideoAnnotationResults explicitAnnotation.

Property Value
TypeDescription
(google.cloud.videointelligence.v1p3beta1.IExplicitContentAnnotation|null)

faceDetectionAnnotations

public faceDetectionAnnotations: google.cloud.videointelligence.v1p3beta1.IFaceDetectionAnnotation[];

VideoAnnotationResults faceDetectionAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.IFaceDetectionAnnotation[]

frameLabelAnnotations

public frameLabelAnnotations: google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[];

VideoAnnotationResults frameLabelAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[]

inputUri

public inputUri: string;

VideoAnnotationResults inputUri.

Property Value
TypeDescription
string

logoRecognitionAnnotations

public logoRecognitionAnnotations: google.cloud.videointelligence.v1p3beta1.ILogoRecognitionAnnotation[];

VideoAnnotationResults logoRecognitionAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ILogoRecognitionAnnotation[]

objectAnnotations

public objectAnnotations: google.cloud.videointelligence.v1p3beta1.IObjectTrackingAnnotation[];

VideoAnnotationResults objectAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.IObjectTrackingAnnotation[]

personDetectionAnnotations

public personDetectionAnnotations: google.cloud.videointelligence.v1p3beta1.IPersonDetectionAnnotation[];

VideoAnnotationResults personDetectionAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.IPersonDetectionAnnotation[]

segment

public segment?: (google.cloud.videointelligence.v1p3beta1.IVideoSegment|null);

VideoAnnotationResults segment.

Property Value
TypeDescription
(google.cloud.videointelligence.v1p3beta1.IVideoSegment|null)

segmentLabelAnnotations

public segmentLabelAnnotations: google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[];

VideoAnnotationResults segmentLabelAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[]

segmentPresenceLabelAnnotations

public segmentPresenceLabelAnnotations: google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[];

VideoAnnotationResults segmentPresenceLabelAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[]

shotAnnotations

public shotAnnotations: google.cloud.videointelligence.v1p3beta1.IVideoSegment[];

VideoAnnotationResults shotAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.IVideoSegment[]

shotLabelAnnotations

public shotLabelAnnotations: google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[];

VideoAnnotationResults shotLabelAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[]

shotPresenceLabelAnnotations

public shotPresenceLabelAnnotations: google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[];

VideoAnnotationResults shotPresenceLabelAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ILabelAnnotation[]

speechTranscriptions

public speechTranscriptions: google.cloud.videointelligence.v1p3beta1.ISpeechTranscription[];

VideoAnnotationResults speechTranscriptions.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ISpeechTranscription[]

textAnnotations

public textAnnotations: google.cloud.videointelligence.v1p3beta1.ITextAnnotation[];

VideoAnnotationResults textAnnotations.

Property Value
TypeDescription
google.cloud.videointelligence.v1p3beta1.ITextAnnotation[]

Methods

create(properties)

public static create(properties?: google.cloud.videointelligence.v1p3beta1.IVideoAnnotationResults): google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults;

Creates a new VideoAnnotationResults instance using the specified properties.

Parameter
TypeNameDescription
IVideoAnnotationResultsproperties

Properties to set

Returns
TypeDescription
google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults

VideoAnnotationResults instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults;

Decodes a VideoAnnotationResults message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults

VideoAnnotationResults

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults;

Decodes a VideoAnnotationResults message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults

VideoAnnotationResults

encode(message, writer)

public static encode(message: google.cloud.videointelligence.v1p3beta1.IVideoAnnotationResults, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VideoAnnotationResults message. Does not implicitly messages.

Parameters
TypeNameDescription
IVideoAnnotationResultsmessage

VideoAnnotationResults message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.videointelligence.v1p3beta1.IVideoAnnotationResults, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VideoAnnotationResults message, length delimited. Does not implicitly messages.

Parameters
TypeNameDescription
IVideoAnnotationResultsmessage

VideoAnnotationResults message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults;

Creates a VideoAnnotationResults message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults

VideoAnnotationResults

toJSON()

public toJSON(): { [k: string]: any };

Converts this VideoAnnotationResults to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.videointelligence.v1p3beta1.VideoAnnotationResults, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a VideoAnnotationResults message. Also converts values to other types if specified.

Parameters
TypeNameDescription
google.cloud.videointelligence.v1p3beta1.VideoAnnotationResultsmessage

VideoAnnotationResults

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a VideoAnnotationResults message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not