Thanks for downloading Dynamsoft Barcode Reader Package!
Your download will start shortly. If your download does not begin, click here to retry.
iPublicRuntimeSettings
Defines a struct to configure the barcode reading runtime settings. These settings control the barcode recognition process such as which barcode types to decode.
Typedefs
@interface iPublicRuntimeSettings
Attributes
Attribute | Type |
---|---|
terminatePhase |
EnumTerminatePhase |
timeout |
NSInteger |
maxAlgorithmThreadCount |
NSInteger |
expectedBarcodesCount |
NSInteger |
barcodeFormatIds |
NSInteger |
barcodeFormatIds_2 |
NSInteger |
pdfRasterDPI |
NSInteger |
scaleDownThreshold |
NSInteger |
binarizationModes |
NSArray* |
localizationModes |
NSArray* |
furtherModes |
iFurtherModes |
deblurLevel |
NSInteger |
intermediateResultTypes |
NSInteger |
intermediateResultSavingMode |
EnumIntermediateResultSavingMode |
resultCoordinateType |
EnumResultCoordinateType |
textResultOrderModes |
NSArray* |
returnBarcodeZoneClarity |
NSInteger |
region |
iRegionDefinition |
minBarcodeTextLength |
NSInteger |
minResultConfidence |
NSInteger |
scaleUpModes |
NSArray* |
pdfReadingMode |
EnumPDFReadingMode |
terminatePhase
Sets the phase to stop the barcode reading algorithm.
EnumTerminatePhase terminatePhase
-
Value range
Any one of theEnumTerminatePhase
Enumeration items -
Default value
EnumTerminatePhaseRecognized
-
Remark
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.
NSInteger timeout
-
Value range
[0, 0x7fffffff] -
Default value
10000 -
Remark
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.
NSInteger timeout
-
Value range
[1, 4] -
Default value
4 -
Remark
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.
NSInteger expectedBarcodesCount
-
Value range
[0, 0x7fffffff] -
Default value
0 -
Remark
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.
NSInteger barcodeFormatIds
-
Value range
A combined value ofEnumBarcodeFormat
Enumeration items -
Default value
EnumBarcodeFormatALL
-
Remark
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
,EnumBarcodeFormat2
barcodeFormatIds_2
Sets the formats of the barcode in BarcodeFormat group 2 to be read. Barcode formats in BarcodeFormat group 2 can be combined.
NSInteger barcodeFormatIds_2
-
Value range
A combined value ofEnumBarcodeFormat2
Enumeration items -
Default value
EnumBarcodeFormat2NULL
-
Remark
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
,EnumBarcodeFormat2
pdfRasterDPI
Sets the output image resolution.
NSInteger pdfRasterDPI
-
Value range
[100, 600] -
Default value
300 -
Remark
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.
NSInteger scaleDownThreshold
-
Value range
[512, 0x7fffffff] -
Default value
2300 -
Remark
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.
NSArray* binarizationModes[8]
-
Value range
Each array item can be any one of theEnumBinarizationMode
Enumeration items. -
Default value
` [EnumBinarizationModeLocalBlock, EnumBinarizationModeSkip, EnumBinarizationModeSkip, EnumBinarizationModeSkip, EnumBinarizationModeSkip, EnumBinarizationModeSkip, EnumBinarizationModeSkip, EnumBinarizationModeSkip]` -
Remark
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.
NSArray* localizationModes[8]
-
Value range
Each array item can be any one of theEnumLocalizationMode
Enumeration items. -
Default value
` [EnumLocalizationModeConnectedBlocks, EnumLocalizationModeScanDirectly, EnumLocalizationModeStatistics, EnumLocalizationModeLines, EnumLocalizationModeSkip, EnumLocalizationModeSkip, EnumLocalizationModeSkip, EnumLocalizationModeSkip]` -
Remark
The array index represents the priority of the item. The smaller index is, the higher priority is. -
See also
EnumLocalizationMode
furtherModes
Sets further modes.
iFurtherModes furtherModes
deblurLevel
Sets the degree of blurriness of the barcode.
NSInteger deblurLevel
-
Value range
[0, 9] -
Default value
9 -
Remark
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.
NSInteger intermediateResultTypes
-
Value range
A combined value ofEnumIntermediateResultType
Enumeration items -
Default value
0 -
See also
EnumIntermediateResultType
intermediateResultSavingMode
Sets the mode for saving intermediate result.
EnumIntermediateResultSavingMode intermediateResultSavingMode
-
Value range
A value ofEnumIntermediateResultSavingMode
Enumeration items -
Default value
EnumIntermediateResultSavingModeMemory -
See also
EnumIntermediateResultSavingMode
resultCoordinateType
Specifies the format for the coordinates returned.
EnumResultCoordinateType resultCoordinateType
-
Value range
Any one of theEnumResultCoordinateType
Enumeration items -
Default value
EnumResultCoordinateTypePixel -
See also
EnumResultCoordinateType
textResultOrderModes
Sets the mode and priority for the order of the text results returned.
NSArray* textResultOrderModes[8]
-
Value range
Each array item can be any one of theEnumTextResultOrderMode
Enumeration items. -
Default value
` [EnumTextResultOrderModeConfidence, EnumTextResultOrderModePosition, EnumTextResultOrderModeFormat, EnumTextResultOrderModeSkip, EnumTextResultOrderModeSkip, EnumTextResultOrderModeSkip, EnumTextResultOrderModeSkip, EnumTextResultOrderModeSkip]` -
Remark
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.
NSInteger returnBarcodeZoneClarity
-
Value range
[0,1] -
Default value
0 -
Remark
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.
iRegionDefinition region
minBarcodeTextLength
Sets the range of barcode text length for barcodes search.
NSInteger minBarcodeTextLength
-
Value range
[0, 0x7fffffff] -
Default value
0 -
Remark
0: means no limitation on the barcode text length.
minResultConfidence
The minimum confidence of the result.
NSInteger minResultConfidence
-
Value range
[0, 100] -
Default value
0 -
Remark
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.
NSArray* scaleUpModes[8]
-
Value range
Each array item can be any one of theEnumScaleUpMode
Enumeration items. -
Default value
[EnumScaleUpModeAuto, EnumScaleUpModeSkip, EnumScaleUpModeSkip, EnumScaleUpModeSkip, EnumScaleUpModeSkip, EnumScaleUpModeSkip, EnumScaleUpModeSkip, EnumScaleUpModeSkip]
-
Remark
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.
EnumPDFReadingMode pdfReadingMode
-
Value range
Any one of theEnumPDFReadingMode
Enumeration items. -
Default value
EnumPDFReadingModeAuto
-
See also
EnumPDFReadingMode