FaceDetector

Kotlin |Java

public class FaceDetector
extends Object

java.lang.Object
↳	android.media.FaceDetector

Identifies the faces of people in a Bitmap graphic object.

Summary

Nested classes
`class`	`FaceDetector.Face` A Face contains all the information identifying the location of a face in a bitmap.

Public constructors
`FaceDetector(int width, int height, int maxFaces)` 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
`int`	`findFaces(Bitmap bitmap, Face[] faces)` Finds all the faces found in a given `Bitmap`.

Protected methods
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

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.

Public constructors

FaceDetector

Added in API level 1

public FaceDetector (int width, 
                int height, 
                int maxFaces)

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

public int findFaces (Bitmap bitmap, 
                Face[] faces)

Finds all the faces found in a given 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 `Bitmap` graphic to be analyzed
`faces`	`Face`: an array in which to place all found `FaceDetector.Face`s. The array must be sized equal to the `maxFaces` value set at initialization

Returns
`int`	the number of faces found

Throws
`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 void finalize ()

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.

Throws
`Throwable`

FaceDetector

Summary

Nested classes

Public constructors

Public methods

Protected methods

Inherited methods

Public constructors

FaceDetector

Public methods

findFaces

Protected methods

finalize