Class protos.google.cloud.videointelligence.v1.FaceAnnotation (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 FaceAnnotation.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

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

Constructs a new FaceAnnotation.

Parameter

Name	Description
properties	IFaceAnnotation Properties to set

Properties

frames

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

FaceAnnotation frames.

Property Value

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

segments

public segments: google.cloud.videointelligence.v1.IFaceSegment[];

FaceAnnotation segments.

Property Value

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

thumbnail

public thumbnail: (Uint8Array|string);

FaceAnnotation thumbnail.

Property Value

Type	Description
(Uint8Array|string)

Methods

create(properties)

public static create(properties?: google.cloud.videointelligence.v1.IFaceAnnotation): google.cloud.videointelligence.v1.FaceAnnotation;

Creates a new FaceAnnotation instance using the specified properties.

Parameter

Name	Description
properties	IFaceAnnotation Properties to set

Returns

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

decode(reader, length)

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

Decodes a FaceAnnotation 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.FaceAnnotation	FaceAnnotation

decodeDelimited(reader)

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

Decodes a FaceAnnotation 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.FaceAnnotation	FaceAnnotation

encode(message, writer)

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

Encodes the specified FaceAnnotation message. Does not implicitly messages.

Parameters

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

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

Parameters

Name	Description
message	IFaceAnnotation FaceAnnotation 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.FaceAnnotation;

Creates a FaceAnnotation 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.FaceAnnotation	FaceAnnotation

toJSON()

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

Converts this FaceAnnotation to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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