Class BarcodeFormatCommonFourStateConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class BarcodeFormatCommonFourStateConfiguration extends BarcodeFormatConfigurationBase implements Parcelable
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.
-
-
Field Summary
Fields Modifier and Type Field Description private final String
_type
private String
regexFilter
private Double
minimumSizeScore
private Boolean
addAdditionalQuietZone
private List<BarcodeFormat>
formats
-
Constructor Summary
Constructors Constructor Description BarcodeFormatCommonFourStateConfiguration(Map<String, Object> source)
BarcodeFormatCommonFourStateConfiguration(JSONObject json)
BarcodeFormatCommonFourStateConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, List<BarcodeFormat> formats)
-
Method Summary
Modifier and Type Method Description String
get_type()
String
getRegexFilter()
Regular expression filter for barcode text. Unit
setRegexFilter(String regexFilter)
Regular expression filter for barcode text. Double
getMinimumSizeScore()
Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Unit
setMinimumSizeScore(Double minimumSizeScore)
Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Boolean
getAddAdditionalQuietZone()
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. Unit
setAddAdditionalQuietZone(Boolean addAdditionalQuietZone)
If true, we process the barcode scanning with an artificial quiet zone that we add to the input image. final List<BarcodeFormat>
getFormats()
List of four-state barcode formats to scan. final Unit
setFormats(List<BarcodeFormat> formats)
List of four-state barcode formats to scan. JSONObject
toJson(ToJsonConfiguration config)
BarcodeFormatCommonFourStateConfiguration
clone()
final static BarcodeFormatCommonFourStateConfiguration
default()
-
-
-
Constructor Detail
-
BarcodeFormatCommonFourStateConfiguration
BarcodeFormatCommonFourStateConfiguration(Map<String, Object> source)
-
BarcodeFormatCommonFourStateConfiguration
BarcodeFormatCommonFourStateConfiguration(JSONObject json)
-
BarcodeFormatCommonFourStateConfiguration
BarcodeFormatCommonFourStateConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, List<BarcodeFormat> formats)
-
-
Method Detail
-
getRegexFilter
String getRegexFilter()
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 ""
-
setRegexFilter
Unit setRegexFilter(String 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 ""
-
getMinimumSizeScore
Double getMinimumSizeScore()
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
-
setMinimumSizeScore
Unit setMinimumSizeScore(Double 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
-
getAddAdditionalQuietZone
Boolean getAddAdditionalQuietZone()
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
-
setAddAdditionalQuietZone
Unit setAddAdditionalQuietZone(Boolean 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
-
getFormats
final List<BarcodeFormat> getFormats()
List of four-state barcode formats to scan.
-
setFormats
final Unit setFormats(List<BarcodeFormat> formats)
List of four-state barcode formats to scan.
-
toJson
JSONObject toJson(ToJsonConfiguration config)
-
default
final static BarcodeFormatCommonFourStateConfiguration default()
-
-