All Implemented Interfaces:: android.os.Parcelable


public final class BarcodeRecognizerConfiguration
 implements Parcelable

Configuration of the scanning behavior.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private List<BarcodeDocumentFormat>`	`acceptedDocumentFormats`
`private BarcodesExtensionFilter`	`barcodesExtensionFilter`
`private Integer`	`minimumTextLength`
`private Integer`	`maximumTextLength`
`private Integer`	`minimum1DBarcodesQuietZone`
`private Boolean`	`stripCheckDigits`
`private List<BarcodeFormat>`	`barcodeFormats`
`private MSIPlesseyChecksumAlgorithm`	`msiPlesseyChecksumAlgorithm`
`private Boolean`	`lowPowerMode`
`private CodeDensity`	`codeDensity`
`private Gs1Handling`	`gs1Handling`

Constructor Summary

Constructors
Constructor	Description
`BarcodeRecognizerConfiguration(Map<String, Object> json)`
`BarcodeRecognizerConfiguration()`
`BarcodeRecognizerConfiguration(List<BarcodeDocumentFormat> acceptedDocumentFormats, BarcodesExtensionFilter barcodesExtensionFilter, Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DBarcodesQuietZone, Boolean stripCheckDigits, List<BarcodeFormat> barcodeFormats, MSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm, Boolean lowPowerMode, CodeDensity codeDensity, Gs1Handling gs1Handling)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final List<BarcodeDocumentFormat>`	`getAcceptedDocumentFormats()`	List of accepted barcode document formats.
`final Unit`	`setAcceptedDocumentFormats(List<BarcodeDocumentFormat> acceptedDocumentFormats)`	List of accepted barcode document formats.
`final BarcodesExtensionFilter`	`getBarcodesExtensionFilter()`	Filter for extended EAN and UPC barcodes.
`final Unit`	`setBarcodesExtensionFilter(BarcodesExtensionFilter barcodesExtensionFilter)`	Filter for extended EAN and UPC barcodes.
`final Integer`	`getMinimumTextLength()`	Optional minimum required text length of the detected barcode.
`final Unit`	`setMinimumTextLength(Integer minimumTextLength)`	Optional minimum required text length of the detected barcode.
`final Integer`	`getMaximumTextLength()`	Optional maximum text length of the detected barcode.
`final Unit`	`setMaximumTextLength(Integer maximumTextLength)`	Optional maximum text length of the detected barcode.
`final Integer`	`getMinimum1DBarcodesQuietZone()`	Optional minimum required quiet zone on the barcode.
`final Unit`	`setMinimum1DBarcodesQuietZone(Integer minimum1DBarcodesQuietZone)`	Optional minimum required quiet zone on the barcode.
`final Boolean`	`getStripCheckDigits()`	If `true`, check digits for UPC, EAN and MSI Plessey codes are removed from the result.
`final Unit`	`setStripCheckDigits(Boolean stripCheckDigits)`	If `true`, check digits for UPC, EAN and MSI Plessey codes are removed from the result.
`final List<BarcodeFormat>`	`getBarcodeFormats()`	List of accepted barcode symbologies.
`final Unit`	`setBarcodeFormats(List<BarcodeFormat> barcodeFormats)`	List of accepted barcode symbologies.
`final MSIPlesseyChecksumAlgorithm`	`getMsiPlesseyChecksumAlgorithm()`	Checksum algorithm used for MSI Plessey barcodes.
`final Unit`	`setMsiPlesseyChecksumAlgorithm(MSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm)`	Checksum algorithm used for MSI Plessey barcodes.
`final Boolean`	`getLowPowerMode()`	If `true`, enables a mode that slightly decreases scanning quality and energy consumption.
`final Unit`	`setLowPowerMode(Boolean lowPowerMode)`	If `true`, enables a mode that slightly decreases scanning quality and energy consumption.
`final CodeDensity`	`getCodeDensity()`	The expected quantity of QR codes in an image.
`final Unit`	`setCodeDensity(CodeDensity codeDensity)`	The expected quantity of QR codes in an image.
`final Gs1Handling`	`getGs1Handling()`	The expected way of handling GS1_COMPOSITE barcodes.
`final Unit`	`setGs1Handling(Gs1Handling gs1Handling)`	The expected way of handling GS1_COMPOSITE barcodes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BarcodeRecognizerConfiguration
```
BarcodeRecognizerConfiguration(Map<String, Object> json)
```
  - BarcodeRecognizerConfiguration
```
BarcodeRecognizerConfiguration()
```
  - BarcodeRecognizerConfiguration
```
BarcodeRecognizerConfiguration(List<BarcodeDocumentFormat> acceptedDocumentFormats, BarcodesExtensionFilter barcodesExtensionFilter, Integer minimumTextLength, Integer maximumTextLength, Integer minimum1DBarcodesQuietZone, Boolean stripCheckDigits, List<BarcodeFormat> barcodeFormats, MSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm, Boolean lowPowerMode, CodeDensity codeDensity, Gs1Handling gs1Handling)
```
- Method Detail
  - getAcceptedDocumentFormats
```
 final List<BarcodeDocumentFormat> getAcceptedDocumentFormats()
```
    List of accepted barcode document formats.
  - setAcceptedDocumentFormats
```
 final Unit setAcceptedDocumentFormats(List<BarcodeDocumentFormat> acceptedDocumentFormats)
```
    List of accepted barcode document formats.
  - getBarcodesExtensionFilter
```
 final BarcodesExtensionFilter getBarcodesExtensionFilter()
```
    Filter for extended EAN and UPC barcodes.
  - setBarcodesExtensionFilter
```
 final Unit setBarcodesExtensionFilter(BarcodesExtensionFilter barcodesExtensionFilter)
```
    Filter for extended EAN and UPC barcodes.
  - getMinimumTextLength
```
 final Integer getMinimumTextLength()
```
    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.
  - setMinimumTextLength
```
 final Unit setMinimumTextLength(Integer minimumTextLength)
```
    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.
  - getMaximumTextLength
```
 final Integer getMaximumTextLength()
```
    Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
  - setMaximumTextLength
```
 final Unit setMaximumTextLength(Integer maximumTextLength)
```
    Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
  - getMinimum1DBarcodesQuietZone
```
 final Integer getMinimum1DBarcodesQuietZone()
```
    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.
  - setMinimum1DBarcodesQuietZone
```
 final Unit setMinimum1DBarcodesQuietZone(Integer minimum1DBarcodesQuietZone)
```
    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.
  - getStripCheckDigits
```
 final Boolean getStripCheckDigits()
```
    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.
  - setStripCheckDigits
```
 final Unit setStripCheckDigits(Boolean stripCheckDigits)
```
    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.
  - getBarcodeFormats
```
 final List<BarcodeFormat> getBarcodeFormats()
```
    List of accepted barcode symbologies.
  - setBarcodeFormats
```
 final Unit setBarcodeFormats(List<BarcodeFormat> barcodeFormats)
```
    List of accepted barcode symbologies.
  - getMsiPlesseyChecksumAlgorithm
```
 final MSIPlesseyChecksumAlgorithm getMsiPlesseyChecksumAlgorithm()
```
    Checksum algorithm used for MSI Plessey barcodes. The default value is MOD_10.
  - setMsiPlesseyChecksumAlgorithm
```
 final Unit setMsiPlesseyChecksumAlgorithm(MSIPlesseyChecksumAlgorithm msiPlesseyChecksumAlgorithm)
```
    Checksum algorithm used for MSI Plessey barcodes. The default value is MOD_10.
  - getLowPowerMode
```
 final Boolean getLowPowerMode()
```
    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.
  - setLowPowerMode
```
 final Unit setLowPowerMode(Boolean lowPowerMode)
```
    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.
  - getCodeDensity
```
 final CodeDensity getCodeDensity()
```
    The expected quantity of QR codes in an image.
  - setCodeDensity
```
 final Unit setCodeDensity(CodeDensity codeDensity)
```
    The expected quantity of QR codes in an image.
  - getGs1Handling
```
 final Gs1Handling getGs1Handling()
```
    The expected way of handling GS1_COMPOSITE barcodes.
  - setGs1Handling
```
 final Unit setGs1Handling(Gs1Handling gs1Handling)
```
    The expected way of handling GS1_COMPOSITE barcodes.

Class BarcodeRecognizerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BarcodeRecognizerConfiguration

BarcodeRecognizerConfiguration

BarcodeRecognizerConfiguration

Method Detail

getAcceptedDocumentFormats

setAcceptedDocumentFormats

getBarcodesExtensionFilter

setBarcodesExtensionFilter

getMinimumTextLength

setMinimumTextLength

getMaximumTextLength

setMaximumTextLength

getMinimum1DBarcodesQuietZone

setMinimum1DBarcodesQuietZone

getStripCheckDigits

setStripCheckDigits

getBarcodeFormats

setBarcodeFormats

getMsiPlesseyChecksumAlgorithm

setMsiPlesseyChecksumAlgorithm

getLowPowerMode

setLowPowerMode

getCodeDensity

setCodeDensity

getGs1Handling

setGs1Handling