Added in API level 21

Summary: Nested Classes | Constants | Methods | Inherited Methods

Face

Kotlin |Java

public final class Face
extends Object

java.lang.Object
↳	android.hardware.camera2.params.Face

Describes a face detected in an image.

Summary

Nested classes
`class`	`Face.Builder` Builds a Face object.

Constants
`int`	`ID_UNSUPPORTED` The ID is `-1` when the optional set of fields is unsupported.
`int`	`SCORE_MAX` The maximum possible value for the confidence level.
`int`	`SCORE_MIN` The minimum possible value for the confidence level.

Public methods
`Rect`	`getBounds()` Bounds of the face.
`int`	`getId()` An unique id per face while the face is visible to the tracker.
`Point`	`getLeftEyePosition()` The coordinates of the center of the left eye.
`Point`	`getMouthPosition()` The coordinates of the center of the mouth.
`Point`	`getRightEyePosition()` The coordinates of the center of the right eye.
`int`	`getScore()` The confidence level for the detection of the face.
`String`	`toString()` Represent the Face as a string for debugging purposes.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

ID_UNSUPPORTED

Added in API level 21

public static final int ID_UNSUPPORTED

The ID is -1 when the optional set of fields is unsupported.

See also:

getId()

Constant Value: -1 (0xffffffff)

SCORE_MAX

Added in API level 21

public static final int SCORE_MAX

The maximum possible value for the confidence level.

See also:

getScore()

Constant Value: 100 (0x00000064)

SCORE_MIN

Added in API level 21

public static final int SCORE_MIN

The minimum possible value for the confidence level.

See also:

getScore()

Constant Value: 1 (0x00000001)

Public methods

getBounds

Added in API level 21

public Rect getBounds ()

Bounds of the face.

A rectangle relative to the sensor's CameraCharacteristics.SENSOR_INFO_ACTIVE_ARRAY_SIZE, with (0,0) representing the top-left corner of the active array rectangle.

There is no constraints on the Rectangle value other than it is not-null.

Returns
`Rect`

getId

Added in API level 21

public int getId ()

An unique id per face while the face is visible to the tracker.

If the face leaves the field-of-view and comes back, it will get a new id.

This is an optional field and may not be supported on all devices. If the id is .ID_UNSUPPORTED then the leftEyePosition, rightEyePosition, and mouthPositions are guaranteed to be null. Otherwise, each of leftEyePosition, rightEyePosition, and mouthPosition may be independently null or not-null. When devices report the value of key CaptureResult.STATISTICS_FACE_DETECT_MODE as CameraMetadata.STATISTICS_FACE_DETECT_MODE_SIMPLE in CaptureResult, the face id of each face is expected to be .ID_UNSUPPORTED.

This value will either be .ID_UNSUPPORTED or otherwise greater than 0.

Returns
`int`

See also:

ID_UNSUPPORTED

getLeftEyePosition

Added in API level 21

public Point getLeftEyePosition ()

The coordinates of the center of the left eye.

The coordinates are in the same space as the ones for getBounds(). This is an optional field and may not be supported on all devices. If not supported, the value will always be set to null. This value will always be null only if getId() returns .ID_UNSUPPORTED.

Returns
`Point`	The left eye position, or `null` if unknown.

getMouthPosition

Added in API level 21

public Point getMouthPosition ()

The coordinates of the center of the mouth.

Returns
`Point`	The mouth position, or `null` if unknown.

getRightEyePosition

Added in API level 21

public Point getRightEyePosition ()

The coordinates of the center of the right eye.

The coordinates are in the same space as the ones for getBounds().This is an optional field and may not be supported on all devices. If not supported, the value will always be set to null. This value will always be null only if getId() returns .ID_UNSUPPORTED.

Returns
`Point`	The right eye position, or `null` if unknown.

getScore

Added in API level 21

public int getScore ()

The confidence level for the detection of the face.

The range is .SCORE_MIN to .SCORE_MAX. .SCORE_MAX is the highest confidence.

Depending on the device, even very low-confidence faces may be listed, so applications should filter out faces with low confidence, depending on the use case. For a typical point-and-shoot camera application that wishes to display rectangles around detected faces, filtering out faces with confidence less than half of .SCORE_MAX is recommended.

Returns
`int`	Value is between `SCORE_MIN` and `SCORE_MAX` inclusive

See also:

SCORE_MAX
SCORE_MIN

toString

Added in API level 21

public String toString ()

Represent the Face as a string for debugging purposes.

Returns
`String`	a string representation of the object.

Face

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

ID_UNSUPPORTED

SCORE_MAX

SCORE_MIN

Public methods

getBounds

getId

getLeftEyePosition

getMouthPosition

getRightEyePosition

getScore

toString