SimplifiedBarcodeReaderSettings
The SimplifiedBarcodeReaderSettings class comes from the SimplifiedCaptureVisionSettings class and contains settings specific to barcode decoding.
Definition
Assembly: DynamsoftBarcodeReader.aar
Namespace: com.dynamsoft.dbr
class SimplifiedBarcodeReaderSettings
Methods & Attributes
| Attributes | Type | Description |
|---|---|---|
barcodeFormatIds |
long | Defines a combined value of EnumBarcodeFormat to specify which barcode format(s) the library should target. |
expectedBarcodesCount |
int | Sets the expected barcode count. |
localizationModes |
EnumLocalizationMode[] | Defines the localization algorithm(s) used to localize barcodes. |
deblurModes |
EnumDeblurMode[] | Sets the priority for which deblurring algorithms the library will employ when dealing with blurry images. |
minResultConfidence |
int | Sets the minimum barcode result confidence to filter out the low confidence results. |
minBarcodeTextLength |
int | Sets the minimum barcode result text length. |
barcodeTextRegExPattern |
String | Sets a RegEx pattern for the barcode text. |
maxThreadsInOneTask |
int | Sets the max available threads for one task. |
grayscaleTransformationModes |
GrayscaleTransformationMode[] | Sets which grayscale transformation mode(s) the library will employ when reading barcodes. |
grayscaleEnhancementModes |
GrayscaleEnhancementMode[] | Sets which grayscale enhancement mode(s) the library will use when reading barcodes. |
scaleDownThreshold |
int | Sets the threshold for image shrinking. |
| Methods | Description |
toJson |
Generate a JSON string from this SimplifiedBarcodeReaderSettings object. |
fromJson |
Create a SimplifiedBarcodeReaderSettings object from a JSON string. |
barcodeFormatIds
Defines a combined value of EnumBarcodeFormat to specify which barcode format(s) the library should target.
long barcodeFormatIds;
expectedBarcodesCount
Sets the expected barcode count. You can set it to 0 if the barcode count is unknown.
int expectedBarcodesCount;
Remarks
- Set
expectedBarcodesCountto 0 if the barcode count is unknown. The library will try to find at least 1 barcode. - Set
expectedBarcodesCountto 1 to reach the highest speed for processing single barcode. - Set
expectedBarcodesCountto “n” if there will be “n” barcodes to process from an image. - Set
expectedBarcodesCountto the highest expected value if there exists multiple barcodes but the exact count is not confirmed.
localizationModes
Defines the localization algorithm(s) used to localize barcodes. The array consists of one or more modes, with each EnumLocalizationMode representing a different localization process.
EnumLocalizationMode[] localizationModes;
Remarks
If you would like to learn more about the localization modes and how they work, please read the parameter reference of LocalizationModes for more information.
deblurModes
Sets the priority for which deblurring algorithms the library will employ when dealing with blurry images. This array consists of EnumDeblurMode items.
EnumDeblurMode[] deblurModes;
Remarks
If you would like to learn more about the deblur modes and how they work, please read the parameter reference of DeblurModes for more information.
minResultConfidence
Set the minimum barcode result confidence to filter out results that do not meet the required level of confidence/accuracy. The higher the value of this parameter, the more accurate the results will be. If the library is struggling to find a barcode, lowering the value of this parameter can help.
int minResultConfidence;
Remarks
The default minresultConfidence value is 30. A typically accurate result that is returned by the library will be no less than 30, so that is why 30 is the default value for minResultConfidence.
minBarcodeTextLength
Sets the minimum text length of the barcode results that the library will share. Any results that do not meet this text length will be discarded by the library.
int minBarcodeTextLength;
barcodeTextRegExPattern
Sets a RegEx pattern for the barcode text. Any barcode results that don’t follow this RegEx pattern will be discarded by the library.
String barcodeTextRegExPattern;
maxThreadsInOneTask
Set the maximum available threads for a single task.
int maxThreadsInOneTask;
grayscaleTransformationModes
Sets which grayscale transformation mode(s) the library will employ when reading barcodes. This parameter controls the library’s ability to read inverted barcodes. The array consists of GrayscaleTransformationMode items.
EnumGrayscaleTransformationMode[] grayscaleTransformationModes;
Remarks
To learn more about reading inverted barcodes, please view this article on how to read inverted barcodes.
grayscaleEnhancementModes
Sets which grayscale enhancement mode(s) the library will use when reading barcodes. The array consists of GrayscaleEnhancementModes.
EnumGrayscaleEnhancementMode[] grayscaleEnhancementModes;
Remarks
This parameter can be quite powerful if used properly. To learn more about this parameter and how it can be used, please see this page on how to preprocess images.
scaleDownThreshold
Set the threshold for image shrinking when dealing with large images to help with the memory overhead. If both the width and height are larger then the threshold, the image is shrinked by half.
int scaleDownThreshold;
Remarks
If you would like to learn more on how this parameter works, please see this page on how to read barcodes from large images.
toJson
Generate a JSON string from this SimplifiedBarcodeReaderSettings object.
String toJson()
Return Value
A JSON string that contains all the information of this object.
fromJson
Create a SimplifiedBarcodeReaderSettings object from a JSON string.
static SimplifiedBarcodeReaderSettings fromJson(String json);
Parameters
json: A JSON string that contains allSimplifiedBarcodeReaderSettingsrequired information.
Return Value
A SimplifiedBarcodeReaderSettings object.
Yes
No