CommonBarcodeScannerConfiguration class

Configuration of the scanning behavior.

Constructors

CommonBarcodeScannerConfiguration.new({List<BarcodeDocumentFormat>? extractedDocumentFormats, bool onlyAcceptDocuments = false, UpcEanExtensionBehavior extensions = UpcEanExtensionBehavior.ALLOW_ANY, String barcodesRegexFilter = "", double minimumSizeScore = 0.0, int minimumTextLength = 0, int maximumTextLength = 0, int minimum1DBarcodesQuietZone = 10, bool stripCheckDigits = false, bool useIATA2OF5Checksum = true, bool useCode11Checksum = true, List<BarcodeFormat>? barcodeFormats, MsiPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm = MsiPlesseyChecksumAlgorithm.MOD_10, AustraliaPostCustomerFormat australiaPostCustomerFormat = AustraliaPostCustomerFormat.ALPHA_NUMERIC, bool lowPowerMode = false, Gs1Handling gs1Handling = Gs1Handling.PARSE, bool returnBarcodeImage = false})

CommonBarcodeScannerConfiguration.fromJson(Map<String, dynamic> json)

factory

Properties

australiaPostCustomerFormat ↔ AustraliaPostCustomerFormat

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

getter/setter pair

barcodeFormats ↔ List<BarcodeFormat>

List of accepted barcode symbologies.

getter/setter pair

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.

getter/setter pair

extensions ↔ UpcEanExtensionBehavior

Filter for extended EAN and UPC barcodes.

getter/setter pair

extractedDocumentFormats ↔ List<BarcodeDocumentFormat>

List of document formats to be extracted.

getter/setter pair

gs1Handling ↔ Gs1Handling

The expected way of handling GS1_COMPOSITE barcodes.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

lowPowerMode ↔ bool

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.

getter/setter pair

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.

getter/setter pair

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.

getter/setter pair

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.

getter/setter pair

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.

getter/setter pair

msiPlesseyChecksumAlgorithm ↔ MsiPlesseyChecksumAlgorithm

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

getter/setter pair

onlyAcceptDocuments ↔ bool

If true and extractedDocumentFormats is not empty, then barcodes that do not decode to one of the accepted document formats will be ignored.

getter/setter pair

returnBarcodeImage ↔ bool

If true, the barcode image is returned in the result.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stripCheckDigits ↔ bool

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.

getter/setter pair

useCode11Checksum ↔ bool

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

getter/setter pair

useIATA2OF5Checksum ↔ bool

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

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson({ToJsonConfiguration? config}) → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited