# ImageLabeling

public class **ImageLabeling** 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/label/ImageLabeler`
for finding `https://developers.google.com/android/reference/com/google/mlkit/vision/label/ImageLabel`s in
a supplied image.

An image labeler is created via `https://developers.google.com/android/reference/com/google/mlkit/vision/label/ImageLabeling#getClient(com.google.mlkit.vision.label.ImageLabelerOptionsBase)`.

Example:

     ImageLabeler imageLabeler = ImageLabeling.getClient(options); 

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

     Task<List<ImageLabel>> task = imageLabeler.process(image);
     task.addOnSuccessListener(...).addOnFailureListener(...); 

### Public Method Summary

|---|---|
| static [ImageLabeler](https://developers.google.com/android/reference/com/google/mlkit/vision/label/ImageLabeler) | [getClient](https://developers.google.com/android/reference/com/google/mlkit/vision/label/ImageLabeling#getClient(com.google.mlkit.vision.label.ImageLabelerOptionsBase))([ImageLabelerOptionsBase](https://developers.google.com/android/reference/com/google/mlkit/vision/label/ImageLabelerOptionsBase) options) Gets an new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/label/ImageLabeler` that labels a supplied image. |

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

Gets an new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/label/ImageLabeler`
that labels a supplied image.

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

##### Parameters

| options | the options for the image labeler. It should be one of the concrete options like `https://developers.google.com/android/reference/com/google/mlkit/vision/label/defaults/ImageLabelerOptions` or `https://developers.google.com/android/reference/com/google/mlkit/vision/label/custom/CustomImageLabelerOptions`. |
|---|---|