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

BarcodeFormatCommonConfiguration

data class BarcodeFormatCommonConfiguration(var regexFilter: String = "", var minimumSizeScore: Double = 0.0, var addAdditionalQuietZone: Boolean = false, var minimum1DQuietZoneSize: Int = 6, var stripCheckDigits: Boolean = false, var minimumTextLength: Int = 1, var maximumTextLength: Int = 0, var gs1Handling: Gs1Handling = Gs1Handling.PARSE, var strictMode: Boolean = true, var formats: List<BarcodeFormat> = listOf( BarcodeFormat.AZTEC, BarcodeFormat.CODABAR, BarcodeFormat.CODE_39, BarcodeFormat.CODE_93, BarcodeFormat.CODE_128, BarcodeFormat.DATA_MATRIX, BarcodeFormat.DATABAR, BarcodeFormat.DATABAR_EXPANDED, BarcodeFormat.DATABAR_LIMITED, BarcodeFormat.EAN_13, BarcodeFormat.EAN_8, BarcodeFormat.ITF, BarcodeFormat.MICRO_QR_CODE, BarcodeFormat.PDF_417, BarcodeFormat.QR_CODE, BarcodeFormat.UPC_A, BarcodeFormat.UPC_E )) : BarcodeFormatConfigurationBase, Parcelable

Convenience configuration for enabling the scanning of multiple barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple barcodes.

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, minimum1DQuietZoneSize: Int = 6, stripCheckDigits: Boolean = false, minimumTextLength: Int = 1, maximumTextLength: Int = 0, gs1Handling: Gs1Handling = Gs1Handling.PARSE, strictMode: Boolean = true, formats: List<BarcodeFormat> = listOf( BarcodeFormat.AZTEC, BarcodeFormat.CODABAR, BarcodeFormat.CODE_39, BarcodeFormat.CODE_93, BarcodeFormat.CODE_128, BarcodeFormat.DATA_MATRIX, BarcodeFormat.DATABAR, BarcodeFormat.DATABAR_EXPANDED, BarcodeFormat.DATABAR_LIMITED, BarcodeFormat.EAN_13, BarcodeFormat.EAN_8, BarcodeFormat.ITF, BarcodeFormat.MICRO_QR_CODE, BarcodeFormat.PDF_417, BarcodeFormat.QR_CODE, BarcodeFormat.UPC_A, BarcodeFormat.UPC_E ))

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 barcode formats to scan. By default, the most commonly used formats are enabled.

gs1Handling

var gs1Handling: Gs1Handling

GS1 message handling options.

maximumTextLength

var maximumTextLength: Int

Maximum text length. 0 implies no maximum. Applied only to linear barcode formats that allow variable length.

minimum1DQuietZoneSize

var minimum1DQuietZoneSize: Int

Minimum quiet zone size on the left and right sides of a 1D barcode, measured in number of modules. The quiet zone is only for 1D barcodes with weak start/stop patterns, i.e. Iata2Of5, Industrial2Of5, Code25, Itf, Codabar, MsiPlessey and Code11.

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.

minimumTextLength

var minimumTextLength: Int

Minimum text length. Applied only to linear barcode formats that allow variable length.

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.

stripCheckDigits

var stripCheckDigits: Boolean

If true, the check digits are stripped from the result.

Functions

clone

open override fun clone(): BarcodeFormatCommonConfiguration

toJson

open override fun toJson(config: ToJsonConfiguration): JSONObject