Android Scanbot SDK API reference/io.scanbot.sdk.barcode/BarcodeFormatCommonTwoDConfiguration

BarcodeFormatCommonTwoDConfiguration

data class BarcodeFormatCommonTwoDConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true, var formats: List<BarcodeFormat> = listOf( BarcodeFormat.AZTEC, BarcodeFormat.DATA_MATRIX, BarcodeFormat.MAXI_CODE, BarcodeFormat.MICRO_QR_CODE, BarcodeFormat.MICRO_PDF_417, BarcodeFormat.PDF_417, BarcodeFormat.QR_CODE, BarcodeFormat.RMQR_CODE )) : BarcodeFormatConfigurationBase, Parcelable

Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple 2D codes.

The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

Constructors

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

constructor(json: JSONObject)

constructor(regexFilter: String = "", minimumSizeScore: Double = 0.0, addAdditionalQuietZone: Boolean = false, gs1Handling: Gs1Handling = Gs1Handling.PARSE, strictMode: Boolean = true, formats: List<BarcodeFormat> = listOf( BarcodeFormat.AZTEC, BarcodeFormat.DATA_MATRIX, BarcodeFormat.MAXI_CODE, BarcodeFormat.MICRO_QR_CODE, BarcodeFormat.MICRO_PDF_417, BarcodeFormat.PDF_417, BarcodeFormat.QR_CODE, BarcodeFormat.RMQR_CODE ))

Types

Companion

object Companion

Properties

_type

open override val _type: String

addAdditionalQuietZone

open override var addAdditionalQuietZone: Boolean

If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode.

formats

var formats: List<BarcodeFormat>

List of 2D codes to scan.

gs1Handling

var gs1Handling: Gs1Handling

GS1 message handling options.

minimumSizeScore

open override var minimumSizeScore: Double

Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.

regexFilter

open override var regexFilter: String

Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off).

strictMode

var strictMode: Boolean

If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives.

Functions

clone

open override fun clone(): BarcodeFormatCommonTwoDConfiguration

toJson

open override fun toJson(config: ToJsonConfiguration): JSONObject