Package io.scanbot.sdk.ocr
Interface OcrEngine
-
- All Implemented Interfaces:
public interface OcrEngine
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
OcrEngine.OcrConfig
Represents additional the OCR configurations.
public enum
OcrEngine.EngineMode
Represents the OCR and PDF engine modes.
-
Method Summary
Modifier and Type Method Description abstract OcrResult
recognizeFromUris(List<Uri> imageFileUris, Boolean sourceFilesEncrypted)
Performs OCR only (without PDF result) from Images with provided languages. abstract OcrResult
recognizeFromPages(List<Page> pages)
Performs OCR only (without PDF result) from pages with provided languages. abstract OcrResult
recognizeFromBitmap(Bitmap bitmap)
Performs OCR only (without PDF result) from the bitmap with provided languages. abstract OcrResult
recognizeFromDocument(Document document)
Performs OCR only (without PDF result) from the document with provided languages. abstract File
getLanguageDataPath()
abstract Set<Language>
getInstalledLanguages()
abstract Unit
setOcrConfig(OcrEngine.OcrConfig ocrConfig)
Sets the OCR and PDF engine mode configuration. -
-
Method Detail
-
recognizeFromUris
abstract OcrResult recognizeFromUris(List<Uri> imageFileUris, Boolean sourceFilesEncrypted)
Performs OCR only (without PDF result) from Images with provided languages.
- Parameters:
imageFileUris
- list of image file URIssourceFilesEncrypted
- if true, the image files are encrypted and will be decrypted before OCR
-
recognizeFromPages
@Deprecated(message = "Use generateFromDocument() instead") abstract OcrResult recognizeFromPages(List<Page> pages)
Performs OCR only (without PDF result) from pages with provided languages.
- Parameters:
pages
- list of Page objects.
-
recognizeFromBitmap
abstract OcrResult recognizeFromBitmap(Bitmap bitmap)
Performs OCR only (without PDF result) from the bitmap with provided languages.
- Parameters:
bitmap
- the bitmap to perform OCR on
-
recognizeFromDocument
abstract OcrResult recognizeFromDocument(Document document)
Performs OCR only (without PDF result) from the document with provided languages.
- Parameters:
document
- the document to perform OCR on
-
getLanguageDataPath
abstract File getLanguageDataPath()
-
getInstalledLanguages
abstract Set<Language> getInstalledLanguages()
-
setOcrConfig
abstract Unit setOcrConfig(OcrEngine.OcrConfig ocrConfig)
Sets the OCR and PDF engine mode configuration.
- Parameters:
ocrConfig
- the OCR and PDF engine mode configuration
-
-
-
-