Package io.scanbot.sdk.barcode

Class BarcodeFormatTwoDConfigurationBase

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatTwoDConfigurationBase

Direct Known Subclasses:

BarcodeFormatAztecConfiguration, BarcodeFormatDataMatrixConfiguration, BarcodeFormatMaxiCodeConfiguration, BarcodeFormatMicroPdf417Configuration, BarcodeFormatPdf417Configuration, BarcodeFormatQrCodeConfiguration

public abstract class BarcodeFormatTwoDConfigurationBase
extends BarcodeFormatConfigurationBase

Base class for all 2D barcode configurations.

Constructor Summary

Constructors

Constructor	Description
BarcodeFormatTwoDConfigurationBase()	Constructs BarcodeFormatTwoDConfigurationBase with default parameters.
BarcodeFormatTwoDConfigurationBase(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, CharacterEncoding fallbackEncoding)	Constructs BarcodeFormatTwoDConfigurationBase with the given params.

Method Summary

Modifier and Type	Method	Description
CharacterEncoding	getFallbackEncoding()	Getter for fallbackEncoding field.
void	setFallbackEncoding(CharacterEncoding fallbackEncoding)	Setter for fallbackEncoding 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

BarcodeFormatTwoDConfigurationBase

public BarcodeFormatTwoDConfigurationBase(String regexFilter,
 double minimumSizeScore,
 boolean addAdditionalQuietZone,
 CharacterEncoding fallbackEncoding)

Constructs BarcodeFormatTwoDConfigurationBase 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`.

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`.

BarcodeFormatTwoDConfigurationBase

public BarcodeFormatTwoDConfigurationBase()

Constructs BarcodeFormatTwoDConfigurationBase with default parameters.

Method Details

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.