Skip to content

Commit be8874c

Browse files
tony-xlhtony-xlh
committed
update parameters index and remove old ones
1 parent db925c4 commit be8874c

3 files changed

Lines changed: 8 additions & 74 deletions

File tree

‎parameters/batch-scan-settings.md‎

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ noTitleIndex: false
99

1010
# Batch Scan Settings
1111

12+
The batch scanning settings are available under `BatchScanTemplates`.
13+
1214
```json
1315
{
1416
"BatchScanTemplates": [
@@ -119,10 +121,8 @@ noTitleIndex: false
119121
| [`DuplicationCorrectionOption`](#duplicationcorrectionoption) | Determines how the algorithm deals with the duplicated barcodes. |
120122
| [`EnableOutputFrameMappedResult`](#enableoutputframemappedresult) | Whether to map the result coordinates from panoramic image to the video frame. |
121123
| [`EnableOutputPreviewPanorama`](#enableoutputpreviewpanorama) | Whether to enable result preview when scanning. |
122-
| [`EnableOutputResultImage`](#enableoutputresultimage) | Whether to save image data and generate panoramic image in the final result. |
123124
| [`MaxOverlappingFrames`](#maxoverlappingframes) | The maximum number of overlapping frames of TTLO mode. |
124125
| [`MinLocalizedBarcodeConfidence`](#minlocalizedbarcodeconfidence) | The minimum confidence level of the localized barcodes. |
125-
| [`PanoramicImageScalePercent`](#panoramicimagescalepercent) | Determines the scale down rate of the panoramic image. Measured by percentage. |
126126
| [`PerspectiveLevel`](#perspectivelevel) | Determines how much efforts to spend on correcting the perspective. |
127127
| [`PreviewImageOption`](#previewimageoption) | Defines how the preview image is output. |
128128
| [`StitchLevel`](#stitchlevel) | Determines how much effort to spend on stitching the video frames. |
@@ -420,22 +420,6 @@ int
420420

421421
1
422422

423-
### EnableOutputResultImage
424-
425-
Whether to save image data and generate panoramic image in the final result.
426-
427-
**Type**
428-
429-
int
430-
431-
**Range**
432-
433-
[0,1]
434-
435-
**Default Value**
436-
437-
1
438-
439423
### MaxOverlappingFrames
440424

441425
The maximum number of overlapping frames of TTLO mode.
@@ -470,25 +454,6 @@ int
470454

471455
100
472456

473-
### PanoramicImageScalePercent
474-
475-
Determines the scale down rate of the panoramic image. Measured by percentage.
476-
477-
**Type**
478-
479-
int
480-
481-
**Range**
482-
483-
[0,100]
484-
485-
> - 0 means auto.
486-
> - 100 means original size.
487-
488-
**Default Value**
489-
490-
0
491-
492457
### PerspectiveLevel
493458

494459
Determines how much efforts to spend on correcting the perspective.

‎parameters/camera-and-ui-settings.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ noTitleIndex: false
99

1010
# Camera and UI Settings
1111

12-
The camera and UI settings are also available under `CameraAndUITemplates`
12+
The camera and UI settings are available under `CameraAndUITemplates`.
1313

1414
```json
1515
{

‎parameters/index.md‎

Lines changed: 5 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -11,42 +11,11 @@ noTitleIndex: false
1111

1212
You can learn about the parameters of Batch Barcode Scanner here. Normally you don't need to know the details about the parameters and [contact support](mailto:support@dynamsoft.com) for help. But it helps if you have knowledge about them.
1313

14-
## BatchScanTemplates Parameters
14+
## Overview of Parameters
1515

16-
| Parameter | Description |
17-
| --------- | ----------- |
18-
| [`Name`](batch-scan-settings.md#name) | The name of the template. Must be unique. |
19-
| [`CaptureVisionTemplateName`](batch-scan-settings.md#capturevisiontemplatename) | Specifies a name of the `CaptureVisionTemplate`. A `CaptureVisionTemplate` defines how to decode the barcodes. |
20-
| [`BarcodeFormatIds`](batch-scan-settings.md#barcodeformatids) | Defines which formats are output in the final result. |
21-
| [`ResultOutputSettings`](batch-scan-settings.md#resultoutputsettings) | Result output settings. |
22-
| [`SectionLayoutOptions`](batch-scan-settings.md#sectionlayoutoptions) | Defines the layout sections with their layout analysis mode and maximum number of barcodes. |
23-
| [`AutoStopOption`](batch-scan-settings.md#autostopoption) | Defines whether to stop scanning automatically and when to auto-stop. |
24-
| [`ARCorrectionLevel`](batch-scan-settings.md#arcorrectionlevel) | A higher level means the algorithm will spend more efforts on correcting the AR data. |
25-
| [`DuplicationCorrectionOption`](batch-scan-settings.md#duplicationcorrectionoption) | Determines how the algorithm deals with the duplicated barcodes. |
26-
| [`EnableOutputFrameMappedResult`](batch-scan-settings.md#enableoutputframemappedresult) | Whether to map the result coordinates from panoramic image to the video frame. |
27-
| [`EnableOutputPreviewPanorama`](batch-scan-settings.md#enableoutputpreviewpanorama) | Whether to enable result preview when scanning. |
28-
| [`EnableOutputResultImage`](batch-scan-settings.md#enableoutputresultimage) | Whether to save image data and generate panoramic image in the final result. |
29-
| [`MaxOverlappingFrames`](batch-scan-settings.md#maxoverlappingframes) | The maximum number of overlapping frames of TTLO mode. |
30-
| [`MinLocalizedBarcodeConfidence`](batch-scan-settings.md#minlocalizedbarcodeconfidence) | The minimum confidence level of the localized barcodes. |
31-
| [`PanoramicImageScalePercent`](batch-scan-settings.md#panoramicimagescalepercent) | Determines the scale down rate of the panoramic image. Measured by percentage. |
32-
| [`PerspectiveLevel`](batch-scan-settings.md#perspectivelevel) | Determines how much efforts to spend on correcting the perspective. |
33-
| [`PreviewImageOption`](batch-scan-settings.md#previewimageoption) | Defines how the preview image is output. |
34-
| [`StitchLevel`](batch-scan-settings.md#stitchlevel) | Determines the how much effort to spend on stitching the video frames. |
35-
| [`StitchMode`](batch-scan-settings.md#stitchmode) | Determines the stitching mode. |
36-
| [`UniqueBarcodeFormatIds`](batch-scan-settings.md#uniquebarcodeformatids) | If there exist duplicated barcodes, this option will be used to determine which barcodes are unique. |
16+
There are three types of parameters for Batch Barcode Scanner. They are defined in JSON templates. Click the links to learn about the parameters in detail.
3717

38-
## CameraAndUITemplates Parameters
18+
* [Parameters controlling the camera and UI](./camera-and-ui-settings.md)
19+
* [Parameters controlling the batch scanning process](./batch-scan-settings.md)
20+
* [Parameters controlling the barcode reading process](https://www.dynamsoft.com/barcode-reader/docs/core/parameters/structure-and-interfaces-of-parameters.html){:target="_blank"}
3921

40-
| Parameter | Description |
41-
| --------- | ----------- |
42-
| [`Name`](camera-and-ui-settings.md#name) | The name of the template. |
43-
| [`CameraType`](camera-and-ui-settings.md#cameratype) | Specifies the camera for batch barcode scanning. It can be a AR camera or a physical camera. |
44-
| [`ScanUIScenario`](camera-and-ui-settings.md#scanuiscenario) | Defines the scan UI by the scenario. |
45-
| [`Resolution`](camera-and-ui-settings.md#resolution) | Specifies the resolution of the camera. |
46-
| [`ScanDirection`](camera-and-ui-settings.md#scandirection) | Specifies the scan direction of the camera. It determines how the preview image is displayed. |
47-
| [`ScanRegion`](camera-and-ui-settings.md#scanregion) | Specifies the scan region. It reduces the scan size to improve the speed and the accuracy. |
48-
| [`BatchScanTemplateName`](camera-and-ui-settings.md#batchscantemplatename) | Specifies the `BatchScanTemplate` object required by this template for batch scanning with its name. |
49-
50-
## CaptureVisionTemplates
51-
52-
View in [Dynamsoft Barcode Reader docs](https://www.dynamsoft.com/barcode-reader/docs/core/parameters/structure-and-interfaces-of-parameters.html){:target="_blank"}

0 commit comments

Comments
 (0)