Class protos.google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults (3.0.0)

Represents a VideoAnnotationResults.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

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

Constructs a new VideoAnnotationResults.

Parameter

Name	Description
properties	`IVideoAnnotationResults` Properties to set

Properties

error

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

VideoAnnotationResults error.

Property Value

Type	Description
(google.rpc.IStatus\|null)

explicitAnnotation

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

VideoAnnotationResults explicitAnnotation.

Property Value

Type	Description
(google.cloud.videointelligence.v1p2beta1.IExplicitContentAnnotation\|null)

frameLabelAnnotations

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

VideoAnnotationResults frameLabelAnnotations.

Property Value

Type	Description
google.cloud.videointelligence.v1p2beta1.ILabelAnnotation[]

inputUri

public inputUri: string;

VideoAnnotationResults inputUri.

Property Value

Type	Description
string

objectAnnotations

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

VideoAnnotationResults objectAnnotations.

Property Value

Type	Description
google.cloud.videointelligence.v1p2beta1.IObjectTrackingAnnotation[]

segmentLabelAnnotations

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

VideoAnnotationResults segmentLabelAnnotations.

Property Value

Type	Description
google.cloud.videointelligence.v1p2beta1.ILabelAnnotation[]

shotAnnotations

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

VideoAnnotationResults shotAnnotations.

Property Value

Type	Description
google.cloud.videointelligence.v1p2beta1.IVideoSegment[]

shotLabelAnnotations

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

VideoAnnotationResults shotLabelAnnotations.

Property Value

Type	Description
google.cloud.videointelligence.v1p2beta1.ILabelAnnotation[]

textAnnotations

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

VideoAnnotationResults textAnnotations.

Property Value

Type	Description
google.cloud.videointelligence.v1p2beta1.ITextAnnotation[]

Methods

create(properties)

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

Creates a new VideoAnnotationResults instance using the specified properties.

Parameter

Name	Description
properties	`IVideoAnnotationResults` Properties to set

Returns

Type	Description
google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults	VideoAnnotationResults instance

decode(reader, length)

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

Decodes a VideoAnnotationResults message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults	VideoAnnotationResults

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults	VideoAnnotationResults

encode(message, writer)

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

Encodes the specified VideoAnnotationResults message. Does not implicitly messages.

Parameters

Name	Description
message	`IVideoAnnotationResults` VideoAnnotationResults message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Name	Description
message	`IVideoAnnotationResults` VideoAnnotationResults message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

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

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

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults	VideoAnnotationResults

toJSON()

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

Converts this VideoAnnotationResults to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.videointelligence.v1p2beta1.VideoAnnotationResults` VideoAnnotationResults
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies a VideoAnnotationResults message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not