Face.State


class Face.State


The representation of the current state of Face.

Summary

Public functions

open operator Boolean
equals(other: Any?)
@FloatRange(from = 0.0, to = 1.0, fromInclusive = true, toInclusive = true) Float

Gets the confidence value of the face tracker for the given region.

open Int
open String

Public properties

Map<FaceBlendShapeTypeFloat>

Represents the blend shapes of the face.

TrackingState

the current TrackingState of the face.

Public functions

equals

open operator fun equals(other: Any?): Boolean

getConfidence

Added in 1.0.0-alpha09
fun getConfidence(region: FaceConfidenceRegion): @FloatRange(from = 0.0, to = 1.0, fromInclusive = true, toInclusive = true) Float

Gets the confidence value of the face tracker for the given region.

Parameters
region: FaceConfidenceRegion

the FaceConfidenceRegion to get the confidence value for.

Returns
@FloatRange(from = 0.0, to = 1.0, fromInclusive = true, toInclusive = true) Float

the confidence value in the range [0.0, 1.0] of the face tracker for the given region.

Throws
kotlin.IllegalArgumentException

if the region does not exist.

kotlin.IllegalStateException

if the Face does not provide confidence values.

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

blendShapes

Added in 1.0.0-alpha09
val blendShapesMap<FaceBlendShapeTypeFloat>

Represents the blend shapes of the face.

Returns
Map<FaceBlendShapeTypeFloat>

a map of FaceBlendShapeType to the corresponding blend shape value in the range [0.0, 1.0]. If the face does not provide blend shape values, this will be an empty map.

trackingState

Added in 1.0.0-alpha09
val trackingStateTrackingState

the current TrackingState of the face.