Need better scanning performance?

Get a FREE customized reading template.

BarcodeReaderTaskSetting Parameters

The BarcodeReaderTaskSetting object configures settings for barcode reading tasks performed on images in Dynamsoft Capture Vision.

Example JSON

{
    "BarcodeReaderTaskSettingOptions": [
        {
            "Name": "BR_0",
            "MaxThreadsInOneTask": 4,
            "ExpectedBarcodesCount": 512,
            "BarcodeFormatIds": ["BF_ALL"],
            "BarcodeFormatSpecificationNameArray": null,
            "DPMCodeReadingModes": [
                {
                    "Mode": "DPMCRM_SKIP"
                }
            ],
            "SectionArray": [
                {
                    "Section": "ST_REGION_PREDETECTION",
                    "ImageParameterName": "ip_dbrDefault",
                    "StageArray": [
                        {
                            "Stage": "SST_PREDETECT_REGIONS",
                            "RegionPredetectionModes": []
                        }
                    ]
                },
                {
                    "Section": "ST_BARCODE_LOCALIZATION",
                    "ImageParameterName": "ip_dbrDefault",
                    "StageArray": [
                        {
                            "Stage": "SST_LOCALIZE_CANDIDATE_BARCODES",
                            "LocalizationModes": []
                        },
                        {
                            "Stage": "SST_LOCALIZE_BARCODES"
                        }
                    ]
                },
                {
                    "Section": "ST_BARCODE_DECODING",
                    "ImageParameterName": "ip_dbrDefault",
                    "StageArray": [
                        {
                            "Stage": "SST_COMPLEMENT_BARCODE",
                            "BarcodeComplementModes": []
                        },
                        {
                            "Stage": "SST_RESIST_DEFORMATION",
                            "DeformationResistingModes": []
                        },
                        {
                            "Stage": "SST_SCALE_BARCODE_IMAGE",
                            "BarcodeScaleModes": []
                        },
                        {
                            "Stage": "SST_DECODE_BARCODES",
                            "DeblurModes": [],
                            "ReturnBarcodeZoneClarity": 0
                        }
                    ]
                }
            ],
            "TextResultOrderModes": [
                {
                    "Mode": "TROM_CONFIDENCE"
                }
            ],
            "BaseBarcodeReaderTaskSettingName": ""
        }
    ]
}

Hierarchical Structure

This tree shows one BarcodeReaderTaskSetting object inside BarcodeReaderTaskSettingOptions.

BarcodeReaderTaskSetting
├── Name
├── MaxThreadsInOneTask
├── ExpectedBarcodesCount
├── BarcodeFormatIds
├── BarcodeFormatSpecificationNameArray
├── DPMCodeReadingModes
├── TextResultOrderModes
├── BaseBarcodeReaderTaskSettingName
└── SectionArray[]
    ├── item (Section = ST_REGION_PREDETECTION)
    │   ├── Section
    │   ├── ImageParameterName
    │   └── StageArray[]
    │       └── item (Stage = SST_PREDETECT_REGIONS)
    │           ├── Stage
    │           └── RegionPredetectionModes
    ├── item (Section = ST_BARCODE_LOCALIZATION)
    │   ├── Section
    │   ├── ImageParameterName
    │   └── StageArray[]
    │       ├── item (Stage = SST_LOCALIZE_CANDIDATE_BARCODES)
    │       │   ├── Stage
    │       │   └── LocalizationModes
    │       └── item (Stage = SST_LOCALIZE_BARCODES)
    │           └── Stage
    └── item (Section = ST_BARCODE_DECODING)
        ├── Section
        ├── ImageParameterName
        └── StageArray[]
            ├── item (Stage = SST_RESIST_DEFORMATION)
            │   ├── Stage
            │   └── DeformationResistingModes
            ├── item (Stage = SST_COMPLEMENT_BARCODE)
            │   ├── Stage
            │   └── BarcodeComplementModes
            ├── item (Stage = SST_SCALE_BARCODE_IMAGE)
            │   ├── Stage
            │   └── BarcodeScaleModes
            └── item (Stage = SST_DECODE_BARCODES)
                ├── Stage
                ├── DeblurModes
                └── ReturnBarcodeZoneClarity

Stage values are constrained by the parent Section value, and stage-scoped parameters are constrained by the Stage value.

Top-Level Parameters

Parameter Name	Description
`Name`	The unique identifier for this `BarcodeReaderTaskSetting` object.
`BarcodeFormatIds`	Specifies which barcode formats to read.
`BarcodeFormatSpecificationNameArray`	Names of referenced `BarcodeFormatSpecification` objects for format-specific settings.
`ExpectedBarcodesCount`	Expected number of barcodes to detect per image.
`MaxThreadsInOneTask`	Maximum number of parallel threads for this task.
`SectionArray`	Defines processing sections (region predetection, localization, decoding) and their stages.
`DPMCodeReadingModes`	Modes and priority for reading Direct Part Mark (DPM) codes.
`TextResultOrderModes`	Order in which barcode results are returned.
`BaseBarcodeReaderTaskSettingName`	Name of another `BarcodeReaderTaskSetting` object to inherit parameters from.

Nested Parameter Quick Links

Actual Nested Parameters in the Tree

Parameter Name	Description
`RegionPredetectionModes`	Controls how to find a region of interest (ROI) within the image or frame.
`LocalizationModes`	Determines how to localize barcodes.
`DeformationResistingModes`	Defines how to handle distorted and deformed barcodes.
`BarcodeComplementModes`	Defines how to complement the missing parts of a barcode.
`BarcodeScaleModes`	Defines the scaling mode applied during barcode recognition.
`DeblurModes`	Defines the mode and priority for deblurring.
`ReturnBarcodeZoneClarity`	Defines whether to return the clarity of the barcode zone.

Conceptual Section/Stage Objects

Object	Description
`SectionRegionPredetection`	Section object for `Section = ST_REGION_PREDETECTION`.
`StagePredetectRegions`	Stage object under `Section = ST_REGION_PREDETECTION` with `Stage = SST_PREDETECT_REGIONS`.
`SectionBarcodeLocalization`	Section object for `Section = ST_BARCODE_LOCALIZATION`.
`StageLocalizeCandidateBarcodes`	Stage object under `Section = ST_BARCODE_LOCALIZATION` with `Stage = SST_LOCALIZE_CANDIDATE_BARCODES`.
`StageLocalizeBarcodes`	Stage object under `Section = ST_BARCODE_LOCALIZATION` with `Stage = SST_LOCALIZE_BARCODES`.
`SectionBarcodeDecoding`	Section object for `Section = ST_BARCODE_DECODING`.
`StageResistDeformation`	Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_RESIST_DEFORMATION`.
`StageComplementBarcode`	Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_COMPLEMENT_BARCODE`.
`StageScaleBarcodeImage`	Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_SCALE_BARCODE_IMAGE`.
`StageDecodeBarcodes`	Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_DECODE_BARCODES`.