Class protos.google.cloud.vision.v1p1beta1.FaceAnnotation (4.0.3)

Represents a FaceAnnotation.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1p1beta1.IFaceAnnotation);

Constructs a new FaceAnnotation.

Parameter
Name Description
properties IFaceAnnotation

Properties to set

Properties

angerLikelihood

public angerLikelihood: (google.cloud.vision.v1p1beta1.Likelihood|keyof typeof google.cloud.vision.v1p1beta1.Likelihood);

FaceAnnotation angerLikelihood.

blurredLikelihood

public blurredLikelihood: (google.cloud.vision.v1p1beta1.Likelihood|keyof typeof google.cloud.vision.v1p1beta1.Likelihood);

FaceAnnotation blurredLikelihood.

boundingPoly

public boundingPoly?: (google.cloud.vision.v1p1beta1.IBoundingPoly|null);

FaceAnnotation boundingPoly.

detectionConfidence

public detectionConfidence: number;

FaceAnnotation detectionConfidence.

fdBoundingPoly

public fdBoundingPoly?: (google.cloud.vision.v1p1beta1.IBoundingPoly|null);

FaceAnnotation fdBoundingPoly.

headwearLikelihood

public headwearLikelihood: (google.cloud.vision.v1p1beta1.Likelihood|keyof typeof google.cloud.vision.v1p1beta1.Likelihood);

FaceAnnotation headwearLikelihood.

joyLikelihood

public joyLikelihood: (google.cloud.vision.v1p1beta1.Likelihood|keyof typeof google.cloud.vision.v1p1beta1.Likelihood);

FaceAnnotation joyLikelihood.

landmarkingConfidence

public landmarkingConfidence: number;

FaceAnnotation landmarkingConfidence.

landmarks

public landmarks: google.cloud.vision.v1p1beta1.FaceAnnotation.ILandmark[];

FaceAnnotation landmarks.

panAngle

public panAngle: number;

FaceAnnotation panAngle.

rollAngle

public rollAngle: number;

FaceAnnotation rollAngle.

sorrowLikelihood

public sorrowLikelihood: (google.cloud.vision.v1p1beta1.Likelihood|keyof typeof google.cloud.vision.v1p1beta1.Likelihood);

FaceAnnotation sorrowLikelihood.

surpriseLikelihood

public surpriseLikelihood: (google.cloud.vision.v1p1beta1.Likelihood|keyof typeof google.cloud.vision.v1p1beta1.Likelihood);

FaceAnnotation surpriseLikelihood.

tiltAngle

public tiltAngle: number;

FaceAnnotation tiltAngle.

underExposedLikelihood

public underExposedLikelihood: (google.cloud.vision.v1p1beta1.Likelihood|keyof typeof google.cloud.vision.v1p1beta1.Likelihood);

FaceAnnotation underExposedLikelihood.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1p1beta1.IFaceAnnotation): google.cloud.vision.v1p1beta1.FaceAnnotation;

Creates a new FaceAnnotation instance using the specified properties.

Parameter
Name Description
properties IFaceAnnotation

Properties to set
Returns
Type Description
FaceAnnotation

FaceAnnotation instance

decode(reader, length)

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

Decodes a FaceAnnotation message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
FaceAnnotation

FaceAnnotation

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
FaceAnnotation

FaceAnnotation

encode(message, writer)

public static encode(message: google.cloud.vision.v1p1beta1.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.vision.v1p1beta1.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.vision.v1p1beta1.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
FaceAnnotation

FaceAnnotation

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for FaceAnnotation

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

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.vision.v1p1beta1.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 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