# MlKitOcrProvider

Artifact: [androidx.pdf:pdf-ocr-play-services](https://developer.android.com/jetpack/androidx/releases/pdf) [View Source](https://cs.android.com/search?q=file:androidx/pdf/ocr/playservices/MlKitOcrProvider.kt+class:androidx.pdf.ocr.playservices.MlKitOcrProvider) Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

*** ** * ** ***


```
@ExperimentalPdfApi
public final class MlKitOcrProvider implements OcrProvider
```

<br />

*** ** * ** ***

Implementation of `https://developer.android.com/reference/androidx/pdf/ocr/OcrProvider` using ML Kit's Text Recognition.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/pdf/ocr/playservices/MlKitOcrProvider#MlKitOcrProvider()()` |

| ### Public methods |
|---|---|
| `void` | `https://developer.android.com/reference/androidx/pdf/ocr/playservices/MlKitOcrProvider#close()()` |
| `https://developer.android.com/reference/androidx/pdf/ocr/OcrResult` | `https://developer.android.com/reference/androidx/pdf/ocr/playservices/MlKitOcrProvider#recognizeText(android.graphics.Bitmap)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html image)` Processes the given `https://developer.android.com/reference/androidx/pdf/ocr/OcrProvider#recognizeText(android.graphics.Bitmap)` and returns recognized text results. |

## Public constructors

### MlKitOcrProvider

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public MlKitOcrProvider()
```

## Public methods

### close

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
public void close()
```

### recognizeText

```
public OcrResult recognizeText(@NonNull Bitmap image)
```

Processes the given `https://developer.android.com/reference/androidx/pdf/ocr/OcrProvider#recognizeText(android.graphics.Bitmap)` and returns recognized text results.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html image` | The bitmap to process for text recognition. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/pdf/ocr/OcrResult` | An `https://developer.android.com/reference/androidx/pdf/ocr/OcrResult` containing the recognized text and its visual mapping, or `null` if no text was recognized or an error occurred. |