Android Scanbot SDK API reference/io.scanbot.sdk.ocr/ScanbotOcrEngine

ScanbotOcrEngine

class ScanbotOcrEngine(context: Context, blobManager: BlobManager, sapManager: SapManager, blobStoreStrategy: BlobStoreStrategy, pageFileStorage: PageFileStorage, fileIOProcessor: FileIOProcessor, ocrSettings: OcrSettings, bitmapBinarizer: OcrPdfGenerator.BitmapBinarizer) : OcrEngine

Default implementation of OcrEngine for Scanbot SDK

Constructors

Link copied to clipboard
constructor(context: Context, blobManager: BlobManager, sapManager: SapManager, blobStoreStrategy: BlobStoreStrategy, pageFileStorage: PageFileStorage, fileIOProcessor: FileIOProcessor, ocrSettings: OcrSettings, bitmapBinarizer: OcrPdfGenerator.BitmapBinarizer)

Types

Link copied to clipboard
data class BitmapInput(val bitmap: Bitmap, val engineMode: OcrEngine.EngineMode = OcrEngine.EngineMode.SCANBOT_OCR, val pdfConfig: PdfConfiguration? = null, val outputFile: File? = null, val sourceOcrPages: List<Page> = emptyList()) : ScanbotOcrEngine.EngineInput

Allows to set OCR input as a bitmap

Link copied to clipboard
object Companion
Link copied to clipboard
data class DocumentInput(val document: Document, val engineMode: OcrEngine.EngineMode = OcrEngine.EngineMode.SCANBOT_OCR, val pdfConfig: PdfConfiguration? = null, val outputFile: File? = null, val sourceOcrPages: List<Page> = emptyList()) : ScanbotOcrEngine.EngineInput

Allows to set OCR input as Document of encrypted or normal images

Link copied to clipboard
sealed class EngineInput

Input for the OCR process

Link copied to clipboard
data class PagesInput(val pages: List<Page>, val engineMode: OcrEngine.EngineMode = OcrEngine.EngineMode.SCANBOT_OCR, val pdfConfig: PdfConfiguration? = null, val outputFile: File? = null, val sourceOcrPages: List<Page> = emptyList()) : ScanbotOcrEngine.EngineInput

Allows to set OCR input as a list of pages

Link copied to clipboard
data class UrisInput(val uris: List<Uri>, val encryptedInput: Boolean = false, val engineMode: OcrEngine.EngineMode = OcrEngine.EngineMode.SCANBOT_OCR, val pdfConfig: PdfConfiguration? = null, val outputFile: File? = null, val sourceOcrPages: List<Page> = emptyList()) : ScanbotOcrEngine.EngineInput

Allows to set OCR input as a list of URIs of encrypted or normal images

Functions

Link copied to clipboard
open override fun getInstalledLanguages(): Set<Language>
Link copied to clipboard
open override fun getLanguageDataPath(): File
Link copied to clipboard
open override fun recognizeFromBitmap(bitmap: Bitmap): OcrResult

Performs OCR only (without PDF result) from the bitmap with provided languages.

Link copied to clipboard
open override fun recognizeFromDocument(document: Document): OcrResult

Performs OCR only (without PDF result) from the document with provided languages.

Link copied to clipboard
open override fun recognizeFromPages(pages: List<Page>): OcrResult

Performs OCR only (without PDF result) from pages with provided languages.

Link copied to clipboard
open override fun recognizeFromUris(imageFileUris: List<Uri>, sourceFilesEncrypted: Boolean): OcrResult

Performs OCR only (without PDF result) from Images with provided languages.

Link copied to clipboard
open override fun setOcrConfig(ocrConfig: OcrEngine.OcrConfig)

Sets the OCR and PDF engine mode configuration.