Package io.scanbot.sdk.barcode

Class BarcodeFormatCommonFourStateConfiguration

java.lang.Object

io.scanbot.sdk.barcode.BarcodeFormatConfigurationBase

io.scanbot.sdk.barcode.BarcodeFormatCommonFourStateConfiguration

public class BarcodeFormatCommonFourStateConfiguration
extends BarcodeFormatConfigurationBase

Convenience configuration for enabling the scanning of multiple four-state barcode formats with a common configuration. Add to scanner configuration to enable and configure the scanning of multiple four-state 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
BarcodeFormatCommonFourStateConfiguration()	Constructs BarcodeFormatCommonFourStateConfiguration with default parameters.
BarcodeFormatCommonFourStateConfiguration(String regexFilter, double minimumSizeScore, boolean addAdditionalQuietZone, List<BarcodeFormat> formats)	Constructs BarcodeFormatCommonFourStateConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
List<BarcodeFormat>	getFormats()	Getter for formats field.
void	setFormats(List<BarcodeFormat> formats)	Setter for formats 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

BarcodeFormatCommonFourStateConfiguration

public BarcodeFormatCommonFourStateConfiguration(String regexFilter,
 double minimumSizeScore,
 boolean addAdditionalQuietZone,
 List<BarcodeFormat> formats)

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

formats - List of four-state barcode formats to scan.

BarcodeFormatCommonFourStateConfiguration

public BarcodeFormatCommonFourStateConfiguration()

Constructs BarcodeFormatCommonFourStateConfiguration with default parameters.

Method Details

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.