Added in API level 1

FaceDetector

open class FaceDetector
kotlin.Any
   ↳ android.media.FaceDetector

Identifies the faces of people in a android.graphics.Bitmap graphic object.

Summary

Nested classes
open

A Face contains all the information identifying the location of a face in a bitmap.

Public constructors
FaceDetector(width: Int, height: Int, maxFaces: Int)

Creates a FaceDetector, configured with the size of the images to be analysed and the maximum number of faces that can be detected.

Public methods
open Int
findFaces(bitmap: Bitmap!, faces: Array<FaceDetector.Face!>!)

Finds all the faces found in a given android.graphics.Bitmap.

Protected methods
open Unit

Public constructors

FaceDetector

Added in API level 1
FaceDetector(
    width: Int,
    height: Int,
    maxFaces: Int)

Creates a FaceDetector, configured with the size of the images to be analysed and the maximum number of faces that can be detected. These parameters cannot be changed once the object is constructed. Note that the width of the image must be even.

Parameters
width Int: the width of the image
height Int: the height of the image
maxFaces Int: the maximum number of faces to identify

Public methods

findFaces

Added in API level 1
open fun findFaces(
    bitmap: Bitmap!,
    faces: Array<FaceDetector.Face!>!
): Int

Finds all the faces found in a given android.graphics.Bitmap. The supplied array is populated with FaceDetector.Faces for each face found. The bitmap must be in 565 format (for now).

Parameters
bitmap Bitmap!: the android.graphics.Bitmap graphic to be analyzed
faces Array<FaceDetector.Face!>!: an array in which to place all found FaceDetector.Faces. The array must be sized equal to the maxFaces value set at initialization
Return
Int the number of faces found
Exceptions
java.lang.IllegalArgumentException if the Bitmap dimensions don't match the dimensions defined at initialization or the given array is not sized equal to the maxFaces value defined at initialization

Protected methods

finalize

Added in API level 1
protected open fun finalize(): Unit
Exceptions
java.lang.Throwable the Exception raised by this method