Class BarcodeScannerConfiguration

Configuration for the barcode scanner.

Hierarchy

Constructors

Properties

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"];
live: boolean

If true, the barcode scanning will be performed in live mode.

Default Value

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 Value

false;
returnBarcodeImage: boolean

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

Default Value

false;

Generated using TypeDoc