All Implemented Interfaces:: android.os.Parcelable


public final class BarcodeScannerConfiguration
 implements Parcelable

Configuration for the barcode scanner.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private List<BarcodeFormatConfigurationBase>`	`barcodeFormatConfigurations`
`private List<BarcodeDocumentFormat>`	`extractedDocumentFormats`
`private Boolean`	`onlyAcceptDocuments`
`private Boolean`	`returnBarcodeImage`
`private BarcodeScannerEngineMode`	`engineMode`
`private Boolean`	`optimizedForOverlays`

Constructor Summary

Constructors
Constructor	Description
`BarcodeScannerConfiguration(Map<String, Object> source)`
`BarcodeScannerConfiguration(JSONObject json)`
`BarcodeScannerConfiguration(List<BarcodeFormatConfigurationBase> barcodeFormatConfigurations, List<BarcodeDocumentFormat> extractedDocumentFormats, Boolean onlyAcceptDocuments, Boolean returnBarcodeImage, BarcodeScannerEngineMode engineMode, Boolean optimizedForOverlays)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final List<BarcodeFormatConfigurationBase>`	`getBarcodeFormatConfigurations()`	Options for barcode decoding.
`final Unit`	`setBarcodeFormatConfigurations(List<BarcodeFormatConfigurationBase> barcodeFormatConfigurations)`	Options for barcode decoding.
`final List<BarcodeDocumentFormat>`	`getExtractedDocumentFormats()`	List of document formats to be extracted.
`final Unit`	`setExtractedDocumentFormats(List<BarcodeDocumentFormat> extractedDocumentFormats)`	List of document formats to be extracted.
`final Boolean`	`getOnlyAcceptDocuments()`	If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
`final Unit`	`setOnlyAcceptDocuments(Boolean onlyAcceptDocuments)`	If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
`final Boolean`	`getReturnBarcodeImage()`	If true, the barcode image will be returned in the BarcodeItem.
`final Unit`	`setReturnBarcodeImage(Boolean returnBarcodeImage)`	If true, the barcode image will be returned in the BarcodeItem.
`final BarcodeScannerEngineMode`	`getEngineMode()`	The engine mode for barcode scanning.
`final Unit`	`setEngineMode(BarcodeScannerEngineMode engineMode)`	The engine mode for barcode scanning.
`final Boolean`	`getOptimizedForOverlays()`	If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image.
`final Unit`	`setOptimizedForOverlays(Boolean optimizedForOverlays)`	If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final BarcodeScannerConfiguration`	`clone()`
`final static BarcodeScannerConfiguration`	`default()`

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

- Constructor Detail
  - BarcodeScannerConfiguration
```
BarcodeScannerConfiguration(Map<String, Object> source)
```
  - BarcodeScannerConfiguration
```
BarcodeScannerConfiguration(JSONObject json)
```
  - BarcodeScannerConfiguration
```
BarcodeScannerConfiguration(List<BarcodeFormatConfigurationBase> barcodeFormatConfigurations, List<BarcodeDocumentFormat> extractedDocumentFormats, Boolean onlyAcceptDocuments, Boolean returnBarcodeImage, BarcodeScannerEngineMode engineMode, Boolean optimizedForOverlays)
```
- Method Detail
  - getBarcodeFormatConfigurations
```
 final List<BarcodeFormatConfigurationBase> getBarcodeFormatConfigurations()
```
    Options for barcode decoding.
  - setBarcodeFormatConfigurations
```
 final Unit setBarcodeFormatConfigurations(List<BarcodeFormatConfigurationBase> barcodeFormatConfigurations)
```
    Options for barcode decoding.
  - getExtractedDocumentFormats
```
 final List<BarcodeDocumentFormat> getExtractedDocumentFormats()
```
    List of document formats to be extracted. Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document. By default all supported barcode document formats are accepted. If empty, no barcodes will be parsed into documents. To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true.
  - setExtractedDocumentFormats
```
 final Unit setExtractedDocumentFormats(List<BarcodeDocumentFormat> extractedDocumentFormats)
```
    List of document formats to be extracted. Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document. By default all supported barcode document formats are accepted. If empty, no barcodes will be parsed into documents. To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true.
  - getOnlyAcceptDocuments
```
 final Boolean getOnlyAcceptDocuments()
```
    If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
    Default is false
  - setOnlyAcceptDocuments
```
 final Unit setOnlyAcceptDocuments(Boolean onlyAcceptDocuments)
```
    If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.
    Default is false
  - getReturnBarcodeImage
```
 final Boolean getReturnBarcodeImage()
```
    If true, the barcode image will be returned in the BarcodeItem.
    Default is false
  - setReturnBarcodeImage
```
 final Unit setReturnBarcodeImage(Boolean returnBarcodeImage)
```
    If true, the barcode image will be returned in the BarcodeItem.
    Default is false
  - getEngineMode
```
 final BarcodeScannerEngineMode getEngineMode()
```
    The engine mode for barcode scanning.
    Default is NEXT_GEN
  - setEngineMode
```
 final Unit setEngineMode(BarcodeScannerEngineMode engineMode)
```
    The engine mode for barcode scanning.
    Default is NEXT_GEN
  - getOptimizedForOverlays
```
 final Boolean getOptimizedForOverlays()
```
    If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image. This will also produce stabler barcode outlines across frames for use cases such as AR.
    Default is false
  - setOptimizedForOverlays
```
 final Unit setOptimizedForOverlays(Boolean optimizedForOverlays)
```
    If true, the quads of linear (1D) barcodes will be further refined to more closely match the barcode's outline in the input image. This will also produce stabler barcode outlines across frames for use cases such as AR.
    Default is false
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final BarcodeScannerConfiguration clone()
```
  - default
```
 final static BarcodeScannerConfiguration default()
```

Class BarcodeScannerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BarcodeScannerConfiguration

BarcodeScannerConfiguration

BarcodeScannerConfiguration

Method Detail

getBarcodeFormatConfigurations

setBarcodeFormatConfigurations

getExtractedDocumentFormats

setExtractedDocumentFormats

getOnlyAcceptDocuments

setOnlyAcceptDocuments

getReturnBarcodeImage

setReturnBarcodeImage

getEngineMode

setEngineMode

getOptimizedForOverlays

setOptimizedForOverlays

toJson

clone

default