Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.document.configuration/DocumentScannerOutputSettings

DocumentScannerOutputSettings

data class DocumentScannerOutputSettings(var pagesScanLimit: Int = 0, var documentImageSizeLimit: Int = 0, var documentAnalysisMode: DocumentAnalysisMode = DocumentAnalysisMode.UNFILTERED_DOCUMENT, var defaultFilter: ParametricFilter? = null) : Parcelable

Configuration of the output settings.

Constructors

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(pagesScanLimit: Int = 0, documentImageSizeLimit: Int = 0, documentAnalysisMode: DocumentAnalysisMode = DocumentAnalysisMode.UNFILTERED_DOCUMENT, defaultFilter: ParametricFilter? = null)

Types

Companion

object Companion

Properties

defaultFilter

var defaultFilter: ParametricFilter?

Determines the image filter to apply by default.

documentAnalysisMode

var documentAnalysisMode: DocumentAnalysisMode

Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.

documentImageSizeLimit

var documentImageSizeLimit: Int

The limit of the size of the cropped document images. If one of the dimensions of the cropped image is larger than the limit, the image is downscaled so that its longer dimension matches the limit. The default is 0 (no limit).

pagesScanLimit

var pagesScanLimit: Int

The limit of the number of pages that can be scanned. Default is 0 (no limit).

Functions

clone

fun clone(): DocumentScannerOutputSettings

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject