public interface TextRecognizer implements Detector<Text> OptionalModuleApi

TextRecognition client for performing optical character recognition(OCR) on an input image to detect latin-based characters.

A TextRecognizer is created via TextRecognition.getClient(TextRecognizerOptionsInterface). See the code example below.

      TextRecognizer textRecognizer = TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS);
To perform OCR on an image, you first need to create an instance of InputImage from a ByteBuffer, Bitmap, etc. See InputImage documentation for more details. For example, the code below creates an InputImage from a Bitmap. 
InputImage image = InputImage.fromBitmap(bitmap, rotationDegrees);

Then the code below can detect texts in the supplied InputImage.

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

Public Method Summary

abstract void
close()
Closes the detector and releases its resources.
abstract Task<Text>
process(MlImage image)
Detects latin-based characters from the supplied image.
abstract Task<Text>
process(InputImage image)
Detects latin-based characters from the supplied image.

Inherited Method Summary

Public Methods

public abstract void close ()

Closes the detector and releases its resources.

public abstract Task<Text> process (MlImage image)

Detects latin-based characters from the supplied image.

This is an experimental API in beta version.

Create an MlImage object using one of MlImage's builder methods. See MlImage documentation for more details.

If the text recognition model has not been downloaded yet, the returned Task will contain an MlKitException with error code MlKitException.UNAVAILABLE.

Returns
  • a Task that asynchronously returns the recognized Text.

public abstract Task<Text> process (InputImage image)

Detects latin-based characters from the supplied image.

Create an InputImage object using one of InputImage's factory methods. See InputImage documentation for more details.

If the text recognition model has not been downloaded yet, the returned Task will contain an MlKitException with error code MlKitException.UNAVAILABLE.

Returns
  • a Task that asynchronously returns the recognized Text.