Dev Center
Swift
Objective-C
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

Parameter Configuration Classes

iPublicRuntimeSettings

You can update most of the parameter settings through the iPublicRuntimeSettings class.

@interface iPublicRuntimeSettings
Attribute Type Descriptions
terminatePhase EnumTerminatePhase 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
barcodeFormatIds_2 NSInteger BarcodeFormat group 2. Read more in EnumBarcodeFormat_2
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 Sets the mode for saving intermediate result.
resultCoordinateType EnumResultCoordinateType 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.

iFurtherModes

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.

iRegionDefinition

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.

iFrameDecodingParameters

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 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.

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

version 8.2.0

  • Latest version
  • Version 9.x
    • Version 9.6.40
    • Version 9.6.20
    • Version 9.6.11
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.13
    • Version 9.2.11
    • Version 9.2.10
    • Version 9.0.2
    • Version 9.0.1
    • Version 9.0.0
  • Version 8.x
    • Version 8.9.3
    • Version 8.9.1
    • Version 8.9.0
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.1
    • Version 8.2.0
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
  • Version 7.x
    • Version 7.6.0
    • Version 7.5.0
Change +