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

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

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

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Exceptions
java.lang.Throwable the Exception raised by this method