Class protos.google.cloud.videointelligence.v1.ObjectTrackingAnnotation (3.1.0)

Represents an ObjectTrackingAnnotation.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.videointelligence.v1.IObjectTrackingAnnotation);

Constructs a new ObjectTrackingAnnotation.

Parameter

Name	Description
properties	`IObjectTrackingAnnotation` Properties to set

Properties

confidence

public confidence: number;

ObjectTrackingAnnotation confidence.

Property Value

Type	Description
number

entity

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

ObjectTrackingAnnotation entity.

Property Value

Type	Description
(google.cloud.videointelligence.v1.IEntity\|null)

frames

public frames: google.cloud.videointelligence.v1.IObjectTrackingFrame[];

ObjectTrackingAnnotation frames.

Property Value

Type	Description
google.cloud.videointelligence.v1.IObjectTrackingFrame[]

segment

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

ObjectTrackingAnnotation segment.

Property Value

Type	Description
(google.cloud.videointelligence.v1.IVideoSegment\|null)

trackId

public trackId?: (number|Long|string|null);

ObjectTrackingAnnotation trackId.

Property Value

Type	Description
(number\|Long\|string\|null)

trackInfo

public trackInfo?: ("segment"|"trackId");

ObjectTrackingAnnotation trackInfo.

Property Value

Type	Description
("segment"\|"trackId")

version

public version: string;

ObjectTrackingAnnotation version.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.videointelligence.v1.IObjectTrackingAnnotation): google.cloud.videointelligence.v1.ObjectTrackingAnnotation;

Creates a new ObjectTrackingAnnotation instance using the specified properties.

Parameter

Name	Description
properties	`IObjectTrackingAnnotation` Properties to set

Returns

Type	Description
google.cloud.videointelligence.v1.ObjectTrackingAnnotation	ObjectTrackingAnnotation instance

decode(reader, length)

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

Decodes an ObjectTrackingAnnotation 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.v1.ObjectTrackingAnnotation	ObjectTrackingAnnotation

decodeDelimited(reader)

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

Decodes an ObjectTrackingAnnotation 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.v1.ObjectTrackingAnnotation	ObjectTrackingAnnotation

encode(message, writer)

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

Encodes the specified ObjectTrackingAnnotation message. Does not implicitly messages.

Parameters

Name	Description
message	`IObjectTrackingAnnotation` ObjectTrackingAnnotation 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.v1.IObjectTrackingAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IObjectTrackingAnnotation` ObjectTrackingAnnotation 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.v1.ObjectTrackingAnnotation;

Creates an ObjectTrackingAnnotation 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.v1.ObjectTrackingAnnotation	ObjectTrackingAnnotation

toJSON()

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

Converts this ObjectTrackingAnnotation to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.videointelligence.v1.ObjectTrackingAnnotation` ObjectTrackingAnnotation
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 an ObjectTrackingAnnotation 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