# FaceDetection

public class **FaceDetection** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Entry point to get a `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector`
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 `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector`
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

|---|---|
| static [FaceDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector) | [getClient](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetection#getClient(com.google.mlkit.vision.face.FaceDetectorOptions))([FaceDetectorOptions](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetectorOptions) options) Gets a new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector` that detects faces in a supplied image. |
| static [FaceDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector) | [getClient](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetection#getClient())() Gets an instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector` that detects faces in a supplied image with a default `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetectorOptions`. |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Public Methods

#### public static [FaceDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector)
**getClient** ([FaceDetectorOptions](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetectorOptions) options)

Gets a new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector`
that detects faces in a supplied image.

To release the resources associated with a FaceDetector, you need to ensure that
`https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector#close()`
is called on the resulting `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector`
object once it will no longer be used.

##### Parameters

| options | the options for the face detector |
|---|---|

#### public static [FaceDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector)
**getClient** ()

Gets an instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetector`
that detects faces in a supplied image with a default `https://developers.google.com/android/reference/com/google/mlkit/vision/face/FaceDetectorOptions`.