Android Scanbot Barcode SDK/io.scanbot.sdk.barcode/BarcodeScannerConfiguration

BarcodeScannerConfiguration

data class BarcodeScannerConfiguration(var barcodeFormatConfigurations: List<BarcodeFormatConfigurationBase> = listOf( BarcodeFormatCommonConfiguration( ) ), var extractedDocumentFormats: List<BarcodeDocumentFormat> = listOf( BarcodeDocumentFormat.AAMVA, BarcodeDocumentFormat.BOARDING_PASS, BarcodeDocumentFormat.DE_MEDICAL_PLAN, BarcodeDocumentFormat.MEDICAL_CERTIFICATE, BarcodeDocumentFormat.ID_CARD_PDF_417, BarcodeDocumentFormat.SEPA, BarcodeDocumentFormat.SWISS_QR, BarcodeDocumentFormat.VCARD, BarcodeDocumentFormat.GS1, BarcodeDocumentFormat.HIBC, BarcodeDocumentFormat.BRITISH_COLUMBIA_DRIVER_LICENSE ), var onlyAcceptDocuments: Boolean = false, var returnBarcodeImage: Boolean = false, var accumulationConfig: BarcodeAccumulationConfiguration = BarcodeAccumulationConfiguration( ), var optimizedForOverlays: Boolean = false, var directAcceptanceAreaFraction: Double = 0.8, var engineMode: BarcodeScannerEngineMode = BarcodeScannerEngineMode.NEXT_GEN, var processingMode: ProcessingMode = ProcessingMode.AUTO) : Parcelable

Configuration for the barcode scanner.

Constructors

constructor(source: Map<String, Any?>)

constructor(json: JSONObject)

constructor(barcodeFormatConfigurations: List<BarcodeFormatConfigurationBase> = listOf( BarcodeFormatCommonConfiguration( ) ), extractedDocumentFormats: List<BarcodeDocumentFormat> = listOf( BarcodeDocumentFormat.AAMVA, BarcodeDocumentFormat.BOARDING_PASS, BarcodeDocumentFormat.DE_MEDICAL_PLAN, BarcodeDocumentFormat.MEDICAL_CERTIFICATE, BarcodeDocumentFormat.ID_CARD_PDF_417, BarcodeDocumentFormat.SEPA, BarcodeDocumentFormat.SWISS_QR, BarcodeDocumentFormat.VCARD, BarcodeDocumentFormat.GS1, BarcodeDocumentFormat.HIBC, BarcodeDocumentFormat.BRITISH_COLUMBIA_DRIVER_LICENSE ), onlyAcceptDocuments: Boolean = false, returnBarcodeImage: Boolean = false, accumulationConfig: BarcodeAccumulationConfiguration = BarcodeAccumulationConfiguration( ), optimizedForOverlays: Boolean = false, directAcceptanceAreaFraction: Double = 0.8, engineMode: BarcodeScannerEngineMode = BarcodeScannerEngineMode.NEXT_GEN, processingMode: ProcessingMode = ProcessingMode.AUTO)

Types

Companion

object Companion

Properties

accumulationConfig

var accumulationConfig: BarcodeAccumulationConfiguration

Configuration to accumulate barcodes across multiple frames in live mode.

barcodeFormatConfigurations

var barcodeFormatConfigurations: List<BarcodeFormatConfigurationBase>

Options for barcode decoding.

directAcceptanceAreaFraction

var directAcceptanceAreaFraction: Double

In single-shot mode, if the combined area of detected barcodes exceeds this fraction of the input image, the scanner returns the result immediately. Further scanning is skipped, even if more barcodes may be present. This can be used to accelerate scanning when barcode sizes are known in advance. To disable this behaviour, the value must be set to 1.0.

engineMode

var engineMode: BarcodeScannerEngineMode

The engine mode for barcode scanning.

extractedDocumentFormats

var extractedDocumentFormats: List<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

var 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.

optimizedForOverlays

var 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.

processingMode

var processingMode: ProcessingMode

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

returnBarcodeImage

var returnBarcodeImage: Boolean

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

Functions

clone

fun clone(): BarcodeScannerConfiguration

setBarcodeFormats

fun BarcodeScannerConfiguration.setBarcodeFormats(barcodeFormats: List<BarcodeFormat> = BarcodeFormatCommonConfiguration.default().formats)

Simplified extension configuration function that set the list of barcode formats to scan. By default, the most commonly used formats are enabled. Overrides BarcodeScannerConfiguration.barcodeFormatConfigurations list of configurations.

toJson

fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject