| layout | title | description | keywords | needAutoGenerateSidebar | needGenerateH3Content | noTitleIndex | permalink |
|---|---|---|---|---|---|---|---|
default-layout |
Parameter Configurations - Dynamsoft Barcode Reader iOS API Reference |
This page shows the Parameter Configurations of Dynamsoft Barcode Reader for iOS SDK. |
Parameter Configurations, class, api reference, iOS |
true |
false |
true |
/programming/objectivec-swift/api-reference/auxiliary-parameter-index-v8.2.0.html |
You can update most of the parameter settings through the iPublicRuntimeSettings class.
@interface iPublicRuntimeSettings| Attribute | Type | Descriptions |
|---|---|---|
terminatePhase |
[EnumTerminatePhase]({{ site.mobile_enum }}terminate-phase.html?lang=objc,swift) |
Sets the phase to stop the barcode reading algorithm. |
timeout |
NSInteger | Set the maximum time spent on scanning one image (page). |
maxAlgorithmThreadCount |
NSInteger | Sets the number of threads the image processing algorithm will use to decode barcodes. |
expectedBarcodesCount |
NSInteger | Sets the number of barcodes expected to be detected for each image. |
barcodeFormatIds |
NSInteger | BarcodeFormat group 1. Read more in [EnumBarcodeFormat]({{ site.mobile_enum }}barcode-format.html?lang=objc,swift) |
barcodeFormatIds_2 |
NSInteger | BarcodeFormat group 2. Read more in [EnumBarcodeFormat_2]({{ site.mobile_enum }}barcode-format2.html?lang=objc,swift) |
pdfRasterDPI |
NSInteger | Sets the output image resolution. |
scaleDownThreshold |
NSInteger | Sets the threshold for the image shrinking. |
binarizationModes |
NSArray* | Sets the mode and priority for binarization. |
localizationModes |
NSArray* | Sets the mode and priority for localization algorithms. |
furtherModes |
FurtherModes |
Further modes settings. Please read more in FurtherModes class. |
deblurLevel |
NSInteger | Sets the degree of blurriness of the barcode. |
|
| intermediateResultTypes | NSInteger | Sets which types of intermediate result to be kept for further reference. |
| intermediateResultSavingMode | [EnumIntermediateResultSavingMode]({{ site.mobile_enum }}intermediate-result-saving-mode.html?lang=objc,swift) | Sets the mode for saving intermediate result. |
| resultCoordinateType | [EnumResultCoordinateType]({{ site.mobile_enum }}result-coordinate-type.html?lang=objc,swift) | Specifies the format for the coordinates returned. |
| textResultOrderModes | NSArray* | Sets the mode and priority for the order of the text results returned. |
| returnBarcodeZoneClarity | NSInteger | Sets whether or not to return the clarity of the barcode zone. |
| region | iRegionDefinition | Sets the scan region. Please read more in iRegionDefinition Class |
| minBarcodeTextLength | NSInteger | Sets the range of barcode text length for barcodes search. |
| minResultConfidence | NSInteger | The minimum confidence of the result. |
| scaleUpModes | NSArray*| Sets the mode and priority to control the sampling methods of scale-up for linear barcode with small module sizes. |
| pdfReadingMode | NSInteger | Sets the way to detect barcodes from a PDF file when using the DecodeFile method. |
| deblurModes | NSArray* | Sets the mode and priority for deblurring. |
| barcodeZoneMinDistanceToImageBorders | NSInteger | Sets the minimum distance (in pixels) between the barcode zone and image borders. |
FurtherModes is an extension of the PublicRuntimeSettings class. Through the FurtherModes, you can make advanced settings to process the image for barcode reading.
@interface iFurtherModes| Attribute | Type | Descriptions |
|---|---|---|
colourClusteringModes |
NSArray* | Sets the mode and priority for colour categorization. |
colourConversionModes |
NSArray* | Sets the mode and priority for converting a colour image to a grayscale image. |
grayscaleTransformationModes |
NSArray* | Sets the mode and priority for the grayscale image conversion. |
regionPredetectionModes |
NSArray* | Sets the region pre-detection mode for barcodes search. |
imagePreprocessingModes |
NSArray* | Sets the mode and priority for image preprocessing algorithms. |
textureDetectionModes |
NSArray* | Sets the mode and priority for texture detection. |
textFilterModes |
NSArray* | Sets the mode and priority for text filter. |
dpmCodeReadingModes |
NSArray* | Sets the mode and priority for DPM code reading. |
deformationResistingModes |
NSArray* | Sets the mode and priority for deformation resisting. |
barcodeComplementModes |
NSArray* | Sets the mode and priority to complement the missing parts in the barcode. |
barcodeColourModes |
NSArray* | Sets the mode and priority for the barcode colour mode used to process the barcode zone. |
accompanyingTextRecognitionModes |
NSArray* | Sets the mode and priority to recognize accompanying text. |
Stores the region information.
@interface iRegionDefinition| Attribute | Type | Descriptions |
|---|---|---|
regionTop |
NSInteger | The top-most coordinate or percentage of the region. |
regionLeft |
NSInteger | The Left-most coordinate or percentage of the region. |
regionRight |
NSInteger | The Right-most coordinate or percentage of the region. |
regionBottom |
NSInteger | The Bottom-most coordinate or percentage of the region. |
regionMeasuredByPercentage |
NSInteger | Sets whether or not to use percentage to measure the region size. |
The parameters that helps you on frame decoding.
@interface iFrameDecodingParameters| Attribute | Type | Descriptions |
|---|---|---|
maxQueueLength |
NSInteger | The maximum number of frames waiting for decoding. |
maxResultQueueLength |
NSInteger | The maximum number of frames waiting results (text result/localization result) will be kept for further reference. |
width |
NSInteger | The width of the frame image in pixels. |
height |
NSInteger | The height of the frame image in pixels. |
stride |
NSInteger | The stride (or scan width) of the frame image. |
imagePixelFormat |
[EnumImagePixelFormat]({{ site.mobile_enum }}image-pixel-format.html?lang=objc,swift) |
The image pixel format used in the image byte array. |
region |
iRegionDefinition |
The region definition of the frame to calculate the internal indicator. |
threshold |
float | The threshold used for filtering frames. |
fps |
NSInteger | The frequency of calling appendFrame per second. |
autoFilter |
NSInteger | Sets whether to filter frames automatically. |
clarityCalculationMethod |
EnumClarityCalculationMethod |
Sets the method used for calculating the clarity of the frames. |
clarityFilterMode |
EnumClarityFilterMode |
Sets the mode used for filtering frames by calculated clarity. |