# ObjectDetector

public interface **ObjectDetector** extends [Detector](https://developers.google.com/android/reference/com/google/mlkit/vision/interfaces/Detector)\<[List](https://developer.android.com/reference/java/util/List.html)\<[DetectedObject](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/DetectedObject)\>\> An `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetection`
client 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

|---|---|
| abstract void | [close](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector#close())() Closes the detector and releases its resources. |
| abstract Task\<[List](https://developer.android.com/reference/java/util/List.html)\<[DetectedObject](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/DetectedObject)\>\> | [process](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector#process(com.google.android.odml.image.MlImage))([MlImage](https://developers.google.com/android/reference/com/google/android/odml/image/MlImage) image) Detects objects from a supplied image. |
| abstract Task\<[List](https://developer.android.com/reference/java/util/List.html)\<[DetectedObject](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/DetectedObject)\>\> | [process](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector#process(com.google.mlkit.vision.common.InputImage))([InputImage](https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage) image) Detects objects from a 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)\<[DetectedObject](https://developers.google.com/android/reference/com/google/mlkit/vision/objects/DetectedObject)\>\>
**process** ([MlImage](https://developers.google.com/android/reference/com/google/android/odml/image/MlImage) image)

Detects objects from a 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 and height of the provided image cannot be less than 32.

When calling this method on an `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector`
created with `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/custom/CustomObjectDetectorOptions`, 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 specific error code in the following cases: (1) with error code `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException#NOT_FOUND`
if cannot find the custom classifier model file; (2) with error code `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException#INVALID_ARGUMENT`
if the custom model file is not compatible with this SDK.

##### 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 `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/DetectedObject`s. An empty list is returned by the `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` if no object is detected.

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

Detects objects from a 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 and height of the provided image cannot be less than 32.

When calling this method on an `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/ObjectDetector`
created with `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/custom/CustomObjectDetectorOptions`, 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 specific error code in the following cases: (1) with error code `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException#NOT_FOUND`
if cannot find the custom classifier model file; (2) with error code `https://developers.google.com/android/reference/com/google/mlkit/common/MlKitException#INVALID_ARGUMENT`
if the custom model file is not compatible with this SDK.

##### 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 `https://developers.google.com/android/reference/com/google/mlkit/vision/objects/DetectedObject`s. An empty list is returned by the `https://developers.google.com/android/reference/com/google/android/gms/tasks/Task` if no object is detected.