Builder

Builder

Builder()

Builder

Builder(current: Face)

build

fun build(): Face

Returns an instance of Face created from the fields set on this builder.

setBounds

fun setBounds(bounds: Rect): Face.Builder

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.

setId

fun setId(id: Int): Face.Builder

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 {@value #ID_UNSUPPORTED} then the leftEyePosition, rightEyePosition, and mouthPositions should 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 {@value #ID_UNSUPPORTED}.

This value should either be {@value #ID_UNSUPPORTED} or otherwise greater than 0.

setLeftEyePosition

fun setLeftEyePosition(leftEyePosition: Point): Face.Builder

The coordinates of the center of the left eye.

The coordinates should be in the same space as the ones for setBounds. This is an optional field and may not be supported on all devices. If not supported, the value should always be unset or set to null. This value should always be null if setId is called with {@value #ID_UNSUPPORTED}.

setMouthPosition

fun setMouthPosition(mouthPosition: Point): Face.Builder

The coordinates of the center of the mouth.

The coordinates should be in the same space as the ones for setBounds. This is an optional field and may not be supported on all devices. If not supported, the value should always be set to null. This value should always be null if setId is called with {@value #ID_UNSUPPORTED}.

setRightEyePosition

fun setRightEyePosition(rightEyePosition: Point): Face.Builder

The coordinates of the center of the right eye.

The coordinates should be in the same space as the ones for setBounds.This is an optional field and may not be supported on all devices. If not supported, the value should always be set to null. This value should always be null if setId is called with {@value #ID_UNSUPPORTED}.

setScore

fun setScore(score: Int): Face.Builder

The confidence level for the detection of the face.

The range is {@value #SCORE_MIN} to {@value #SCORE_MAX}. {@value #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 {@value #SCORE_MAX} is recommended.