Skip to content

Commit b9ca8ab

Browse files
update to internal commit 38269134
1 parent 5beafe9 commit b9ca8ab

File tree

16 files changed

+41
-44
lines changed

16 files changed

+41
-44
lines changed

_config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ dce_flutter: /camera-enhancer/docs/mobile/programming/flutter/
4343
dce_flutter_api: /camera-enhancer/docs/mobile/programming/flutter/api-reference/
4444
ddn_flutter: /document-normalizer/docs/mobile/programming/flutter/
4545
ddn_flutter_api: /document-normalizer/docs/mobile/programming/flutter/api-reference/
46-
dlr_flutter: /label-recognizer/docs/mobile/programming/flutter/
47-
dlr_flutter_api: /label-recognizer/docs/mobile/programming/flutter/api-reference/
46+
dlr_flutter: /label-recognition/docs/mobile/programming/flutter/
47+
dlr_flutter_api: /label-recognition/docs/mobile/programming/flutter/api-reference/
4848

4949
xamarin: /capture-vision/docs/mobile/programming/xamarin/
5050
xamarin-api: /capture-vision/docs/mobile/programming/xamarin/api-reference/

_data/full_tree.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ tree_file_list:
33
- sidelist-programming/programming-android.html
44
- sidelist-programming/programming-ios.html
55
- sidelist-programming/programming-maui.html
6+
- sidelist-programming/programming-flutter.html

_includes/sidelist-programming/programming-flutter.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}barcode-reader/simplified-barcode-reader-settings.html" class="otherLinkColour">SimplifiedBarcodeReaderSettings</a></li>
9191
<li lang="flutter"><a>Enumerations</a>
9292
<ul lang="flutter">
93-
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}barcode-reader/enum/qr-code-correction.html" class="otherLinkColour">CameraEnhancer</a></li>
93+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}barcode-reader/enum/qr-code-correction.html" class="otherLinkColour">EnumQRCodeErrorCorrectionLevel</a></li>
9494
</ul>
9595
</li>
9696
</ul>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ Future<void> removeResultReceiver(CapturedResultReceiver receiver)
185185

186186
### setInput
187187

188-
Sets up an image source to provide images for continuous processing. This method is mainly used when configuring a camera (via the [`CameraEnhancer`](../camera-enhancer/camera-enhancer.md)) as an input source.
188+
Sets up an image source to provide images for continuous processing. This method is mainly used when configuring a camera (via the [`CameraEnhancer`]({{ site.dce_flutter_api }}camera-enhancer.html)) as an input source.
189189

190190
```dart
191191
Future<void> setInput(ImageSourceAdapter input) async
@@ -285,7 +285,7 @@ Future<List<String>> getTemplateNames() async
285285

286286
### initSettings
287287

288-
Initializes the settings of the `CaptureVisionRouter` instance using a JSON template (as a JSON string). To learn how to use a customized JSON template, please refer to this [section of the Foundational User Guide]({{ site.dbr_flutter }}foundational-user-guide.md#using-a-json-template).
288+
Initializes the settings of the `CaptureVisionRouter` instance using a JSON template (as a JSON string). To learn how to use a customized JSON template, please refer to this [section of the Foundational User Guide]({{ site.dbr_flutter }}foundational-user-guide.html#using-a-json-template).
289289

290290
```dart
291291
Future<void> initSettings(String content)
@@ -311,7 +311,7 @@ Future<void> initSettings(String content)
311311

312312
### initSettingsFromFile
313313

314-
Initializes the settings of the `CaptureVisionRouter` instance using a JSON template (as a JSON file). To learn how to use a customized JSON template, please refer to this [section of the Foundational User Guide]({{ site.dbr_flutter }}foundational-user-guide.md#using-a-json-template).
314+
Initializes the settings of the `CaptureVisionRouter` instance using a JSON template (as a JSON file). To learn how to use a customized JSON template, please refer to this [section of the Foundational User Guide]({{ site.dbr_flutter }}foundational-user-guide.html#using-a-json-template).
315315

316316
```dart
317317
Future<void> initSettingsFromFile(String filePath) async
@@ -404,7 +404,7 @@ Future<void> resetSettings() async
404404

405405
### updateSettings
406406

407-
Updates the specified template settings of the `CaptureVisionRouter` instance using a [`SimplifiedCaptureVisionSettings`](simplified-capture-vision-settings.md) object. To learn how to update the settings using the SimplifiedCaptureVisionSettings class - please refer to this [section of the Foundational User Guide]({{ site.dbr_flutter }}foundational-user-guide.md#using-simplifiedcapturevisionsettings).
407+
Updates the specified template settings of the `CaptureVisionRouter` instance using a [`SimplifiedCaptureVisionSettings`](simplified-capture-vision-settings.md) object. To learn how to update the settings using the SimplifiedCaptureVisionSettings class - please refer to this [section of the Foundational User Guide]({{ site.dbr_flutter }}foundational-user-guide.html#using-simplifiedcapturevisionsettings).
408408

409409
```dart
410410
Future<void> updateSettings(String templateName, SimplifiedCaptureVisionSettings settings)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ noTitleIndex: true
1010

1111
# CapturedResult
1212

13-
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.
13+
The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array of [`CapturedResultItem`](../core/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

1515
## Definition
1616

@@ -33,7 +33,7 @@ class CapturedResult extends CapturedResultBase
3333

3434
### items
3535

36-
A list of [`CapturedResultItem`]({{ site.crr_flutter_api }}captured-result-item.html) objects.
36+
A list of [`CapturedResultItem`]({{ site.dcv_flutter_api }}captured-result-item.html) objects.
3737

3838
```dart
3939
List<CapturedResultItem>? items;

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ Future<ImageData?> getOriginalImage(String hashId) async
3232

3333
**Remarks**
3434

35-
In order to get the hashID input parameter, please access the `originalImageHashId` of the [`CapturedResult`](captured-result.md). The `CapturedResult` can be a [`DecodedBarcodesResult`](decoded-barcodes-result.md) (if the Barcode Reader is used) and so the `originalImageHashId` can be obtained from the `DecodedBarcodesResult` object directly since it extends the `CapturedResult` class.
35+
In order to get the hashID input parameter, please access the `originalImageHashId` of the [`CapturedResult`](captured-result.md). The `CapturedResult` can be a [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html) (if the Barcode Reader is used) and so the `originalImageHashId` can be obtained from the `DecodedBarcodesResult` object directly since it extends the `CapturedResult` class.
3636

37-
The method returns a [`ImageData`](image-data.md) object which contains all the info of the original image, including a byte array to represent the raw image.
37+
The method returns a [`ImageData`]({{ site.dcv_flutter_api }}core/image-data.html) object which contains all the info of the original image, including a byte array to represent the raw image.
3838

3939
## Code Snippet
4040

programming/flutter/api-reference/capture-vision-router/multi-frame-cross-filter.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,31 +57,31 @@ Future<void> enableLatestOverlapping(int resultItemTypes, bool enable)
5757

5858
**Remarks**
5959

60-
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md). `enable` determines whether to enable or disable the filter process.
60+
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md). `enable` determines whether to enable or disable the filter process.
6161

6262
### enableResultCrossVerification
6363

64-
Enables or disables result cross verification for the specified result item types (represented as a combination of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md)). Cross verification helps in validating results across multiple frames, improving accuracy as a result.
64+
Enables or disables result cross verification for the specified result item types (represented as a combination of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md)). Cross verification helps in validating results across multiple frames, improving accuracy as a result.
6565

6666
```dart
6767
Future<void> enableResultCrossVerification(int resultItemTypes, bool enable)
6868
```
6969

7070
**Remarks**
7171

72-
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md). `enable` determines whether to enable or disable the filter process.
72+
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md). `enable` determines whether to enable or disable the filter process.
7373

7474
### enableResultDeduplication
7575

76-
Enables or disables result deduplication for the specified result item types (represented as a combination of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md)). If this filter is activated, the library will not scan a barcode for an amount of time again after it is scanned successfully for the first time. In order to set the amount of time that the barcode is remembered, please refer to `setDuplicateForgetTime`.
76+
Enables or disables result deduplication for the specified result item types (represented as a combination of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md)). If this filter is activated, the library will not scan a barcode for an amount of time again after it is scanned successfully for the first time. In order to set the amount of time that the barcode is remembered, please refer to `setDuplicateForgetTime`.
7777

7878
```dart
7979
Future<void> enableResultDeduplication(int resultItemTypes, bool enable)
8080
```
8181

8282
**Remarks**
8383

84-
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md). `enable` determines whether to enable or disable the filter process.
84+
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md). `enable` determines whether to enable or disable the filter process.
8585

8686
### getDuplicateForgetTime
8787

@@ -93,7 +93,7 @@ Future<int> getDuplicateForgetTime(int type)
9393

9494
**Remarks**
9595

96-
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md).
96+
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md).
9797

9898
### getMaxOverlappingFrames
9999

@@ -105,7 +105,7 @@ Future<int> getMaxOverlappingFrames(int type)
105105

106106
**Remarks**
107107

108-
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md).
108+
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md).
109109

110110
### isLatestOverlappingEnabled
111111

@@ -117,7 +117,7 @@ Future<bool> isLatestOverlappingEnabled(int type)
117117

118118
**Remarks**
119119

120-
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md).
120+
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md).
121121

122122
### isResultCrossVerificationEnabled
123123

@@ -129,7 +129,7 @@ Future<bool> isResultCrossVerificationEnabled(int type)
129129

130130
**Remarks**
131131

132-
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md).
132+
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md).
133133

134134
### isResultDeduplicationEnabled
135135

@@ -141,7 +141,7 @@ Future<bool> isResultDeduplicationEnabled(int type)
141141

142142
**Remarks**
143143

144-
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md).
144+
`type` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md).
145145

146146
### setDuplicateForgetTime
147147

@@ -153,7 +153,7 @@ Future<void> setDuplicateForgetTime(int resultItemTypes, int time)
153153

154154
**Remarks**
155155

156-
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md). `time` specifies the target time in *milliseconds*.
156+
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md). `time` specifies the target time in *milliseconds*.
157157

158158

159159
Sets the maximum number of overlapping frames to check when the latest overlap filter is on for the specified result item type(s).
@@ -164,7 +164,7 @@ Future<void> setMaxOverlappingFrames(int resultItemTypes, int maxFramesToCheck)
164164

165165
**Remarks**
166166

167-
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../enum/captured-result-item-type.md). `maxFramesToCheck` specifies the target number of frames that the filter should not exceed.
167+
`resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md). `maxFramesToCheck` specifies the target number of frames that the filter should not exceed.
168168

169169
## Code Snippet
170170

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

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

1111
# CapturedResultItem
1212

13-
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.
13+
The `CapturedResultItem` class represents the most basic item in the captured result. Depending on the type of the [`CapturedResult`](../capture-vision-router/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

1515
> [!NOTE]
1616
> Sub classes:

programming/flutter/api-reference/core/enum/barcode-format.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class EnumBarcodeFormat {
8080
| `none` | No barcode format specified. |
8181
| `all` | Represents all supported barcode formats. Useful for scanning operations where any type of barcode is acceptable. |
8282
| `defaultFormat` | Default barcode formats that are commonly used. This is a subset of `all` tailored for general use. |
83-
| `oned` | One-dimensional barcode formats, including BF_CODE_39, BF_CODE_128, BF_CODE_93, BF_CODABAR, BF_ITF, BF_EAN_13, BF_EAN_8, BF_UPC_A, BF_UPC_E, INDUSTRIAL_25, BF_CODE_39_Extended and BF_MSI_CODE. |
83+
| `oned` | One-dimensional barcode formats, including code39, code128, code93, codabar, itf, ean13, ean8, upcA, upcE, industrial25, code39Extended and msiCode. |
8484
| `code39` | Code 39 format, widely used in various industries for inventory and manufacturing. |
8585
| `code128` | Code 128 format, a high-density barcode for alphanumeric or numeric-only data. |
8686
| `code93` | Code 93 format, similar to Code 39 but more compact and secure with support for the full ASCII character set. |
@@ -92,7 +92,7 @@ class EnumBarcodeFormat {
9292
| `upcE` | UPC-E format, a smaller version of the UPC-A barcode used for smaller packages. |
9393
| `industrial25` | Industrial 2 of 5 format, an older, numeric-only barcode used in the industrial sector. |
9494
| `code39Extended` | Extended Code 39 format, capable of encoding the full ASCII character set by combining standard Code 39 characters. |
95-
| `gs1Databar` | GS1 DataBar barcode formats, including BF_GS1_DATABAR_OMNIDIRECTIONAL, BF_GS1_DATABAR_TRUNCATED, BF_GS1_DATABAR_STACKED, BF_GS1_DATABAR_STACKED_OMNIDIRECTIONAL, BF_GS1_DATABAR_EXPANDED, BF_GS1_DATABAR_EXPANDED_STACKED, BF_GS1_DATABAR_LIMITED. These barcodes are designed for use in retail and healthcare for fresh foods and small items. |
95+
| `gs1Databar` | GS1 DataBar barcode formats, including gs1DatabarOmnidirectional, gs1DatabarTruncated, gs1DatabarStacked, gs1DatabarStackedOmnidirectional, gs1DatabarExpanded, gs1DatabarExpandedStacked, gs1DatabarLimited. These barcodes are designed for use in retail and healthcare for fresh foods and small items. |
9696
| `gs1DatabarStackedOmnidirectional` | GS1 DataBar Stacked Omnidirectional format. |
9797
| `gs1DatabarTruncated` | GS1 DataBar Truncated format. |
9898
| `gs1DatabarStacked` | GS1 DataBar Stacked format. |
@@ -116,11 +116,11 @@ class EnumBarcodeFormat {
116116
| `gs1Composite` | GS1 Composite, a group of barcodes used in conjunction with GS1 DataBar or linear barcodes to provide additional information. |
117117
| `nonStandardBarcode` | Nonstandard barcode, a placeholder for barcodes that do not conform to established industry standards. |
118118
| `dotcode` | DotCode, a two-dimensional barcode designed for high-speed printing applications. |
119-
| `pharmacode` | PharmaCode, a general category that includes both BF_PHARMACODE_ONE_TRACK and BF_PHARMACODE_TWO_TRACK. |
119+
| `pharmacode` | PharmaCode, a general category that includes both pharmacodeOneTrack and pharmacodeTwoTrack. |
120120
| `pharmacodeOneTrack` | PharmaCode One Track, used in the pharmaceutical industry for packaging control. |
121121
| `pharmacodeTwoTrack` | PharmaCode Two Track, an extension of PharmaCode for encoding additional data. |
122122
| `matrix25` | Matrix 2 of 5, an older form of barcode used in warehouse sorting and conveyor systems. |
123-
| `postalCode` | Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC, BF_KIX. |
123+
| `postalCode` | Combined value of uspsIntelligentMail, postnet, planet, australianPost, rm4scc, kix. |
124124
| `uspsIntelligentMail` | USPS Intelligent Mail, a barcode used by the United States Postal Service to provide greater information and tracking capabilities. |
125125
| `postnet` | Postnet, used by the USPS for automating the sorting of mail. |
126126
| `planet` | Planet, another USPS barcode, similar to Postnet, but with additional data capacity. |

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ enum EnumCapturedResultItemType {
3535

3636
| Member | Description |
3737
| ------ | ----------- |
38-
| `originalImage` | The original image on which the capture process was performed. This result type can be output by any of the Capture Vision functional products (Barcode Reader, Label Recognizer, and Document Normalizer). |
39-
| `barcode` | The decoded barcode, which is the result at the end of a Barcode Reader task. |
40-
| `parsedResult` | The parsed result, which is the result at the end of a Code Parser task. |
38+
| `originalImage` | The original image. |
39+
| `barcode` | The decoded barcode. |
40+
| `textLine` | The recognized text line. |
41+
| `detectedQuad` | The detected quadrilateral. |
42+
| `deskewedImage` | The deskewed image. |
43+
| `parsedResult` | The parsed result. |
44+
| `enhancedImage` | The enhanced image. |

0 commit comments

Comments
 (0)