# TextRecognition

public class **TextRecognition** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Entry point for performing optical character recognition(OCR) on an input image to detect
latin-based characters.

A `https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognizer`
is created via `https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognition#getClient(com.google.mlkit.vision.text.TextRecognizerOptionsInterface)`. See the code example below.

     TextRecognizer textRecognizer = TextRecognition.getClient(TextRecognizerOptionsInterface);
     
To perform OCR on 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/java/nio/ByteBuffer.html`, `https://developer.android.com/reference/android/graphics/Bitmap.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 texts in the supplied `https://developers.google.com/android/reference/com/google/mlkit/vision/common/InputImage`.

     Task<Text> task = textRecognizer.process(image);
     task.addOnSuccessListener(...).addOnFailureListener(...); 

### Public Method Summary

|---|---|
| static [TextRecognizer](https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognizer) | [getClient](https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognition#getClient(com.google.mlkit.vision.text.TextRecognizerOptionsInterface))([TextRecognizerOptionsInterface](https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognizerOptionsInterface) options) Gets a new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognizer` to perform optical character recognition on device with the specified `https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognizerOptionsInterface`. |

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

Gets a new instance of `https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognizer`
to perform optical character recognition on device with the specified `https://developers.google.com/android/reference/com/google/mlkit/vision/text/TextRecognizerOptionsInterface`.

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