Configuration for the barcode scanner.

Constructors

Properties

Configuration to accumulate barcodes across multiple frames in live mode.

Default Value

new BarcodeAccumulationConfiguration({});
barcodeFormatConfigurations: BarcodeFormatConfigurationBase[]

Options for barcode decoding.

Default Value

[new BarcodeFormatCommonConfiguration({})];

The engine mode for barcode scanning.

Default Value

"NEXT_GEN_LOW_POWER";
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.

Default Value

["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC", "BRITISH_COLUMBIA_DRIVER_LICENSE"];
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 Value

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 Value

false;
processingMode: ProcessingMode

Scanners typically can produce better results from a single image if they are allowed to spend a longer time analyzing it.

On the other hand, scanners can produce even better results if they can analyze multiple images of the same subject and cross-check and combine the results. The processing mode tells the scanner whether to optimize for single or multiple images of a subject.

Default Value

"AUTO";
returnBarcodeImage: boolean

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

Default Value

false;

Generated using TypeDoc