# FaceDetector

public interface **FaceDetector** extends [Detector](https://developers.google.com/android/reference/com/google/mlkit/vision/interfaces/Detector)\<[List](https://developer.android.com/reference/java/util/List.html)\<[Face](https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face)\>\>, [OptionalModuleApi](https://developers.google.com/android/reference/com/google/android/gms/common/api/OptionalModuleApi) A `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetection`
client for finding `https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face`s in a supplied
image.

A `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector`
is created via `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetection#getClient(com.google.mlkit.vision.face.FaceDetectorOptions)` or `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetection#getClient()`,
if you wish to use the default options. For example, the code below creates a face detector
client with default options.

    FaceDetector faceDetector = FaceDetection.getClient();
     
To perform face detection in an image, you first need to create an instance of `
https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage` from a `https://developer.android.com/reference/android/graphics/Bitmap.html`, `https://developer.android.com/reference/java/nio/ByteBuffer.html`, `https://developer.android.com/reference/android/media/Image.html` etc. See `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage` documentation for more details. For example, the code below creates an `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage` from a `https://developer.android.com/reference/android/graphics/Bitmap.html`.

    InputImage image = InputImage.fromBitmap(bitmap, rotationDegrees);
     
Then the code below can detect faces in the supplied `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`.

    Task<List<Face>> task = faceDetector.process(image);
     task.addOnSuccessListener(...).addOnFailureListener(...);
     
### Public Method Summary

|---|---|
| abstract void | [close](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector#close())() Closes the detector and releases its resources. |
| abstract Task\<[List](https://developer.android.com/reference/java/util/List.html)\<[Face](https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face)\>\> | [process](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector#process(com.google.android.odml.image.MlImage))([MlImage](https://developers.google.com/android/reference/com/google/android/odml/image/MlImage) image) Detects human faces from the supplied image. |
| abstract Task\<[List](https://developer.android.com/reference/java/util/List.html)\<[Face](https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face)\>\> | [process](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector#process(com.google.mlkit.vision.common.InputImage))([InputImage](https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage) image) Detects human faces from the supplied image. |

### Inherited Method Summary

From interface java.io.Closeable

|---|---|
| abstract void | close() |

From interface java.lang.AutoCloseable

|---|---|
| abstract void | close() |

## Public Methods

#### public abstract void **close** ()

Closes the detector and releases its resources.

#### public abstract Task\<[List](https://developer.android.com/reference/java/util/List.html)\<[Face](https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face)\>\>
**process** ([MlImage](https://developers.google.com/android/reference/com/google/android/odml/image/MlImage) image)

Detects human faces from the supplied image.

This is an experimental API in beta version.

Create an `https://developers.google.com/android/reference/com/google/android/odml/image/MlImage`
object using one of `https://developers.google.com/android/reference/com/google/android/odml/image/MlImage`'s
builder methods. See `https://developers.google.com/android/reference/com/google/android/odml/image/MlImage`
documentation for more details.

Note that the width of the provided image cannot be less than 32 if `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetectorOptions#CONTOUR_MODE_ALL` is specified.

If the face detection model has not been downloaded yet when you are depending on
com.google.android.gms:play-services-mlkit-face-detection, the returned `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` will
contain an `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException`
with error code `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException#UNAVAILABLE`.

If there is no face gets detected, the returned `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` will
contain an empty `https://developer.android.com/reference/java/util/List.html`.

##### Returns

- a `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` that asynchronously returns a `https://developer.android.com/reference/java/util/List.html` of detected `https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face`s

#### public abstract Task\<[List](https://developer.android.com/reference/java/util/List.html)\<[Face](https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face)\>\>
**process** ([InputImage](https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage) image)

Detects human faces from the supplied image.

Create an `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`
object using one of `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`'s
factory methods. See `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`
documentation for more details.

Note that the width of the provided image cannot be less than 32 if `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetectorOptions#CONTOUR_MODE_ALL` is specified.

If the face detection model has not been downloaded yet when you are depending on
com.google.android.gms:play-services-mlkit-face-detection, the returned `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` will
contain an `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException`
with error code `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException#UNAVAILABLE`.

If there is no face gets detected, the returned `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` will
contain an empty `https://developer.android.com/reference/java/util/List.html`.

##### Returns

- a `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` that asynchronously returns a `https://developer.android.com/reference/java/util/List.html` of detected `https://developers.google.com/android/reference/com/google/mlkit/vision/face/Face`s