Skip to content

Commit 5f217cb

Browse files
update to internal commit b7195ec4
1 parent de4e1d9 commit 5f217cb

File tree

7 files changed

+290
-162
lines changed

7 files changed

+290
-162
lines changed

programming/android/api-reference/capture-vision-router/settings.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ void updateSettings(String templateName, SimplifiedCaptureVisionSettings setting
161161

162162
`[in] templateName`: Specify the name of the template that you want to update.
163163

164-
`[in] settings`: An object of SimplifiedCaptureVisionSettings.
164+
`[in] settings`: An object of `SimplifiedCaptureVisionSettings`.
165165

166166
**Exception**
167167

@@ -194,6 +194,8 @@ Returns an object that contains settings for the specified `CaptureVisionTemplat
194194
String outputSettings(String templateName, boolean includeDefaultValues) throws CaptureVisionRouterException;
195195
```
196196

197+
**Parameters**
198+
197199
`[in] templateName`: The name of the template that you want to output.
198200

199201
`[in] includeDefaultValues`: A boolean value that indicates whether to include default values in the output.

programming/android/api-reference/capture-vision-router/single-file-processing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ CapturedResult capture(ImageData imageData, String templateName);
102102

103103
**Parameters**
104104

105-
`[in] buffer`: A [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object that contains image info.
105+
`[in] imageData`: A [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object that contains image info.
106106

107107
`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter:
108108

programming/flutter/api-reference/capture-vision-router/capture-vision-router.md

Lines changed: 249 additions & 142 deletions
Large diffs are not rendered by default.

programming/flutter/api-reference/capture-vision-router/captured-result-filter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ noTitleIndex: true
1010

1111
# CapturedResultFilter
1212

13-
Abstract class `CapturedResultFilter` is responsible for filtering captured results. It is officially implemented as [MultiFrameResultCrossFilter](multi-frame-result-cross-filter.md).
13+
Abstract class `CapturedResultFilter` is responsible for filtering captured results. It is officially implemented as [MultiFrameResultCrossFilter](multi-frame-cross-filter.md).
1414

1515
## Definition
1616

programming/flutter/api-reference/capture-vision-router/captured-result.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ noTitleIndex: true
1212

1313
The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array of [`CapturedResultItem`](captured-result-item.md), each of which may be a barcode, text line, detected quad, normalized image, original image, or parsed item depending on the functional product that is used.
1414

15-
> [!TIP]
16-
> In the context of the Barcode Reader, you will most likely be using the [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html) as the main result type.
17-
1815
> [!NOTE]
19-
> The type of `CapturedResult` is dependent on the functional product that is used by the Capture Vision Router instance. To learn about the different types of functional products that Capture Vision supports, please visit the [Capture Vision Introduction]({{ site.introduction }}index.html#functional-products).
16+
>
17+
> - Barcode decoding: [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html)
18+
> - Text line: [`RecognizedTextLinesResult`]({{ site.dlr_flutter_api }}recognized-text-lines-result.html)
19+
> - Document page(s): [`ProcessedDocumentResult`]({{ site.ddn_flutter_api }}processed-document-result.html)
20+
> - Parsed content (DL, MRZ, VIN, GS1 AI, etc.): [`ParsedResult`]({{ site.dcp_flutter_api }}parsed-result.html)
2021
2122
## Definition
2223

programming/flutter/api-reference/capture-vision-router/simplified-capture-vision-settings.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ class SimplifiedCaptureVisionSettings
2929
| [`maxParallelTasks`](#maxparalleltasks) | *int* | Determines the maximum number of parallel tasks allowed for image capture and recognition. |
3030
| [`minImageCaptureInterval`](#minimagecaptureinterval) | *int* | Sets the minimum interval (in milliseconds) between image captures. |
3131
| [`timeout`](#timeout) | *int* | Specifies the maximum time (in milliseconds) allowed for image capture and recognition. |
32-
| [`barcodeSettings`](#barcodesettings) | *[SimplifiedBarcodeReaderSettings](simplified-barcode-reader-settings.md)* | The settings for the `DynamsoftBarcodeReader` tasks. |
32+
| [`barcodeSettings`](#barcodesettings) | *[SimplifiedBarcodeReaderSettings]({{ site.dbr_flutter_api }}barcode-reader/simplified-barcode-reader-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
33+
| [`labelSettings`](#labelsettings) | *[SimplifiedLabelRecognizerSettings]({{ site.dbr_flutter_api }}simplified-label-recognizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
34+
| [`documentSettings`](#documentsettings) | *[SimplifiedDocumentNormalizerSettings]({{ site.dbr_flutter_api }}simplified-document-normalizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
3335

3436
### roi
3537

@@ -73,12 +75,24 @@ int Timeout { get; set; }
7375

7476
### barcodeSettings
7577

76-
The settings for the `DynamsoftBarcodeReader` tasks as a [`SimplifiedBarcodeReaderSettings`](simplified-barcode-reader-settings.md) object.
78+
The settings for the `DynamsoftBarcodeReader` tasks as a [`SimplifiedBarcodeReaderSettings`]({{ site.dbr_flutter_api }}barcode-reader/simplified-barcode-reader-settings.html) object.
7779

7880
```dart
79-
SimplifiedBarcodeReaderSettings barcodeSettings;
81+
SimplifiedBarcodeReaderSettings? barcodeSettings;
8082
```
8183

82-
**Remarks**
84+
### labelSettings
8385

84-
If you would like to learn more on how to configure the Barcode Reader, please refer to the [User Guide (Foundational Edition)](../../foundational-user-guide.md#configuring-the-barcode-reader-optional).
86+
The settings for the `DynamsoftLabelRecognizer` tasks as a [`SimplifiedLabelRecognizerSettings`]({{ site.dbr_flutter_api }}simplified-label-recognizer-settings.html) object.
87+
88+
```dart
89+
SimplifiedLabelRecognizerSettings? labelSettings;
90+
```
91+
92+
### documentSettings
93+
94+
The settings for the `DynamsoftDocumentNormalizer` tasks as a [`SimplifiedDocumentNormalizerSettings`]({{ site.dbr_flutter_api }}simplified-document-normalizer-settings.html) object.
95+
96+
```dart
97+
SimplifiedDocumentNormalizerSettings? documentSettings;
98+
```

programming/flutter/api-reference/core/captured-result-item.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,15 @@ noTitleIndex: true
1212

1313
The `CapturedResultItem` class represents the most basic item in the captured result. Depending on the type of the [`CapturedResult`](captured-result.md), the captured result item can be a barcode, a text line, a normalized image, a detected quad, a parsed item, or an original image.
1414

15-
> [!TIP]
16-
> In the context of the Barcode Reader, you will most likely be using the [BarcodeResultItem]({{ site.dbr_flutter_api }}barcode-reader/barcode-result-item.html) as the main result type.
17-
1815
> [!NOTE]
19-
> The type of `CapturedResultItem` is dependent on the functional product that is used by the Capture Vision Router instance. To learn about the different types of functional products that Capture Vision supports, please visit the [Capture Vision Introduction]({{ site.introduction }}index.html#functional-products).
16+
>
17+
> - Barcode: [BarcodeResultItem]({{ site.dbr_flutter_api }}barcode-reader/barcode-result-item.html)
18+
> - Text line: [`TextLineResultItem`]({{ site.dlr_flutter_api }}text-line-result-item.html)
19+
> - Document page(s):
20+
> - [`DeskewedImageResultItem`]({{ site.ddn_flutter_api }}deskewed-image-result-item.html)
21+
> - [`DetectedQuadResultItem`]({{ site.ddn_flutter_api }}detected-quad-result-item.html)
22+
> - [`EnhancedImageResultItem`]({{ site.ddn_flutter_api }}enhanced-image-result-item.html)
23+
> - Parsed content (DL, MRZ, VIN, GS1 AI, etc.): [`ParsedResultItem`]({{ site.dcp_flutter_api }}parsed-result-item.html)
2024
2125
## Definition
2226

@@ -32,11 +36,11 @@ class CapturedResultItem
3236
| --------- | ---- | ----------- |
3337
| [`targetROIDefName`](#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
3438
| [`taskName`](#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
35-
| [`type`](#type) | [*EnumCapturedResultItemType*](../enum/captured-result-item-type.md) | The type of the captured result item. |
39+
| [`type`](#type) | [*EnumCapturedResultItemType*](enum/captured-result-item-type.md) | The type of the captured result item. |
3640

3741
### targetROIDefName
3842

39-
Returns a string that represents the name of the target region of interest (ROI) where the captured result was found. The target ROI is where the recognition task is run, and it is defined in the Capture Vision template that is called when [`startCapturing`](capture-vision-router.md#startcapturing) or [`capture`](capture-vision-router.md#capture) is called.
43+
Returns a string that represents the name of the target region of interest (ROI) where the captured result was found. The target ROI is where the recognition task is run, and it is defined in the Capture Vision template.
4044

4145
```dart
4246
String targetROIDefName,
@@ -48,7 +52,7 @@ To learn more about the `TargetROIDef` object, please visit this [page]({{ site.
4852

4953
### taskName
5054

51-
Returns the name of the recognition task that produced the CapturedResultItem. The task name sets the functional product that will be used for the recognition task, and it is defined in the Capture Vision template that is called when [`startCapturing`](capture-vision-router.md#startcapturing) or [`capture`](capture-vision-router.md#capture) is called.
55+
Returns the name of the recognition task that produced the CapturedResultItem. The task name sets the functional product that will be used for the recognition task, and it is defined in the Capture Vision template.
5256

5357
```dart
5458
String taskName;
@@ -60,7 +64,7 @@ To learn more about how the tasks are set in the TargetROIDef object, please vis
6064

6165
### type
6266

63-
The type of the captured result item represented as a [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md). Depending on the functional product used, the captured result item can be a barcode, a text line, a normalized image, a detected quad, a parsed item, or an original image.
67+
The type of the captured result item represented as a [`EnumCapturedResultItemType`](enum/captured-result-item-type.md). Depending on the functional product used, the captured result item can be a barcode, a text line, a normalized image, a detected quad, a parsed item, or an original image.
6468

6569
```dart
6670
EnumCapturedResultItemType type;

0 commit comments

Comments
 (0)