Class BarcodeFormatCommonTwoDConfiguration
-
- All Implemented Interfaces:
-
android.os.Parcelable
public final class BarcodeFormatCommonTwoDConfiguration extends BarcodeFormatConfigurationBase implements Parcelable
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.
-
-
Field Summary
Fields Modifier and Type Field Description private final String
_type
private String
regexFilter
private Double
minimumSizeScore
private Boolean
addAdditionalQuietZone
private Gs1Handling
gs1Handling
private Boolean
strictMode
private List<BarcodeFormat>
formats
-
Constructor Summary
Constructors Constructor Description BarcodeFormatCommonTwoDConfiguration(Map<String, Object> source)
BarcodeFormatCommonTwoDConfiguration(JSONObject json)
BarcodeFormatCommonTwoDConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Gs1Handling gs1Handling, Boolean strictMode, 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 Gs1Handling
getGs1Handling()
GS1 message handling options. final Unit
setGs1Handling(Gs1Handling gs1Handling)
GS1 message handling options. final Boolean
getStrictMode()
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives. final Unit
setStrictMode(Boolean strictMode)
If true, the barcode scanner will only return barcodes that pass the strict validation checks according to standards to avoid false positives. final List<BarcodeFormat>
getFormats()
List of 2D codes to scan. final Unit
setFormats(List<BarcodeFormat> formats)
List of 2D codes to scan. JSONObject
toJson(ToJsonConfiguration config)
BarcodeFormatCommonTwoDConfiguration
clone()
final static BarcodeFormatCommonTwoDConfiguration
default()
-
-
-
Constructor Detail
-
BarcodeFormatCommonTwoDConfiguration
BarcodeFormatCommonTwoDConfiguration(Map<String, Object> source)
-
BarcodeFormatCommonTwoDConfiguration
BarcodeFormatCommonTwoDConfiguration(JSONObject json)
-
BarcodeFormatCommonTwoDConfiguration
BarcodeFormatCommonTwoDConfiguration(String regexFilter, Double minimumSizeScore, Boolean addAdditionalQuietZone, Gs1Handling gs1Handling, Boolean strictMode, 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
-
getGs1Handling
final Gs1Handling getGs1Handling()
GS1 message handling options.
Default is PARSE
-
setGs1Handling
final Unit setGs1Handling(Gs1Handling gs1Handling)
GS1 message handling options.
Default is PARSE
-
getStrictMode
final Boolean getStrictMode()
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
-
setStrictMode
final Unit setStrictMode(Boolean 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
-
getFormats
final List<BarcodeFormat> getFormats()
List of 2D codes to scan.
-
setFormats
final Unit setFormats(List<BarcodeFormat> formats)
List of 2D codes to scan.
-
toJson
JSONObject toJson(ToJsonConfiguration config)
-
default
final static BarcodeFormatCommonTwoDConfiguration default()
-
-