io.scanbot.sdk.ui.view.barcode.configuration

Class BarcodeScannerAdditionalConfiguration

io.scanbot.sdk.ui.view.barcode.configuration.BarcodeScannerAdditionalConfiguration

public class BarcodeScannerAdditionalConfiguration

Entity represents additional configuration params for ScanbotBarcodeDetector.

Note: only a few barcode types support these params - for the rest these settings will have no influence. Please read each param documentation carefully before modifying.

Note: in future these params might change their behavior. If you you use non-default values in your code please read changelogs of future versions carefully to avoid subtle changes in application logic.

Constructor Detail

BarcodeScannerAdditionalConfiguration

public BarcodeScannerAdditionalConfiguration(int minimumTextLength,
                                             int maximumTextLength,
                                             int minimum1DQuietZoneSize,
                                             boolean gs1DecodingEnabled)

Entity represents additional configuration params for ScanbotBarcodeDetector.

Note: only a few barcode types support these params - for the rest these settings will have no influence. Please read each param documentation carefully before modifying.

Note: in future these params might change their behavior. If you you use non-default values in your code please read changelogs of future versions carefully to avoid subtle changes in application logic.

Parameters:

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!

BarcodeScannerAdditionalConfiguration

public BarcodeScannerAdditionalConfiguration()

Entity represents additional configuration params for ScanbotBarcodeDetector.

Note: only a few barcode types support these params - for the rest these settings will have no influence. Please read each param documentation carefully before modifying.

Note: in future these params might change their behavior. If you you use non-default values in your code please read changelogs of future versions carefully to avoid subtle changes in application logic.

Method Detail

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

public int component1()

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!

component2

public int component2()

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!

component3

public int component3()

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!

component4

public boolean component4()

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 BarcodeScannerAdditionalConfiguration copy(int minimumTextLength,
                                                           int maximumTextLength,
                                                           int minimum1DQuietZoneSize,
                                                           boolean gs1DecodingEnabled)

Entity represents additional configuration params for ScanbotBarcodeDetector.

Note: only a few barcode types support these params - for the rest these settings will have no influence. Please read each param documentation carefully before modifying.

Note: in future these params might change their behavior. If you you use non-default values in your code please read changelogs of future versions carefully to avoid subtle changes in application logic.

toString

@NotNull
public java.lang.String toString()

hashCode

public int hashCode()

equals

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