Skip to content

Add index pages for 10 parameter reference directories #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mark-Dynamsoft merged 4 commits into from
Sep 4, 2026
Merged

Add index pages for 10 parameter reference directories #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
48af5e3
Add index pages for parameter reference directories
Tom-Dynamsoft Aug 27, 2026
4e55b18
Remove an extra closing parenthesis
Mark-Dynamsoft Aug 27, 2026
b225596
Merge branch 'preview' of https://github.com/dynamsoft-docs/capture-v…
Mark-Dynamsoft Aug 27, 2026
0c4a5e4
update index pages
Mark-Dynamsoft Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions parameters/reference/barcode-format-specification/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
layout: default-layout
title: BarcodeFormatSpecification Parameters - Dynamsoft Capture Vision
description: Reference index for BarcodeFormatSpecification object in Dynamsoft Capture Vision parameters, which defines format-specific decoding rules and constraints.
keywords: BarcodeFormatSpecification, barcode format, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# BarcodeFormatSpecification Parameters

The `BarcodeFormatSpecification` object defines format-specific decoding rules and constraints used by barcode reading tasks.

## Example JSON

```json
{
"BarcodeFormatSpecificationOptions": [
{
"Name": "BFS_0",
"BarcodeFormatIds": ["BF_QR_CODE"],
"ExpectedBarcodesCount": 512,
"MirrorMode": "MM_NORMAL",
"MinResultConfidence": 30
}
]
}
```

## Hierarchical Structure

This tree shows one `BarcodeFormatSpecification` object inside `BarcodeFormatSpecificationOptions`.

```text
BarcodeFormatSpecification
├── Name
├── BarcodeFormatIds
└── Format-specific parameters like ExpectedBarcodesCount
```

## Top-Level Parameters

| Parameter Name | Description |
|:---------------|:------------|
| [`Name`](name.md) | The unique name of the `BarcodeFormatSpecification` object. |
| [`BarcodeFormatIds`](barcode-format-ids.md) | Specifies which barcode format(s) this specification applies to. |
| [`ExpectedBarcodesCount`](expected-barcodes-count.md) | Expected number of barcodes to decode. |
| [`MirrorMode`](mirror-mode.md) | Controls barcode mirroring handling. |
| [`MinResultConfidence`](min-result-confidence.md) | Minimum confidence threshold for accepted results. |
| [`StandardFormat`](standard-format.md) | Indicates whether standard format constraints are applied. |
| [`PartitionModes`](partition-modes.md) | Defines partitioning strategies during decoding. |
| [`VerifyCheckDigit`](verify-check-digit.md) | Defines whether to verify check digits. |
| [`IncludeTrailingCheckDigit`](include-trailing-check-digit.md) | Defines whether to include trailing check digits in text results. |
| [`IncludeImpliedAI01`](include-implied-ai01.md) | Defines whether to include implied AI(01) for GS1 parsing. |
| [`Code128Subset`](code128-subset.md) | Specifies the subset strategy for Code 128 decoding. |
| [`MsiCodeCheckDigitCalculation`](msi-code-check-digit-calculation.md) | Specifies MSI check digit calculation rules. |
| [`RequireStartStopChars`](require-start-stop-chars.md) | Defines whether start/stop characters are required. |
| [`EnableAddOnCode`](enable-addon-code.md) | Defines whether add-on codes are decoded with primary barcodes. |
| [`EnableDataMatrixECC000140`](enable-data-matrix-ecc000-140.md) | Defines whether DataMatrix ECC000-140 variants are enabled. |
| [`DataMatrixModuleIsotropic`](data-matrix-module-isotropic.md) | Controls isotropic module assumption for DataMatrix. |
| [`DataMatrixSizeOptions`](data-matrix-size-options.md) | Specifies acceptable DataMatrix symbol size options. |
| [`EnableQRCodeModel1`](enable-qr-code-model-1.md) | Defines whether QR Code Model 1 decoding is enabled. |
| [`AustralianPostEncodingTable`](australian-post-encoding-table.md) | Specifies encoding table selection for Australian Post barcodes. |
| [`ReturnPartialBarcodeValue`](return-partial-barcode-value.md) | Defines whether partial barcode values can be returned. |
| [`FindUnevenModuleBarcode`](find-uneven-module-barcode.md) | Defines whether to detect barcodes with uneven modules. |
| [`AutoDetectColorInversion`](auto-detect-color-inversion.md) | Defines whether to auto-detect foreground/background inversion. |
| [`HasVerticalQuietZone`](has-vertical-quietzone.md) | Defines whether vertical quiet zone is required/assumed. |
| [`HeadModuleRatio`](head-module-ratio.md) | Defines ratio constraints for leading modules. |
| [`TailModuleRatio`](tail-module-ratio.md) | Defines ratio constraints for trailing modules. |
| [`MinQuietZoneWidth`](min-quiet-zone-width.md) | Minimum quiet-zone width requirement. |
| [`MinRatioOfBarcodeZoneWidthToHeight`](min-ratio-of-barcode-zone-width-to-height.md) | Minimum width-to-height ratio for barcode zones. |
| [`BarcodeZoneMinDistanceToImageBorders`](barcode-zone-min-distance-to-image-borders.md) | Minimum distance from barcode zone to image borders. |
| [`BarcodeZoneWidthToHeightRatioRangeArray`](barcode-zone-width-to-height-ratio-range-array.md) | Acceptable barcode-zone width/height ratio range(s). |
| [`BarcodeZoneBarCountRangeArray`](barcode-zone-bar-count-range-array.md) | Acceptable barcode bar-count range(s). |
| [`BarcodeWidthRangeArray`](barcode-width-range-array.md) | Acceptable barcode width range(s). |
| [`BarcodeHeightRangeArray`](barcode-height-range-array.md) | Acceptable barcode height range(s). |
| [`BarcodeAngleRangeArray`](barcode-angle-range-array.md) | Acceptable barcode angle range(s). |
| [`BarcodeTextLengthRangeArray`](barcode-text-length-range-array.md) | Acceptable decoded-text length range(s). |
| [`BarcodeBytesLengthRangeArray`](barcode-bytes-length-range-array.md) | Acceptable decoded-byte length range(s). |
| [`BarcodeTextRegexPattern`](barcode-text-regex-pattern.md) | Regex pattern to validate decoded barcode text. |
| [`ModuleSizeRangeArray`](module-size-range-array.md) | Acceptable module-size range(s). |
| [`PatchCodeSearchingMargins`](patch-code-searching-margins.md) | Search margins for Patch Code localization. |
| [`AllModuleDeviation`](all-module-deviation.md) | Allowed deviation threshold for module consistency checks. |
184 changes: 184 additions & 0 deletions parameters/reference/barcode-reader-task-settings/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
---
layout: default-layout
title: BarcodeReaderTaskSetting Parameters - Dynamsoft Capture Vision
description: Reference index for BarcodeReaderTaskSetting object in Dynamsoft Capture Vision parameters, including barcode format, localization, deformation resisting, deblur, and DPM code reading settings.
keywords: BarcodeReaderTaskSetting, barcode reader, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# BarcodeReaderTaskSetting Parameters

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

## Example JSON

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

```text
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
```

> [!IMPORTANT]
> `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`](name.md) | The unique identifier for this `BarcodeReaderTaskSetting` object. |
| [`BarcodeFormatIds`](barcode-format-ids.md) | Specifies which barcode formats to read. |
| [`BarcodeFormatSpecificationNameArray`](barcode-format-specification-name-array.md) | Names of referenced `BarcodeFormatSpecification` objects for format-specific settings. |
| [`ExpectedBarcodesCount`](expected-barcodes-count.md) | Expected number of barcodes to detect per image. |
| [`MaxThreadsInOneTask`](max-threads-in-one-task.md) | Maximum number of parallel threads for this task. |
| [`SectionArray`](section-array.md) | Defines processing sections (region predetection, localization, decoding) and their stages. |
| [`DPMCodeReadingModes`](dpm-code-reading-modes.md) | Modes and priority for reading Direct Part Mark (DPM) codes. |
| [`TextResultOrderModes`](text-result-order-modes.md) | Order in which barcode results are returned. |
| [`BaseBarcodeReaderTaskSettingName`](base-barcode-reader-task-setting-name.md) | Name of another `BarcodeReaderTaskSetting` object to inherit parameters from. |

## Nested Parameter Quick Links

### Actual Nested Parameters in the Tree

| Parameter Name | Description |
|:--------------|:------------|
| [`RegionPredetectionModes`](../image-parameter/region-predetection-modes.md) | Controls how to find a region of interest (ROI) within the image or frame. |
| [`LocalizationModes`](localization-modes.md) | Determines how to localize barcodes. |
| [`DeformationResistingModes`](deformation-resisting-modes.md) | Defines how to handle distorted and deformed barcodes. |
| [`BarcodeComplementModes`](barcode-complement-modes.md) | Defines how to complement the missing parts of a barcode. |
| [`BarcodeScaleModes`](barcode-scale-modes.md) | Defines the scaling mode applied during barcode recognition. |
| [`DeblurModes`](deblur-modes.md) | Defines the mode and priority for deblurring. |
| [`ReturnBarcodeZoneClarity`](return-barcode-zone-clarity.md) | Defines whether to return the clarity of the barcode zone. |

### Conceptual Section/Stage Objects

| Object | Description |
|:-------|:------------|
| [`SectionRegionPredetection`](section-region-predetection.md) | Section object for `Section = ST_REGION_PREDETECTION`. |
| [`StagePredetectRegions`](stage-predetect-regions.md) | Stage object under `Section = ST_REGION_PREDETECTION` with `Stage = SST_PREDETECT_REGIONS`. |
| [`SectionBarcodeLocalization`](section-barcode-localization.md) | Section object for `Section = ST_BARCODE_LOCALIZATION`. |
| [`StageLocalizeCandidateBarcodes`](stage-localize-candidate-barcodes.md) | Stage object under `Section = ST_BARCODE_LOCALIZATION` with `Stage = SST_LOCALIZE_CANDIDATE_BARCODES`. |
| [`StageLocalizeBarcodes`](stage-localize-barcodes.md) | Stage object under `Section = ST_BARCODE_LOCALIZATION` with `Stage = SST_LOCALIZE_BARCODES`. |
| [`SectionBarcodeDecoding`](section-barcode-decoding.md) | Section object for `Section = ST_BARCODE_DECODING`. |
| [`StageResistDeformation`](stage-resist-deformation.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_RESIST_DEFORMATION`. |
| [`StageComplementBarcode`](stage-complement-barcode.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_COMPLEMENT_BARCODE`. |
| [`StageScaleBarcodeImage`](stage-scale-barcode-image.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_SCALE_BARCODE_IMAGE`. |
| [`StageDecodeBarcodes`](stage-decode-barcodes.md) | Stage object under `Section = ST_BARCODE_DECODING` with `Stage = SST_DECODE_BARCODES`. |
63 changes: 63 additions & 0 deletions parameters/reference/capture-vision-template/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
layout: default-layout
title: CaptureVisionTemplate Parameters - Dynamsoft Capture Vision
description: Reference index for CaptureVisionTemplate object in Dynamsoft Capture Vision parameters, the entry object of a parameter template that coordinates image sources, ROI processing, and semantic processing.
keywords: CaptureVisionTemplate, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# CaptureVisionTemplate Parameters

The `CaptureVisionTemplate` object is the entry object of a parameter template in Dynamsoft Capture Vision. It coordinates image sources, ROI processing, and semantic processing tasks.

## Example JSON

```json
{
"CaptureVisionTemplates": [
{
"Name": "CV_0",
"ImageSourceName": "ISA_0",
"ImageROIProcessingNameArray": ["TA_0"],
"SemanticProcessingNameArray": ["SP_0"],
"OutputOriginalImage": 0,
"MaxParallelTasks": 4,
"MinImageCaptureInterval": 0,
"Timeout": 500
}
]
}
```

## Hierarchical Structure

This tree shows one `CaptureVisionTemplate` object inside `CaptureVisionTemplates`.

```text
CaptureVisionTemplate
├── Name
├── ImageSourceName
├── ImageROIProcessingNameArray
├── SemanticProcessingNameArray
├── OutputOriginalImage
├── MaxParallelTasks
├── MinImageCaptureInterval
└── Timeout
```

## Top-Level Parameters

| Parameter Name | Description |
|:---------------|:------------|
| [`Name`](name.md) | The unique name of the CaptureVisionTemplate object. |
| [`ImageSourceName`](image-source-name.md) | The name of the ImageSource object to use. |
| [`ImageROIProcessingNameArray`](image-roi-processing-name-array.md) | The names of TargetROIDef objects for ROI processing. |
| [`SemanticProcessingNameArray`](semantic-processing-name-array.md) | The names of SemanticProcessing objects for semantic processing. |
| [`OutputOriginalImage`](output-original-Image.md) | Whether to output the original image. |
| [`MaxParallelTasks`](max-parallel-tasks.md) | The maximum number of parallel tasks. |
| [`MinImageCaptureInterval`](min-image-capture-interval.md) | The minimum interval between image captures. |
| [`Timeout`](timeout.md) | The timeout for each capture. |


48 changes: 48 additions & 0 deletions parameters/reference/code-parser-task-settings/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: default-layout
title: CodeParserTaskSetting Parameters - Dynamsoft Capture Vision
description: Reference index for CodeParserTaskSetting object in Dynamsoft Capture Vision parameters, which configure code parsing tasks such as passport MRZ, driving license, and other structured data.
keywords: CodeParserTaskSetting, code parser, parameter reference
needAutoGenerateSidebar: true
noTitleIndex: true
needGenerateH3Content: true
---

# CodeParserTaskSetting Parameters

The `CodeParserTaskSetting` object configures code parsing tasks such as passport MRZ, driving license, and other structured data parsing in Dynamsoft Capture Vision.

## Example JSON

```json
{
"CodeParserTaskSettingOptions": [
{
"Name": "CPT1_PARSE_VIN",
"CodeSpecifications": ["VIN"],
"ResourcesPath": "../VIN/"
}
]
}
```

## Hierarchical Structure

This tree shows one `CodeParserTaskSetting` object inside `CodeParserTaskSettingOptions`.

```text
CodeParserTaskSetting
├── Name
├── CodeSpecifications
└── ResourcesPath
```

## Top-Level Parameters

| Parameter Name | Description |
|:---------------|:------------|
| [`Name`](name.md) | The unique name of the CodeParserTaskSetting object. |
| [`CodeSpecifications`](code-specifications.md) | The code specifications for parsing. |
| [`ResourcesPath`](resources-path.md) | The path to the resources directory for code parsing. |


Loading