io.scanbot.barcodescanner.model

Class BarcodeScannerConfig

io.scanbot.barcodescanner.model.BarcodeScannerConfig

public class BarcodeScannerConfig

Entity represents configuration params for class BarcodeScanner

See Also:

class BarcodeScanner

Constructor Detail

BarcodeScannerConfig

public BarcodeScannerConfig(@NotNull
                            java.util.List<? extends io.scanbot.barcodescanner.model.BarcodeType> barcodeFormats,
                            boolean highSensitivityEnabled,
                            boolean disableMlDetector,
                            int minimumTextLength,
                            int maximumTextLength,
                            int minimum1DQuietZoneSize,
                            boolean gs1DecodingEnabled)

Entity represents configuration params for class BarcodeScanner

Parameters:

barcodeFormats - List of formats to scan. Defaults to BarcodeFormat.COMMON_CODES on SDK level.

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

disableMlDetector - Whether ML-based detection should be disabled. Default is false.

minimumTextLength - Minimum required text length of the detected barcode.The default value is 0 (the setting is turned off).NOTE: Currently works for ITF barcodes only!

maximumTextLength - Maximum text length of the detected barcode. Setting to zero removes the limit.The default value is 0 (the setting is turned off).NOTE: Currently works for ITF barcodes only!

minimum1DQuietZoneSize - Minimum required quiet zone on the barcode. Measured in modules (the size of a minimal bar on the barcode).The default value is 10.NOTE: Currently works for ITF barcodes only!

gs1DecodingEnabled - When set to true, the scanner assumes that the barcode can be a GS1 barcode.Turn it off, if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).The default is true.NOTE: Currently works for CODE128 barcodes only!

See Also:

class BarcodeScanner

Method Detail

getBarcodeFormats

@NotNull
public java.util.List<io.scanbot.barcodescanner.model.BarcodeType> getBarcodeFormats()

List of formats to scan.

Defaults to BarcodeFormat.COMMON_CODES on SDK level.

See Also:

BarcodeFormat.COMMON_CODES

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.

Default is false.

getMinimumTextLength

public int getMinimumTextLength()

Minimum required text length of the detected barcode.

The default value is 0 (the setting is turned off).NOTE: Currently works for ITF barcodes only!

getMaximumTextLength

public int getMaximumTextLength()

Maximum text length of the detected barcode.

Setting to zero removes the limit.The default value is 0 (the setting is turned off).NOTE: Currently works for ITF barcodes only!

getMinimum1DQuietZoneSize

public int getMinimum1DQuietZoneSize()

Minimum required quiet zone on the barcode.

Measured in modules (the size of a minimal bar on the barcode).The default value is 10.NOTE: Currently works for ITF barcodes only!

getGs1DecodingEnabled

public boolean getGs1DecodingEnabled()

When set to

true, the scanner assumes that the barcode can be a GS1 barcode.Turn it off, if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).The default is true.NOTE: Currently works for CODE128 barcodes only!

component1

@NotNull
public java.util.List<io.scanbot.barcodescanner.model.BarcodeType> component1()

List of formats to scan.

Defaults to BarcodeFormat.COMMON_CODES on SDK level.

See Also:

BarcodeFormat.COMMON_CODES

component2

public boolean component2()

Whether high sensitivity scanning mode should be enabled.

Defaults to false

component3

public boolean component3()

Whether ML-based detection should be disabled.

Default is false.

component4

public int component4()

Minimum required text length of the detected barcode.

The default value is 0 (the setting is turned off).NOTE: Currently works for ITF barcodes only!

component5

public int component5()

Maximum text length of the detected barcode.

Setting to zero removes the limit.The default value is 0 (the setting is turned off).NOTE: Currently works for ITF barcodes only!

component6

public int component6()

Minimum required quiet zone on the barcode.

Measured in modules (the size of a minimal bar on the barcode).The default value is 10.NOTE: Currently works for ITF barcodes only!

component7

public boolean component7()

When set to

true, the scanner assumes that the barcode can be a GS1 barcode.Turn it off, if you don't want to see decoded FNC1 characters ("]C1" and ASCII char 29).The default is true.NOTE: Currently works for CODE128 barcodes only!

copy

@NotNull
public BarcodeScannerConfig copy(@NotNull
                                          java.util.List<? extends io.scanbot.barcodescanner.model.BarcodeType> barcodeFormats,
                                          boolean highSensitivityEnabled,
                                          boolean disableMlDetector,
                                          int minimumTextLength,
                                          int maximumTextLength,
                                          int minimum1DQuietZoneSize,
                                          boolean gs1DecodingEnabled)

Entity represents configuration params for class BarcodeScanner

See Also:

class BarcodeScanner

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

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