Genius Scan SDK/com.geniusscansdk.scanflow/ScanConfiguration

ScanConfiguration

data class ScanConfiguration(var source: ScanConfiguration.Source = Source.CAMERA, var sourceImage: File? = null, var multiPage: Boolean = true, var defaultFilter: ScanConfiguration.Filter = Filter.AUTOMATIC, var availableFilters: List<ScanConfiguration.Filter> = listOf( Filter.NONE, Filter.AUTOMATIC, Filter.AUTOMATIC_MONOCHROME, Filter.AUTOMATIC_BLACK_AND_WHITE, Filter.AUTOMATIC_COLOR, Filter.PHOTO ), var pdfPageSize: ScanConfiguration.PdfPageSize = PdfPageSize.FIT, var postProcessingActions: EnumSet<ScanConfiguration.Action> = Action.ALL, var defaultCurvatureCorrection: ScanConfiguration.CurvatureCorrectionMode = CurvatureCorrectionMode.DISABLED, var photoLibraryButtonHidden: Boolean = false, var flashButtonHidden: Boolean = false, var defaultFlashMode: ScanConfiguration.FlashMode = FlashMode.OFF, var backgroundColor: Int = Color.BLACK, var foregroundColor: Int = Color.WHITE, var highlightColor: Int = Color.BLUE, var jpegQuality: Int = 60, var pdfMaxScanDimension: Int = 0, var multiPageFormat: ScanConfiguration.MultiPageFormat = MultiPageFormat.PDF, var pdfFontFile: File? = null, var ocrConfiguration: ScanConfiguration.OcrConfiguration? = null, var structuredData: EnumSet<ScanConfiguration.StructuredData> = EnumSet.noneOf(StructuredData::class.java), useLegacyCameraAPI: Boolean = false) : Serializable

Options allowing to customize the scan flow

Constructors

ScanConfiguration

constructor(source: ScanConfiguration.Source = Source.CAMERA, sourceImage: File? = null, multiPage: Boolean = true, defaultFilter: ScanConfiguration.Filter = Filter.AUTOMATIC, availableFilters: List<ScanConfiguration.Filter> = listOf( Filter.NONE, Filter.AUTOMATIC, Filter.AUTOMATIC_MONOCHROME, Filter.AUTOMATIC_BLACK_AND_WHITE, Filter.AUTOMATIC_COLOR, Filter.PHOTO ), pdfPageSize: ScanConfiguration.PdfPageSize = PdfPageSize.FIT, postProcessingActions: EnumSet<ScanConfiguration.Action> = Action.ALL, defaultCurvatureCorrection: ScanConfiguration.CurvatureCorrectionMode = CurvatureCorrectionMode.DISABLED, photoLibraryButtonHidden: Boolean = false, flashButtonHidden: Boolean = false, defaultFlashMode: ScanConfiguration.FlashMode = FlashMode.OFF, backgroundColor: Int = Color.BLACK, foregroundColor: Int = Color.WHITE, highlightColor: Int = Color.BLUE, jpegQuality: Int = 60, pdfMaxScanDimension: Int = 0, multiPageFormat: ScanConfiguration.MultiPageFormat = MultiPageFormat.PDF, pdfFontFile: File? = null, ocrConfiguration: ScanConfiguration.OcrConfiguration? = null, structuredData: EnumSet<ScanConfiguration.StructuredData> = EnumSet.noneOf(StructuredData::class.java), useLegacyCameraAPI: Boolean = false)

Types

enum Action : Enum<ScanConfiguration.Action>

Actions displayed on the post processing screen

CurvatureCorrectionMode

enum CurvatureCorrectionMode : Enum<ScanConfiguration.CurvatureCorrectionMode>

enum Filter : Enum<ScanConfiguration.Filter>

The post processing filter to apply to the image.

enum FlashMode : Enum<ScanConfiguration.FlashMode>

MultiPageFormat

enum MultiPageFormat : Enum<ScanConfiguration.MultiPageFormat>

OcrConfiguration

data class OcrConfiguration(var languages: List<String>? = null, var outputFormats: EnumSet<ScanConfiguration.OcrOutputFormat> = OcrOutputFormat.ALL) : Serializable

OcrOutputFormat

enum OcrOutputFormat : Enum<ScanConfiguration.OcrOutputFormat>

The various formats into which the OCR result can be made available.

enum PdfPageSize : Enum<ScanConfiguration.PdfPageSize>

Physical size of pages in the generated PDF file

enum Source : Enum<ScanConfiguration.Source>

The source of the scan flow.

enum StructuredData : Enum<ScanConfiguration.StructuredData>

The types of structured data to extract.

Properties

availableFilters

var availableFilters: List<ScanConfiguration.Filter>

The filters that the user can select when they tap on the edit filter button.

backgroundColor

var backgroundColor: Int

UI background color. Default is black.

defaultCurvatureCorrection

var defaultCurvatureCorrection: ScanConfiguration.CurvatureCorrectionMode

var defaultFilter: ScanConfiguration.Filter

Any specific kind of post-processing to use. Defaults to automatic.

defaultFlashMode

var defaultFlashMode: ScanConfiguration.FlashMode

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 FlashMode.OFF.

flashButtonHidden

var flashButtonHidden: Boolean

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

foregroundColor

var foregroundColor: Int

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

var highlightColor: Int

Color of the document detection overlay. Default is blue.

var jpegQuality: Int

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

var multiPage: Boolean

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

multiPageFormat

var multiPageFormat: ScanConfiguration.MultiPageFormat

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

ocrConfiguration

var ocrConfiguration: ScanConfiguration.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.

var pdfFontFile: File?

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

var pdfMaxScanDimension: Int

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.

var pdfPageSize: ScanConfiguration.PdfPageSize

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

photoLibraryButtonHidden

var photoLibraryButtonHidden: Boolean

The visibility of the photo library button. By default, the photo library button is displayed.

postProcessingActions

var postProcessingActions: EnumSet<ScanConfiguration.Action>

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

var source: ScanConfiguration.Source

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

var sourceImage: File?

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

var structuredData: EnumSet<ScanConfiguration.StructuredData>

Types of structured data to extract from the document. When set to empty, no structured data will be extracted. This is an option set so you can combine multiple values.