Class BarcodeScannerConfig
-
- All Implemented Interfaces:
public final class BarcodeScannerConfig
Entity represents configuration params for BarcodeScanner
-
-
Field Summary
Fields Modifier and Type Field Description private final List<BarcodeType>
barcodeFormats
private final BarcodeScanner.CoreEngineMode
coreEngineMode
private final Integer
minimumTextLength
private final Integer
maximumTextLength
private final Integer
minimum1DQuietZoneSize
private final Integer
gs1Handling
private final Integer
msiPlesseyChecksumAlgorithms
private final Boolean
stripCheckDigits
private final Boolean
lowPowerMode
private final Integer
codeDensity
-
Constructor Summary
Constructors Constructor Description BarcodeScannerConfig(List<BarcodeType> barcodeFormats, BarcodeScanner.CoreEngineMode coreEngineMode, Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Integer gs1Handling, Integer msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Integer codeDensity)
-
Method Summary
Modifier and Type Method Description final List<BarcodeType>
getBarcodeFormats()
List of formats to scan. final BarcodeScanner.CoreEngineMode
getCoreEngineMode()
Defines used engine mode. final Integer
getMinimumTextLength()
Minimum required text length of the detected barcode. final Integer
getMaximumTextLength()
Maximum text length of the detected barcode. final Integer
getMinimum1DQuietZoneSize()
Minimum required quiet zone on the barcode. final Integer
getGs1Handling()
Handling mode for GS1-formatted results. final Integer
getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. final Boolean
getStripCheckDigits()
If true, check digits for UPC, EAN and MSI Plessey codes are removed from result. final Boolean
getLowPowerMode()
If true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed.final Integer
getCodeDensity()
The expected density of QR codes. -
-
Constructor Detail
-
BarcodeScannerConfig
BarcodeScannerConfig(List<BarcodeType> barcodeFormats, BarcodeScanner.CoreEngineMode coreEngineMode, Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DQuietZoneSize, Integer gs1Handling, Integer msiPlesseyChecksumAlgorithms, Boolean stripCheckDigits, Boolean lowPowerMode, Integer codeDensity)
-
-
Method Detail
-
getBarcodeFormats
final List<BarcodeType> getBarcodeFormats()
List of formats to scan. Defaults to BarcodeFormat.COMMON_CODES on SDK level.
-
getCoreEngineMode
final BarcodeScanner.CoreEngineMode getCoreEngineMode()
Defines used engine mode.
-
getMinimumTextLength
final Integer getMinimumTextLength()
Minimum required text length of the detected barcode. The default value is 0 (the setting is turned off). NOTE: Currently works for ITF and MSI Plessey barcodes only!
-
getMaximumTextLength
final Integer getMaximumTextLength()
Maximum text length of the detected 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!
-
getMinimum1DQuietZoneSize
final Integer getMinimum1DQuietZoneSize()
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!
-
getGs1Handling
final Integer getGs1Handling()
Handling mode for GS1-formatted results.
-
getMsiPlesseyChecksumAlgorithms
final Integer getMsiPlesseyChecksumAlgorithms()
The checksum algorithms for MSI Plessey barcodes. The default value is MSIPlesseyChecksumAlgorithm.Mod10.
-
getStripCheckDigits
final Boolean getStripCheckDigits()
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
-
getLowPowerMode
final Boolean getLowPowerMode()
If
true
, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. Iffalse
- mode is disabled. The default isfalse
-
getCodeDensity
final Integer getCodeDensity()
The expected density of QR codes. A higher density finds more QR codes in an image but the performance is slightly reduced. By default is 0 - CodeDensity.LOW
-
-
-
-