Android Scanbot SDK API reference/io.scanbot.sdk.ui.view.barcode.configuration/BarcodeScannerAdditionalConfiguration

BarcodeScannerAdditionalConfiguration

data class BarcodeScannerAdditionalConfiguration(val minimumTextLength: Int = 0, val maximumTextLength: Int = 0, val minimum1DQuietZoneSize: Int = 10, val gs1HandlingMode: Gs1Handling = Gs1Handling.PARSE, val msiPlesseyChecksumAlgorithms: List<MsiPlesseyChecksumAlgorithm> = BarcodeFormatMsiPlesseyConfiguration.default().checksumAlgorithms, val stripCheckDigits: Boolean = false, val lowPowerMode: Boolean = false, val useIata2Of5Checksum: Boolean = true, val useCode11Checksum: Boolean = true, val australiaPostCustomerFormat: AustraliaPostCustomerFormat = AustraliaPostCustomerFormat.ALPHA_NUMERIC)

Entity represents additional configuration params for BarcodeScanner.

Note: only a few barcode types support these params - for the rest these settings will have no influence. Please read each param documentation carefully before modifying.

Note: in future these params might change their behavior. If you you use non-default values in your code please read changelogs of future versions carefully to avoid subtle changes in application logic.

Constructors

BarcodeScannerAdditionalConfiguration

constructor(minimumTextLength: Int = 0, maximumTextLength: Int = 0, minimum1DQuietZoneSize: Int = 10, gs1HandlingMode: Gs1Handling = Gs1Handling.PARSE, msiPlesseyChecksumAlgorithms: List<MsiPlesseyChecksumAlgorithm> = BarcodeFormatMsiPlesseyConfiguration.default().checksumAlgorithms, stripCheckDigits: Boolean = false, lowPowerMode: Boolean = false, useIata2Of5Checksum: Boolean = true, useCode11Checksum: Boolean = true, australiaPostCustomerFormat: AustraliaPostCustomerFormat = AustraliaPostCustomerFormat.ALPHA_NUMERIC)

Properties

australiaPostCustomerFormat

val australiaPostCustomerFormat: AustraliaPostCustomerFormat

gs1HandlingMode

val gs1HandlingMode: Gs1Handling

GS1 handling mode. The default is Gs1Handling.PARSE.

lowPowerMode

val lowPowerMode: Boolean = false

If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false.

maximumTextLength

val maximumTextLength: Int = 0

Maximum text length of the scanned barcode. Setting to zero removes the limit. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!

minimum1DQuietZoneSize

val minimum1DQuietZoneSize: Int = 10

Minimum required quiet zone on the barcode. Measured in modules (the size of a minimal bar on the barcode). The default value is 10. NOTE: Currently works for ITF and MSI Plessey barcodes only!

minimumTextLength

val minimumTextLength: Int = 0

Minimum required text length of the scanned barcode. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!

msiPlesseyChecksumAlgorithms

val msiPlesseyChecksumAlgorithms: List<MsiPlesseyChecksumAlgorithm>

The checksum algorithms for MSI Plessey barcodes. The default value is MsiPlesseyChecksumAlgorithm.MOD_10.

stripCheckDigits

val stripCheckDigits: Boolean = false

If true, check digits for UPC, EAN and MSI Plessey codes are removed from result. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false

useCode11Checksum

val useCode11Checksum: Boolean = true

useIata2Of5Checksum

val useIata2Of5Checksum: Boolean = true