# ObjectDetection

public class **ObjectDetection** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Entry point to get an `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector`
for finding `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/DetectedObject`s
in a supplied image.

An `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector`
is created via `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetection#getClient(com.google.mlkit.vision.objects.ObjectDetectorOptionsBase)`.

Example:

    ObjectDetector objectDetector = ObjectDetection.getClient(options); 

To perform object 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`, 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 objects in the supplied `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`.

    Task<List<DetectedObject>> task = objectDetector.process(image);
     task.addOnSuccessListener(...).addOnFailureListener(...); 

### Public Method Summary

|---|---|
| static [ObjectDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector) | [getClient](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetection#getClient(com.google.mlkit.vision.objects.ObjectDetectorOptionsBase))([ObjectDetectorOptionsBase](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetectorOptionsBase) options) Gets a new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector` that can detect objects in a supplied image with the given options. |

### 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 [ObjectDetector](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector)
**getClient** ([ObjectDetectorOptionsBase](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetectorOptionsBase) options)

Gets a new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector`
that can detect objects in a supplied image with the given options.

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

##### Parameters

| options | the options for the object detector. It should be one of the concrete options like `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/defaults/ObjectDetectorOptions` or `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/custom/CustomObjectDetectorOptions`. |
|---|---|