Class protos.google.cloud.videointelligence.v1beta2.LabelAnnotation (3.3.6)

Version 3.3.6

• 5.0.2 (latest)
• 5.0.0
• 4.2.2
• 4.1.1
• 3.4.1
• 3.3.6
• 3.1.0
• 3.0.0

Represents a LabelAnnotation.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.videointelligence.v1beta2.ILabelAnnotation);

Constructs a new LabelAnnotation.

Parameter

Name	Description
properties	ILabelAnnotation Properties to set

Properties

categoryEntities

public categoryEntities: google.cloud.videointelligence.v1beta2.IEntity[];

LabelAnnotation categoryEntities.

Property Value

Type	Description
google.cloud.videointelligence.v1beta2.IEntity[]

entity

public entity?: (google.cloud.videointelligence.v1beta2.IEntity|null);

LabelAnnotation entity.

Property Value

Type	Description
(google.cloud.videointelligence.v1beta2.IEntity|null)

frames

public frames: google.cloud.videointelligence.v1beta2.ILabelFrame[];

LabelAnnotation frames.

Property Value

Type	Description
google.cloud.videointelligence.v1beta2.ILabelFrame[]

segments

public segments: google.cloud.videointelligence.v1beta2.ILabelSegment[];

LabelAnnotation segments.

Property Value

Type	Description
google.cloud.videointelligence.v1beta2.ILabelSegment[]

Methods

create(properties)

public static create(properties?: google.cloud.videointelligence.v1beta2.ILabelAnnotation): google.cloud.videointelligence.v1beta2.LabelAnnotation;

Creates a new LabelAnnotation instance using the specified properties.

Parameter

Name	Description
properties	ILabelAnnotation Properties to set

Returns

Type	Description
google.cloud.videointelligence.v1beta2.LabelAnnotation	LabelAnnotation instance

decode(reader, length)

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

Decodes a LabelAnnotation 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.v1beta2.LabelAnnotation	LabelAnnotation

decodeDelimited(reader)

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

Decodes a LabelAnnotation 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.v1beta2.LabelAnnotation	LabelAnnotation

encode(message, writer)

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

Encodes the specified LabelAnnotation message. Does not implicitly messages.

Parameters

Name	Description
message	ILabelAnnotation LabelAnnotation 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.v1beta2.ILabelAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	ILabelAnnotation LabelAnnotation 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.v1beta2.LabelAnnotation;

Creates a LabelAnnotation 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.v1beta2.LabelAnnotation	LabelAnnotation

toJSON()

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

Converts this LabelAnnotation to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.videointelligence.v1beta2.LabelAnnotation LabelAnnotation
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 LabelAnnotation 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