Configuration for the barcode scanner.

Hierarchy (view full)

Constructors

Properties

barcodeFormatConfigurations: BarcodeFormatConfigurationBase[]

Options for barcode decoding.

The engine mode for barcode scanning.

Default is NEXT_GEN

extractedDocumentFormats: BarcodeDocumentFormat[]

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.

onlyAcceptDocuments: boolean

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

optimizedForOverlays: boolean

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

returnBarcodeImage: boolean

If true, the barcode image will be returned in the BarcodeItem.

Default is false