PublicRuntimeSettings
Defines a struct to configure the barcode reading runtime settings. These settings control the barcode recognition process such as which barcode types to decode.
Attributes
Attribute | Type |
---|---|
terminatePhase |
int |
timeout |
int |
maxAlgorithmThreadCount |
int |
expectedBarcodesCount |
int |
barcodeFormatIds |
int |
barcodeFormatIds_2 |
int |
pdfRasterDPI |
int |
scaleDownThreshold |
int |
binarizationModes |
int[] |
localizationModes |
int[] |
furtherModes |
FurtherModes |
deblurLevel |
int |
intermediateResultTypes |
int |
intermediateResultSavingMode |
int |
resultCoordinateType |
int |
textResultOrderModes |
int[] |
returnBarcodeZoneClarity |
int |
region |
RegionDefinition |
minBarcodeTextLength |
int |
minResultConfidence |
int |
scaleUpModes |
int[] |
pdfReadingMode |
int |
deblurModes |
int[] |
barcodeZoneMinDistanceToImageBorders |
int |
terminatePhase
Sets the phase to stop the barcode reading algorithm.
int com.dynamsoft.dbr.PublicRuntimeSettings.terminatePhase
Value Range
Any one of the EnumTerminatePhase
Enumeration items
Default Value
TP_BARCODE_RECOGNIZED
Remarks
When the recognition result is not desired, you can set this parameter can be set to skip certain processing stages.
See Also
EnumTerminatePhase
timeout
Sets the maximum amount of time (in milliseconds) that should be spent searching for a barcode per page. It does not include the time taken to load/decode an image (TIFF, PNG, etc.) from disk into memory.
int com.dynamsoft.dbr.PublicRuntimeSettings.timeout
Value Range
[0, 0x7fffffff]
Default Value
10000
Remarks
If you want to stop reading barcodes after a certain period of time, you can use this parameter to set a timeout.
maxAlgorithmThreadCount
Sets the number of threads the image processing algorithm will use to decode barcodes.
int com.dynamsoft.dbr.PublicRuntimeSettings.timeout
Value Range
[1, 4]
Default Value
4
Remarks
To keep a balance between speed and quality, the library concurrently runs four different threads for barcode decoding by default.
expectedBarcodesCount
Sets the number of barcodes expected to be detected for each image.
int com.dynamsoft.dbr.PublicRuntimeSettings.expectedBarcodesCount
Value Range
[0, 0x7fffffff]
Default Value
0
Remarks
0: means Unknown and it will find at least one barcode. 1: try to find one barcode. If one barcode is found, the library will stop the localization process and perform barcode decoding. n: try to find n barcodes. If the library only finds m (m<n) barcode, it will try different algorithms till n barcodes are found or all algorithms are tried.
barcodeFormatIds
Sets the formats of the barcode in BarcodeFormat group 1 to be read. Barcode formats in BarcodeFormat group 1 can be combined.
int com.dynamsoft.dbr.PublicRuntimeSettings.barcodeFormatIds
Value Range
A combined value of EnumBarcodeFormat
Enumeration items
Default Value
BF_ALL
Remarks
If the barcode type(s) are certain, specifying the barcode type(s) to be read will speed up the recognition process. The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually.
See Also
EnumBarcodeFormat
, EnumBarcodeFormat_2
barcodeFormatIds_2
Sets the formats of the barcode in BarcodeFormat group 2 to be read. Barcode formats in BarcodeFormat group 2 can be combined.
int com.dynamsoft.dbr.PublicRuntimeSettings.barcodeFormatIds_2
Value Range
A combined value of EnumBarcodeFormat_2
Enumeration items
Default Value
BF2_NULL
Remarks
If the barcode type(s) are certain, specifying the barcode type(s) to be read will speed up the recognition process. The barcode format our library will search for is composed of BarcodeFormat group 1 and BarcodeFormat group 2, so you need to specify the barcode format in group 1 and group 2 individually.
See Also
EnumBarcodeFormat
, EnumBarcodeFormat_2
pdfRasterDPI
Sets the output image resolution.
int com.dynamsoft.dbr.PublicRuntimeSettings.pdfRasterDPI
Value Range
[100, 3000]
Default Value
300
Remarks
When decoding barcodes from a PDF file using the DecodeFile method, the library will convert the PDF file to image(s) first, then perform barcode recognition.
scaleDownThreshold
Sets the threshold for the image shrinking.
int com.dynamsoft.dbr.PublicRuntimeSettings.scaleDownThreshold
Value Range
[512, 0x7fffffff]
Default Value
2300
Remarks
If the shorter edge size is larger than the given threshold value, the library will calculate the required height and width of the barcode image and shrink the image to that size before localization. Otherwise, the library will perform barcode localization on the original image.
binarizationModes
Sets the mode and priority for binarization.
int[] com.dynamsoft.dbr.PublicRuntimeSettings.binarizationModes
Value Range
Each array item can be any one of the EnumBinarizationMode
Enumeration items.
Default Value
[BM_LOCAL_BLOCK,BM_SKIP,BM_SKIP,BM_SKIP,BM_SKIP,BM_SKIP,BM_SKIP,BM_SKIP]
Remarks
The array index represents the priority of the item. The smaller index is, the higher priority is.
See Also
EnumBinarizationMode
localizationModes
Sets the mode and priority for localization algorithms.
int[] com.dynamsoft.dbr.PublicRuntimeSettings.localizationModes
Value Range
Each array item can be any one of the EnumLocalizationMode
Enumeration items.
Default Value
[LM_CONNECTED_BLOCKS, LM_SCAN_DIRECTLY, LM_STATISTICS, LM_LINES, LM_SKIP, LM_SKIP, LM_SKIP, LM_SKIP]
Remarks
The array index represents the priority of the item. The smaller index is, the higher priority is.
See Also
EnumLocalizationMode
furtherModes
Sets further modes.
FurtherModes com.dynamsoft.dbr.PublicRuntimeSettings.furtherModes
deblurLevel
Sets the degree of blurriness of the barcode.
int com.dynamsoft.dbr.PublicRuntimeSettings.deblurLevel
Value Range
[0, 9]
Default Value
9
Remarks
If you have a blurry image, you can set this property to a larger value. The higher the value set, the more effort the library will spend to decode images, but it may also slow down the recognition process.
intermediateResultTypes
Sets which types of intermediate result to be kept for further reference. Intermediate result types can be combined.
int com.dynamsoft.dbr.PublicRuntimeSettings.intermediateResultTypes
Value Range
A combined value of EnumIntermediateResultType
Enumeration items
Default Value
0
See Also
EnumIntermediateResultType
intermediateResultSavingMode
Sets the mode for saving intermediate result.
int com.dynamsoft.dbr.PublicRuntimeSettings.intermediateResultSavingMode
Value Range
A value of EnumIntermediateResultSavingMode
Enumeration items
Default Value
IRSM_MEMORY
See Also
EnumIntermediateResultSavingMode
resultCoordinateType
Specifies the format for the coordinates returned.
int com.dynamsoft.dbr.PublicRuntimeSettings.resultCoordinateType
Value Range
Any one of the EnumResultCoordinateType
Enumeration items
Default Value
RCT_PIXEL
See Also
EnumResultCoordinateType
textResultOrderModes
Sets the mode and priority for the order of the text results returned.
int[] com.dynamsoft.dbr.PublicRuntimeSettings.textResultOrderModes
Value Range
Each array item can be any one of the EnumTextResultOrderMode
Enumeration items.
Default Value
[TROM_CONFIDENCE, TROM_POSITION, TROM_FORMAT, TROM_SKIP, TROM_SKIP, TROM_SKIP, TROM_SKIP, TROM_SKIP]
Remarks
The array index represents the priority of the item. The smaller the index, the higher the priority.
See Also
EnumTextResultOrderMode
returnBarcodeZoneClarity
Sets whether or not to return the clarity of the barcode zone.
int com.dynamsoft.dbr.PublicRuntimeSettings.returnBarcodeZoneClarity
Value Range
[0,1]
Default Value
0
Remarks
0: Do not return the clarity of the barcode zone; 1: Return the clarity of the barcode zone.
region
Sets the region definition including regionTop, regionLeft, regionRight, regionBottom, and regionMeasuredByPercentage.
RegionDefinition com.dynamsoft.dbr.PublicRuntimeSettings.region
minBarcodeTextLength
Sets the range of barcode text length for barcodes search.
int com.dynamsoft.dbr.PublicRuntimeSettings.minBarcodeTextLength
Value Range
[0, 0x7fffffff]
Default Value
0
Remarks
0: means no limitation on the barcode text length.
minResultConfidence
The minimum confidence of the result.
int com.dynamsoft.dbr.PublicRuntimeSettings.minResultConfidence
Value Range
[0, 100]
Default Value
30
Remarks
0: means no limitation on the result confidence.
scaleUpModes
Sets the mode and priority to control the sampling methods of scale-up for linear barcode with small module sizes.
int[] com.dynamsoft.dbr.PublicRuntimeSettings.scaleUpModes[]
Value Range
Each array item can be any one of the EnumScaleUpMode
Enumeration items.
Default Value
[SUM_AUTO, SUM_SKIP, SUM_SKIP, SUM_SKIP, SUM_SKIP, SUM_SKIP, SUM_SKIP, SUM_SKIP]
Remarks
The array index represents the priority of the item. The smaller the index, the higher the priority.
See Also
EnumScaleUpMode
pdfReadingMode
Sets the way to detect barcodes from a PDF file when using the DecodeFile method.
int com.dynamsoft.dbr.PublicRuntimeSettings.pdfReadingMode
Value Range
Any one of the EnumPDFReadingMode
Enumeration items.
Default Value
PDFRM_AUTO
See Also
EnumPDFReadingMode
deblurModes
Sets the mode and priority for deblurring.
int[] com.dynamsoft.dbr.PublicRuntimeSettings.deblurModes
Value Range
Each array item can be any one of the EnumDeblurMode
Enumeration items.
Default Value
[DM_SKIP, DM_SKIP, DM_SKIP, DM_SKIP, DM_SKIP, DM_SKIP, DM_SKIP, DM_SKIP, DM_SKIP, DM_SKIP]
Remarks
The array index represents the priority of the item. The smaller index is, the higher priority is.
See Also
EnumDeblurMode
barcodeZoneMinDistanceToImageBorders
Sets the minimum distance (in pixels) between the barcode zone and image borders.
int com.dynamsoft.dbr.PublicRuntimeSettings.barcodeZoneMinDistanceToImageBorders
Value Range
[0, 0x7fffffff]
Default Value
0
Remarks
0: means no limitation on the distance.