Package io.scanbot.sdk.barcode.entity
Class BarcodeScannerConfig
-
- All Implemented Interfaces:
public final class BarcodeScannerConfig
Entity represents configuration params for ScanbotBarcodeDetector
-
-
Field Summary
Fields Modifier and Type Field Description private final List<BarcodeFormat>
barcodeFormats
private final List<BarcodeDocumentFormat>
acceptedDocumentFormats
private final EngineMode
engineMode
private final Boolean
saveCameraPreviewFrame
private final BarcodeScannerAdditionalConfig
additionalConfig
-
Constructor Summary
Constructors Constructor Description BarcodeScannerConfig(List<BarcodeFormat> barcodeFormats, List<BarcodeDocumentFormat> acceptedDocumentFormats, EngineMode engineMode, Boolean saveCameraPreviewFrame, BarcodeScannerAdditionalConfig additionalConfig)
-
Method Summary
Modifier and Type Method Description final List<BarcodeFormat>
getBarcodeFormats()
List of BarcodeFormat to scan. final List<BarcodeDocumentFormat>
getAcceptedDocumentFormats()
List of BarcodeDocumentFormat to scan. final EngineMode
getEngineMode()
Defines barcode detection mode to be used. final Boolean
getSaveCameraPreviewFrame()
Whether detector should save a frame with successful detection result. final BarcodeScannerAdditionalConfig
getAdditionalConfig()
Additional config wrapped into separate entity. -
-
Constructor Detail
-
BarcodeScannerConfig
BarcodeScannerConfig(List<BarcodeFormat> barcodeFormats, List<BarcodeDocumentFormat> acceptedDocumentFormats, EngineMode engineMode, Boolean saveCameraPreviewFrame, BarcodeScannerAdditionalConfig additionalConfig)
-
-
Method Detail
-
getBarcodeFormats
final List<BarcodeFormat> getBarcodeFormats()
List of BarcodeFormat to scan. Defaults to BarcodeFormat.COMMON_CODES
-
getAcceptedDocumentFormats
final List<BarcodeDocumentFormat> getAcceptedDocumentFormats()
List of BarcodeDocumentFormat to scan. Defaults to empty list, meaning no filtering is done and all formats are accepted.
-
getEngineMode
final EngineMode getEngineMode()
Defines barcode detection mode to be used. The default is EngineMode.NextGen.
-
getSaveCameraPreviewFrame
final Boolean getSaveCameraPreviewFrame()
Whether detector should save a frame with successful detection result. If
true
- BarcodeScanningResult will contain the camera preview frame Bitmap, otherwise the preview frame will not be collected.Defaults to
false
.
-
getAdditionalConfig
final BarcodeScannerAdditionalConfig getAdditionalConfig()
Additional config wrapped into separate entity.
-
-
-
-