Serialized Form

Package com.geniusscansdk.scanflow

Class com.geniusscansdk.scanflow.ScanConfiguration extends java.lang.Object implements Serializable

Serialized Fields

backgroundColor

int backgroundColor

UI background color. Default is black.

defaultFilter

ScanConfiguration.Filter defaultFilter

Force the use of a specific post processing filter. If not provided, the best filter will be chosen automatically.

defaultFlashMode

ScanConfiguration.FlashMode defaultFlashMode

The default flash mode used when capturing a page. Combine with ScanConfiguration.flashButtonHidden if you want to only allow a specific flash mode. Default is ScanConfiguration.FlashMode.OFF.

flashButtonHidden

boolean flashButtonHidden

The visibility of the flash button. By default, the flash button is displayed.

foregroundColor

int foregroundColor

UI foreground color (text and icons). Default is white.

highlightColor

int highlightColor

Color of the document detection overlay. Default is blue.

jpegQuality

int jpegQuality

JPEG quality used to compress captured images. Between 0 and 100, 100 being the best quality. Default is 60.

multiPage

boolean multiPage

Multipage mode. Only apply when ScanConfiguration.source is ScanConfiguration.Source.CAMERA. Defaults to true.

multiPageFormat

ScanConfiguration.MultiPageFormat multiPageFormat

Format of the document created with all the captured pages. When set to ScanConfiguration.MultiPageFormat.NONE, no document will be generated but the individual pages will still be accessible in the ScanResult.

ocrConfiguration

ScanConfiguration.OcrConfiguration ocrConfiguration

Configuration of the text recognition. Text recognition will run on a background thread for every captured image. If null, no text recognition will be applied.

pdfFontFile

java.io.File pdfFontFile

Custom font file used during the PDF generation to embed an invisible text layer. If null, a default font is used, which only supports Latin languages.

pdfMaxScanDimension

int pdfMaxScanDimension

Max scan dimension in pixels when generating the PDF file. All scans included in the PDF file will be scaled so that both their height and width are smaller than this value, while keeping their aspect ratio. Default is 0, which means no scaling is applied.

pdfPageSize

ScanConfiguration.PdfPageSize pdfPageSize

Determine the size of the pages when generating the PDF. Default is ScanConfiguration.PdfPageSize.FIT

postProcessingActions

java.util.EnumSet<ScanConfiguration.Action> postProcessingActions

Select which actions are displayed in the post processing screen Default is everything.

source

ScanConfiguration.Source source

The source for the scanned documents (camera, image...). If the source is ScanConfiguration.Source.IMAGE, the parameter ScanConfiguration.sourceImage must be provided.

sourceImage

java.io.File sourceImage

The source image if ScanConfiguration.source is ScanConfiguration.Source.IMAGE.

Class com.geniusscansdk.scanflow.ScanConfiguration.OcrConfiguration extends java.lang.Object implements Serializable

Serialized Fields

languages

java.util.List<java.lang.String> languages

The language codes for which to run text recognition.
The codes must match the provided language files, eg.: ["eng", "fra"] if both `eng.trainedata` and `fra.trainedata` are present in the language directory.
Note that text recognition will take longer if multiple languages are specified.

languagesDirectory

java.io.File languagesDirectory

Folder containing the language files used for text recognition. Language files can be downloaded from this repository.

outputFormats

java.util.EnumSet<ScanConfiguration.OcrOutputFormat> outputFormats

The formats in which the OCR result is made available in the ScanFlow result. Default is everything.

Class com.geniusscansdk.scanflow.ScanResult extends java.lang.Object implements Serializable

Serialized Fields

multiPageDocument

java.io.File multiPageDocument

Document containing the pages that were scanned during the scan flow. The format is specified by {ScanConfiguration.multiPageFormat. Can be null if no format was specified or if generation failed.

pdfFile

java.io.File pdfFile

Deprecated.

Replaced by ScanResult.multiPageDocument

scans

java.util.List<ScanResult.Scan> scans

List of pages that were scanned during the scan flow.

Class com.geniusscansdk.scanflow.ScanResult.OcrResult extends java.lang.Object implements Serializable

Serialized Fields

hocrTextLayout

java.lang.String hocrTextLayout

The recognized text in hOCR format (with position, style)

text

java.lang.String text

Raw text recognized in the image

Class com.geniusscansdk.scanflow.ScanResult.Scan extends java.lang.Object implements Serializable

Serialized Fields

enhancedImageFile

java.io.File enhancedImageFile

The image after the processing operations (perspective correction, filter…).

ocrResult

ScanResult.OcrResult ocrResult

Result of text recognition for this captured image. Null if text recognition did not run or if it failed. Check logs for more details about text recognition failures.

originalImageFile

java.io.File originalImageFile

The original image that was captured by the camera.