scanbot-sdk-compose-multiplatform/io.scanbot.sdk.compose.multiplatform.configuration/BarcodeRecognizerConfiguration

BarcodeRecognizerConfiguration

data class BarcodeRecognizerConfiguration(var acceptedDocumentFormats: List<BarcodeDocumentFormat> = listOf( ), var barcodesExtensionFilter: BarcodesExtensionFilter = BarcodesExtensionFilter.NO_FILTER, var barcodesRegexFilter: String = "", var minimumTextLength: Int = 0, var maximumTextLength: Int = 0, var minimum1DBarcodesQuietZone: Int = 10, var stripCheckDigits: Boolean = false, var useIATA2OF5Checksum: Boolean = true, var useCode11Checksum: Boolean = true, var barcodeFormats: List<BarcodeFormat> = listOf( ), var msiPlesseyChecksumAlgorithm: MSIPlesseyChecksumAlgorithm = MSIPlesseyChecksumAlgorithm.MOD_10, var australiaPostCustomerFormat: AustraliaPostCustomerFormat = AustraliaPostCustomerFormat.ALPHA_NUMERIC, var lowPowerMode: Boolean = false, var gs1Handling: Gs1Handling = Gs1Handling.PARSE)

Configuration of the scanning behavior.

Constructors

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

constructor(json: JsonObject)

constructor(acceptedDocumentFormats: List<BarcodeDocumentFormat> = listOf( ), barcodesExtensionFilter: BarcodesExtensionFilter = BarcodesExtensionFilter.NO_FILTER, barcodesRegexFilter: String = "", minimumTextLength: Int = 0, maximumTextLength: Int = 0, minimum1DBarcodesQuietZone: Int = 10, stripCheckDigits: Boolean = false, useIATA2OF5Checksum: Boolean = true, useCode11Checksum: Boolean = true, barcodeFormats: List<BarcodeFormat> = listOf( ), msiPlesseyChecksumAlgorithm: MSIPlesseyChecksumAlgorithm = MSIPlesseyChecksumAlgorithm.MOD_10, australiaPostCustomerFormat: AustraliaPostCustomerFormat = AustraliaPostCustomerFormat.ALPHA_NUMERIC, lowPowerMode: Boolean = false, gs1Handling: Gs1Handling = Gs1Handling.PARSE)

Types

Companion

object Companion

Properties

acceptedDocumentFormats

var acceptedDocumentFormats: List<BarcodeDocumentFormat>

List of accepted barcode document formats.

australiaPostCustomerFormat

var australiaPostCustomerFormat: AustraliaPostCustomerFormat

The customer format used in AUSTRALIA_POST codes. The default value is ALPHA_NUMERIC. Default is ALPHA_NUMERIC

barcodeFormats

var barcodeFormats: List<BarcodeFormat>

List of accepted barcode symbologies.

barcodesExtensionFilter

var barcodesExtensionFilter: BarcodesExtensionFilter

Filter for extended EAN and UPC barcodes. Default is NO_FILTER

barcodesRegexFilter

var barcodesRegexFilter: 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). This option overrides barcodesExtensionFilter option. Default is ""

gs1Handling

var gs1Handling: Gs1Handling

The expected way of handling GS1_COMPOSITE barcodes. Default is PARSE

lowPowerMode

var lowPowerMode: Boolean

If true, enables a mode that slightly decreases scanning quality and energy consumption. Increases scanning speed. If false, the mode is disabled. The default is false. Android only. Default is false

maximumTextLength

var maximumTextLength: Int

Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only. Default is 0

minimum1DBarcodesQuietZone

var minimum1DBarcodesQuietZone: Int

Optional minimum required quiet zone on the barcode. Measured in modules (the smallest bar size on a barcode). The default is 10. NOTE - This feature works on ITF barcodes only. Default is 10

minimumTextLength

var minimumTextLength: Int

Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only. Default is 0

msiPlesseyChecksumAlgorithm

var msiPlesseyChecksumAlgorithm: MSIPlesseyChecksumAlgorithm

Checksum algorithm used for MSI Plessey barcodes. The default value is MOD_10. Default is MOD_10

stripCheckDigits

var stripCheckDigits: Boolean

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

useCode11Checksum

var useCode11Checksum: Boolean

If true, the optional check digit for CODE_11 codes is used in validation. The default is true. Default is true

useIATA2OF5Checksum

var useIATA2OF5Checksum: Boolean

If true, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is true. Default is true

Functions

toJson

fun toJson(): JsonObject