Package io.scanbot.sdk.barcode

Class BarcodeFormatCommonTwoDConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatCommonTwoDConfiguration

public class BarcodeFormatCommonTwoDConfiguration
extends BarcodeFormatConfigurationBase

Convenience configuration for enabling the scanning of multiple 2D codes with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple 2D codes. The given configuration will be applied to all enabled barcode formats, if they support it. You can override the common configuration for individual barcode formats by additionally adding their specific configuration to the scanner's configuration.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatCommonTwoDConfiguration()	Constructs BarcodeFormatCommonTwoDConfiguration with default parameters.
BarcodeFormatCommonTwoDConfiguration(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, Gs1Handling gs1Handling, boolean strictMode, CharacterEncoding fallbackEncoding, List<BarcodeFormat> formats)	Constructs BarcodeFormatCommonTwoDConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
CharacterEncoding	getFallbackEncoding()	Getter for fallbackEncoding field.
List<BarcodeFormat>	getFormats()	Getter for formats field.
Gs1Handling	getGs1Handling()	Getter for gs1Handling field.
boolean	getStrictMode()	Getter for strictMode field.
void	setFallbackEncoding(CharacterEncoding fallbackEncoding)	Setter for fallbackEncoding field.
void	setFormats(List<BarcodeFormat> formats)	Setter for formats field.
void	setGs1Handling(Gs1Handling gs1Handling)	Setter for gs1Handling field.
void	setStrictMode(boolean strictMode)	Setter for strictMode field.

Methods inherited from class io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

getAddAdditionalQuietZone, getMinimumSizeScore, getRegexFilter, setAddAdditionalQuietZone, setMinimumSizeScore, setRegexFilter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BarcodeFormatCommonTwoDConfiguration

public BarcodeFormatCommonTwoDConfiguration(String regexFilter,
 double minimumSizeScore,
 boolean addAdditionalQuietZone,
 Gs1Handling gs1Handling,
 boolean strictMode,
 CharacterEncoding fallbackEncoding,
 List<BarcodeFormat> formats)

Constructs BarcodeFormatCommonTwoDConfiguration with the given params.

Parameters:

regexFilter - Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). Default is `""`

minimumSizeScore - Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is. Default is `0`.

addAdditionalQuietZone - If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. This flag should be used to scan sharp crops of a barcode in single-shot mode. Default is `false`.

gs1Handling - GS1 message handling options. Default is `PARSE`.

strictMode - If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives. Default is `true`.

fallbackEncoding - Fallback character encoding to use for decoding a 2D barcode in case that the character encoding is not specified in the barcode itself. Note that some specifications suggest a particular fallback encoding. Instead, by default, we use Unknown encoding, which means that the scanner will try to detect the character encoding automatically. Default is `UNKNOWN`.

formats - List of 2D codes to scan.

BarcodeFormatCommonTwoDConfiguration

public BarcodeFormatCommonTwoDConfiguration()

Constructs BarcodeFormatCommonTwoDConfiguration with default parameters.

Method Details

getGs1Handling

public Gs1Handling getGs1Handling()

Getter for gs1Handling field. See constructor documentation for more information about the field.

Returns:

gs1Handling

setGs1Handling

public void setGs1Handling(Gs1Handling gs1Handling)

Setter for gs1Handling field. See constructor documentation for more information about the field.

Parameters:

gs1Handling - Value to set.

getStrictMode

public boolean getStrictMode()

Getter for strictMode field. See constructor documentation for more information about the field.

Returns:

strictMode

setStrictMode

public void setStrictMode(boolean strictMode)

Setter for strictMode field. See constructor documentation for more information about the field.

Parameters:

strictMode - Value to set.

getFallbackEncoding

public CharacterEncoding getFallbackEncoding()

Getter for fallbackEncoding field. See constructor documentation for more information about the field.

Returns:

fallbackEncoding

setFallbackEncoding

public void setFallbackEncoding(CharacterEncoding fallbackEncoding)

Setter for fallbackEncoding field. See constructor documentation for more information about the field.

Parameters:

fallbackEncoding - Value to set.

getFormats

public List<BarcodeFormat> getFormats()

Getter for formats field. See constructor documentation for more information about the field.

Returns:

formats

setFormats

public void setFormats(List<BarcodeFormat> formats)

Setter for formats field. See constructor documentation for more information about the field.

Parameters:

formats - Value to set.