# OcrProvider

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

*** ** * ** ***


```
@ExperimentalPdfApi
interface OcrProvider : Closeable
```

<br />

Known direct subclasses [MlKitOcrProvider](https://developer.android.com/reference/kotlin/androidx/pdf/ocr/playservices/MlKitOcrProvider)

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

*** ** * ** ***

Interface for processing images to recognize text.

Implementations should handle the complexity of OCR (Optical Character Recognition) processing and return a structured `https://developer.android.com/reference/kotlin/androidx/pdf/ocr/OcrResult` that allows for spatial queries.

## Summary

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/ocr/OcrProvider#close()()` |
| `suspend https://developer.android.com/reference/kotlin/androidx/pdf/ocr/OcrResult?` | `https://developer.android.com/reference/kotlin/androidx/pdf/ocr/OcrProvider#recognizeText(android.graphics.Bitmap)(image: https://developer.android.com/reference/android/graphics/Bitmap.html)` Processes the given `https://developer.android.com/reference/kotlin/androidx/pdf/ocr/OcrProvider#recognizeText(android.graphics.Bitmap)` and returns recognized text results. |

## Public functions

### close

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

```
fun close(): Unit
```

### recognizeText

```
suspend fun recognizeText(image: Bitmap): OcrResult?
```

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

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

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