io.scanbot.sdk.barcode.entity

Class BarcodeScannerConfig

io.scanbot.sdk.barcode.entity.BarcodeScannerConfig

public class BarcodeScannerConfig

Entity represents configuration params for interface ScanbotBarcodeDetector

See Also:

interface ScanbotBarcodeDetector

Constructor Detail

BarcodeScannerConfig

public BarcodeScannerConfig(@NotNull
                            java.util.List<? extends io.scanbot.sdk.barcode.entity.BarcodeFormat> barcodeFormats,
                            @NotNull
                            java.util.List<? extends io.scanbot.sdk.barcode.entity.BarcodeDocumentFormat> acceptedDocumentFormats,
                            boolean highSensitivityEnabled,
                            boolean disableMlDetector,
                            boolean saveCameraPreviewFrame,
                            @NotNull
                            BarcodeScannerAdditionalConfig additionalConfig)

Entity represents configuration params for interface ScanbotBarcodeDetector

Parameters:

barcodeFormats - List of enum BarcodeFormat to scan. Defaults to BarcodeFormat.COMMON_CODES

acceptedDocumentFormats - List of enum BarcodeDocumentFormat to scan. Defaults to empty list,meaning no filtering is done and all formats are accepted.

highSensitivityEnabled - Whether high sensitivity scanning mode should be enabled. Defaults to false

disableMlDetector -

Whether ML-based detection should be disabled.

BarcodeDetectorType.ML_BASED uses ML mechanisms. while BarcodeDetectorType.PLAIN might work much faster if it is needed to scan just one QR code or PDF-417 which is clearly visible.

Default is false.

saveCameraPreviewFrame -

Whether detector should save a frame with successful detection result. If true - class BarcodeScanningResult will contain the camera preview frame Bitmap, otherwise the preview frame will not be collected.

Defaults to false.

additionalConfig - Additional config wrapped into separate entity.

See Also:

interface ScanbotBarcodeDetector

BarcodeScannerConfig

public BarcodeScannerConfig()

Entity represents configuration params for interface ScanbotBarcodeDetector

See Also:

interface ScanbotBarcodeDetector

Method Detail

getBarcodeFormats

@NotNull
public java.util.List<io.scanbot.sdk.barcode.entity.BarcodeFormat> getBarcodeFormats()

List of

enum BarcodeFormat to scan. Defaults to BarcodeFormat.COMMON_CODES

See Also:

enum BarcodeFormat

getAcceptedDocumentFormats

@NotNull
public java.util.List<io.scanbot.sdk.barcode.entity.BarcodeDocumentFormat> getAcceptedDocumentFormats()

List of

enum BarcodeDocumentFormat to scan. Defaults to empty list,meaning no filtering is done and all formats are accepted.

See Also:

enum BarcodeDocumentFormat

getHighSensitivityEnabled

public boolean getHighSensitivityEnabled()

Whether high sensitivity scanning mode should be enabled.

Defaults to false

getDisableMlDetector

public boolean getDisableMlDetector()

Whether ML-based detection should be disabled.

BarcodeDetectorType.ML_BASED uses ML mechanisms. while BarcodeDetectorType.PLAIN might work much faster if it is needed to scan just one QR code or PDF-417 which is clearly visible.

Default is false.

getSaveCameraPreviewFrame

public boolean getSaveCameraPreviewFrame()

Whether detector should save a frame with successful detection result. If true - class BarcodeScanningResult will contain the camera preview frame Bitmap, otherwise the preview frame will not be collected.

Defaults to false.

See Also:

class BarcodeScanningResult, Bitmap

getAdditionalConfig

@NotNull
public BarcodeScannerAdditionalConfig getAdditionalConfig()

Additional config wrapped into separate entity.

See Also:

class BarcodeScannerAdditionalConfig

component1

@NotNull
public java.util.List<io.scanbot.sdk.barcode.entity.BarcodeFormat> component1()

List of

enum BarcodeFormat to scan. Defaults to BarcodeFormat.COMMON_CODES

See Also:

enum BarcodeFormat

component2

@NotNull
public java.util.List<io.scanbot.sdk.barcode.entity.BarcodeDocumentFormat> component2()

List of

enum BarcodeDocumentFormat to scan. Defaults to empty list,meaning no filtering is done and all formats are accepted.

See Also:

enum BarcodeDocumentFormat

component3

public boolean component3()

Whether high sensitivity scanning mode should be enabled.

Defaults to false

component4

public boolean component4()

Whether ML-based detection should be disabled.

BarcodeDetectorType.ML_BASED uses ML mechanisms. while BarcodeDetectorType.PLAIN might work much faster if it is needed to scan just one QR code or PDF-417 which is clearly visible.

Default is false.

component5

public boolean component5()

Whether detector should save a frame with successful detection result. If true - class BarcodeScanningResult will contain the camera preview frame Bitmap, otherwise the preview frame will not be collected.

Defaults to false.

See Also:

class BarcodeScanningResult, Bitmap

component6

@NotNull
public BarcodeScannerAdditionalConfig component6()

Additional config wrapped into separate entity.

See Also:

class BarcodeScannerAdditionalConfig

copy

@NotNull
public BarcodeScannerConfig copy(@NotNull
                                          java.util.List<? extends io.scanbot.sdk.barcode.entity.BarcodeFormat> barcodeFormats,
                                          @NotNull
                                          java.util.List<? extends io.scanbot.sdk.barcode.entity.BarcodeDocumentFormat> acceptedDocumentFormats,
                                          boolean highSensitivityEnabled,
                                          boolean disableMlDetector,
                                          boolean saveCameraPreviewFrame,
                                          @NotNull
                                          BarcodeScannerAdditionalConfig additionalConfig)

Entity represents configuration params for interface ScanbotBarcodeDetector

See Also:

interface ScanbotBarcodeDetector

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

public boolean equals(@Nullable
                      java.lang.Object p)