blinkid-core/com.microblink.blinkid.core.settings.scanning/BarcodeModuleSettings

BarcodeModuleSettings

data class BarcodeModuleSettings(val presenceMandatory: Boolean = false, val barcodeImageReturnEnabled: Boolean = false, val pdf417ScanningEnabled: Boolean = true, val qrScanningEnabled: Boolean = true, val upceScanningEnabled: Boolean = false, val upcaScanningEnabled: Boolean = false, val code128ScanningEnabled: Boolean = false, val code39ScanningEnabled: Boolean = false, val ean8ScanningEnabled: Boolean = false, val ean13ScanningEnabled: Boolean = false, val itfScanningEnabled: Boolean = false, val dataMatrixScanningEnabled: Boolean = false) : Parcelable

Settings for the barcode extraction module.

This module manages the detection and data extraction from various 1D and 2D barcode formats (such as PDF417, QR codes, and various retail codes).

It can operate as a standalone module or in combination with document capture.

Constructors

BarcodeModuleSettings

constructor(presenceMandatory: Boolean = false, barcodeImageReturnEnabled: Boolean = false, pdf417ScanningEnabled: Boolean = true, qrScanningEnabled: Boolean = true, upceScanningEnabled: Boolean = false, upcaScanningEnabled: Boolean = false, code128ScanningEnabled: Boolean = false, code39ScanningEnabled: Boolean = false, ean8ScanningEnabled: Boolean = false, ean13ScanningEnabled: Boolean = false, itfScanningEnabled: Boolean = false, dataMatrixScanningEnabled: Boolean = false)

Properties

barcodeImageReturnEnabled

val barcodeImageReturnEnabled: Boolean

Indicates whether the barcode image should be returned in the result. The DPI setting and the extension factor do not affect returned barcode image. Defaults to false.

code128ScanningEnabled

val code128ScanningEnabled: Boolean

Enables the scanning and processing of Code-128 barcodes. This setting can be enabled only if documentCaptureEnabled is disabled. Defaults to false.

code39ScanningEnabled

val code39ScanningEnabled: Boolean

Enables the scanning and processing of Code-39 barcodes. This setting can be enabled only if documentCaptureEnabled is disabled. Defaults to false.

dataMatrixScanningEnabled

val dataMatrixScanningEnabled: Boolean

ean13ScanningEnabled

val ean13ScanningEnabled: Boolean

Enables the scanning and processing of EAN-13 barcodes. This setting can be enabled only if documentCaptureEnabled is disabled. Defaults to false.

ean8ScanningEnabled

val ean8ScanningEnabled: Boolean

Enables the scanning and processing of EAN-8 barcodes. This setting can be enabled only if documentCaptureEnabled is disabled. Defaults to false.

itfScanningEnabled

val itfScanningEnabled: Boolean

Enables the scanning and processing of ITF barcodes. This setting can be enabled only if documentCaptureEnabled is disabled. Defaults to false.

pdf417ScanningEnabled

val pdf417ScanningEnabled: Boolean

Enables the scanning and processing of Pdf417 barcodes. PDF417 and QR scanning must be enabled or disabled together because the analyzer detects their presence as a shared barcode signal. If only one is enabled, session initialization fails with a settings validation error. Defaults to true.

presenceMandatory

val presenceMandatory: Boolean

If set to true, barcode presence becomes mandatory for the scanned document. For Single ScanningMode, the barcode must be present on the scanned side. For Automatic ScanningMode, the barcode must be present on one of the scanned sides. In case of a timeout and advancement to the next step in the scanning flow, if a barcode is detected on the scanned side but cannot be extracted, the presence requirement is considered fulfilled. As a result, barcode extraction will no longer be a requirement to complete the scan on next side. Defaults to false.

qrScanningEnabled

val qrScanningEnabled: Boolean

Enables the scanning and processing of QR barcodes. PDF417 and QR scanning must be enabled or disabled together because the analyzer detects their presence as a shared barcode signal. If only one is enabled, session initialization fails with a settings validation error. Defaults to true.

upcaScanningEnabled

val upcaScanningEnabled: Boolean

Enables the scanning and processing of UPC-A barcodes. This setting can be enabled only if documentCaptureEnabled is disabled. Defaults to false.

upceScanningEnabled

val upceScanningEnabled: Boolean

Enables the scanning and processing of UPC-E barcodes. This setting can be enabled only if documentCaptureEnabled is disabled. Defaults to false.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)