Package io.scanbot.sdk.documentdata
Interface DocumentDataExtractor
-
- All Implemented Interfaces:
public interface DocumentDataExtractor
Component to scan image, detect different documents of known types, perform image optimization, cropping and (optionally) fields detection and fields' data extraction
-
-
Method Summary
Modifier and Type Method Description abstract DocumentDataExtractorConfiguration
copyCurrentConfiguration()
Returns a copy of the current configuration. abstract Unit
setConfiguration(DocumentDataExtractorConfiguration configuration)
Sets the configuration for the document data extractor. abstract DocumentDataExtractionResult
extractFromBitmap(Bitmap bitmap, Integer orientation, DocumentDataExtractionMode documentDataExtractionMode)
Scan the image to detect document and extract data from it abstract DocumentDataExtractionResult
extractFromJpeg(ByteArray jpeg, Integer orientation, DocumentDataExtractionMode documentDataExtractionMode)
Scan the image to detect document and extract data from it abstract DocumentDataExtractionResult
extractFromNv21(ByteArray nv21, Integer width, Integer height, Integer orientation, DocumentDataExtractionMode documentDataExtractionMode, Rect areaRect)
Scan the image to detect document and extract data from it abstract Unit
clear()
Clears the result accumulation cache (for live extraction) -
-
Method Detail
-
copyCurrentConfiguration
abstract DocumentDataExtractorConfiguration copyCurrentConfiguration()
Returns a copy of the current configuration.
-
setConfiguration
abstract Unit setConfiguration(DocumentDataExtractorConfiguration configuration)
Sets the configuration for the document data extractor.
- Parameters:
configuration
- The configuration to set.
-
extractFromBitmap
abstract DocumentDataExtractionResult extractFromBitmap(Bitmap bitmap, Integer orientation, DocumentDataExtractionMode documentDataExtractionMode)
Scan the image to detect document and extract data from it
- Parameters:
bitmap
- imageorientation
- image orientation.documentDataExtractionMode
- extraction mode.
-
extractFromJpeg
abstract DocumentDataExtractionResult extractFromJpeg(ByteArray jpeg, Integer orientation, DocumentDataExtractionMode documentDataExtractionMode)
Scan the image to detect document and extract data from it
- Parameters:
jpeg
- image in form of jpeg-encoded byte arrayorientation
- image orientation.documentDataExtractionMode
- extraction mode.
-
extractFromNv21
abstract DocumentDataExtractionResult extractFromNv21(ByteArray nv21, Integer width, Integer height, Integer orientation, DocumentDataExtractionMode documentDataExtractionMode, Rect areaRect)
Scan the image to detect document and extract data from it
- Parameters:
nv21
- image in form of nv21-encoded byte arraywidth
- image width, pixelsheight
- image height, pixelsorientation
- image orientation.documentDataExtractionMode
- extraction mode.areaRect
- if non-null - perform scanning only in given area.
-
-
-
-