Skip to content

Commit 0ba9c72

Browse files
update to internal commit 45935ba3
1 parent c5291dd commit 0ba9c72

File tree

17 files changed

+249
-101
lines changed

17 files changed

+249
-101
lines changed

_includes/sidelist-programming/programming-flutter.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,12 @@
3434
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/captured-result-receiver.html" class="otherLinkColour">CapturedResultReceiver</a></li>
3535
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/captured-result.html" class="otherLinkColour">CapturedResult</a></li>
3636
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/decoded-barcodes-result.html" class="otherLinkColour">DecodedBarcodesResult</a></li>
37+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/barcode-result-item.html" class="otherLinkColour">BarcodeResultItem</a></li>
3738
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/camera-enhancer.html" class="otherLinkColour">CameraEnhancer</a></li>
3839
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
40+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/parsed-result.html" class="otherLinkColour">ParsedResult</a></li>
41+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
42+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/parsed-field.html" class="otherLinkColour">ParsedField</a></li>
3943
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a></li>
4044
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/simplified-barcode-reader-settings.html" class="otherLinkColour">SimplifiedBarcodeReaderSettings</a></li>
4145
</ul>
@@ -49,6 +53,8 @@
4953
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/grayscale-enhancement-mode.html" class="otherLinkColour">EnumGrayscaleEnhancementMode</a></li>
5054
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/grayscale-transformation-mode.html" class="otherLinkColour">EnumGrayscaleTransformationMode</a></li>
5155
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/captured-result-item-type.html" class="otherLinkColour">EnumCapturedResultItemType</a></li>
56+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/mapping-status.html" class="otherLinkColour">EnumMappingStatus</a></li>
57+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/validation-status.html" class="otherLinkColour">EnumValidationStatus</a></li>
5258
</ul>
5359
</li>
5460
</ul>

programming/flutter/api-reference/barcode-scanner/barcode-scan-result.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ breadcrumbText: BarcodeScanResult
1212

1313
`BarcodeScanResult` is a result class that contains all the decoded barcodes and their associated info.
1414

15-
## Definition
15+
## Definition
1616

1717
*Assembly:* dynamsoft-barcode-reader-bundle-flutter
1818

@@ -25,22 +25,22 @@ class BarcodeScanResult
2525

2626
| Property | Type | Description |
2727
| -------- | ---- | ----------- |
28-
| [`barcodes`](#barcodes) | *List\<BarcodeResultItem\>* | Represents all the decoded barcodes in a list of [`BarcodeResultItem`](../barcode-result-item.md). |
28+
| [`barcodes`](#barcodes) | *List\<BarcodeResultItem\>* | Represents all the decoded barcodes in a list of [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md). |
2929
| [`status`](#status) | [*EnumResultStatus*](../enum/result-status.md) | Represents the result status, which can be finished, canceled or exception. |
3030
| [`errorCode`](#errorcode) | *int* | Represents the error code should something go wrong during the barcode scanning process. |
3131
| [`errorString`](#errorstring) | *string* | Represents the error message associated with the error code should something go wrong during the barcode scanning process. |
3232

3333
### barcodes
3434

35-
Represents all the decoded barcodes in an array of [`BarcodeResultItem`](../barcode-result-item.md).
35+
Represents all the decoded barcodes in an array of [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md).
3636

3737
```dart
3838
List<BarcodeResultItem>? barcodes;
3939
```
4040

41-
**See also**
41+
**Remarks**
4242

43-
- [`BarcodeResultItem`](../barcode-result-item.md).
43+
Each individual decoded barcode comes out as a [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md), which is part of the Foundational Capture Vision API.
4444

4545
### status
4646

programming/flutter/api-reference/barcode-scanner/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,5 +37,5 @@ The BarcodeScanner class is built on top of the Capture Vision Foundational API
3737
3838
### BarcodeScanResult
3939

40-
[`BarcodeScanResult`](barcode-scan-result.md) is a result class that contains all the decoded barcodes and their associated info. This class is dependent on the [`BarcodeResultItem`](../barcode-result-item.md) class which is part of the Capture Vision Foundational API.
40+
[`BarcodeScanResult`](barcode-scan-result.md) is a result class that contains all the decoded barcodes and their associated info. This class is dependent on the [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md) class which is part of the Capture Vision Foundational API.
4141

programming/flutter/api-reference/barcode-result-item.md renamed to programming/flutter/api-reference/capture-vision-router-lite/barcode-result-item.md

File renamed without changes.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ noTitleIndex: true
1313
The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array of `CapturedResultItem`, 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
> [!TIP]
16-
> In the context of the Barcode Reader, you will most likely be using the [DecodedBarcodesResult]({{ site.dbr_maui_api }}decoded-barcodes-result.html) as the main result type.
16+
> In the context of the Barcode Reader, you will most likely be using the [DecodedBarcodesResult](decoded-barcodes-result.md) as the main result type.
1717
1818
## Definition
1919

programming/flutter/api-reference/capture-vision-router-lite/decoded-barcodes-result.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ class DecodedBarcodesResult
2424

2525
| Property | Type | Description |
2626
| -------- | ---- | ----------- |
27-
| [`items`](#items) | *List<BarcodeResultItem>?* | A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. |
27+
| [`items`](#items) | *List\<BarcodeResultItem\>?* | A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. |
2828

2929
The following properties are inherited from [`CapturedResult`](./capture-vision-router-lite/captured-result.md):
3030

3131
| Property | Type | Description |
3232
| -------- | ---- | ----------- |
33-
| [`originalImageHashId`](#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
34-
| [`rotationTransformMatrix`](#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
35-
| [`errorCode`](#errorcode) | *int* | The error code associated with the capture result. |
36-
| [`errorMessage`](#errormessage) | *String* | The error message associated with the capture result. |
33+
| [`originalImageHashId`](../capture-vision-router-lite/captured-result.md#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
34+
| [`rotationTransformMatrix`](../capture-vision-router-lite/captured-result.md#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
35+
| [`errorCode`](../capture-vision-router-lite/captured-result.md#errorcode) | *int* | The error code associated with the capture result. |
36+
| [`errorMessage`](../capture-vision-router-lite/captured-result.md#errormessage) | *String* | The error message associated with the capture result. |
3737

3838
### items
3939

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
layout: default-layout
3+
title: ParsedField Class - Dynamsoft Capture Vision Flutter Edition
4+
description: The ParsedField class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.
5+
keywords: originalImageHashId, items, errorCode, ParsedField, api reference, barcode result, capture, flutter, code parser
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: ParsedField
9+
---
10+
11+
# ParsedField Class
12+
13+
The `ParsedField` class represents a field from the [`ParsedResultItem`](parsed-result-item.md) output of an encrypted text coming from a document or a data source. It contains the parsed value along with its mapping and validation status.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class ParsedField
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`value`](#value) | *String* | The raw string value of the parsed field. |
28+
| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*](../enum/mapping-status.md) | A status representing whether the field was mapped from the source data or not. |
29+
| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*](../enum/validation-status.md) | The status of a field's value after the internal validation checks. |
30+
31+
### value
32+
33+
The raw string value of the parsed field.
34+
35+
```dart
36+
String value;
37+
```
38+
39+
### mappingStatus
40+
41+
A status representing whether the field was mapped from the source data or not, represented as a [`EnumMappingStatus`](../enum/mapping-status.md). If the field was unsuccessful during the mapping process, the mappingStatus would be `EnumMappingStatus.failed`.
42+
43+
```dart
44+
EnumMappingStatus mappingStatus;
45+
```
46+
47+
### validationStatus
48+
49+
The status of a field's value after the internal validation checks, represented as a [`EnumValidationStatus`](../enum/validation-status.md). Once a field is parsed by the Code Parser, it is run through validation checks to make sure that the information is accurate and correct. If a field's value does not pass, the validationStatus would be `EnumValidationStatus.failed`.
50+
51+
```dart
52+
String codeType;
53+
```
54+
55+
**Remarks**
56+
57+
An example of a failed validation check is if the month of a birth date is April 31 for instance. Since that is anb invalid day, the date of birth field will be marked as invalid. The validation check does not compare the info of a parsed field against a database or anything of the kind in order to verify if the information is correct.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
layout: default-layout
3+
title: ParsedResultItem Class - Dynamsoft Capture Vision Flutter Edition
4+
description: The ParsedResult class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.
5+
keywords: originalImageHashId, items, errorCode, ParsedResultItem, api reference, barcode result, capture, flutter, code parser
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: ParsedResultItem
9+
---
10+
11+
# ParsedResultItem Class
12+
13+
The `ParsedResultItem` class represents the most basic unit of a parsed result. It includes specific details relevant to the parsed data, including the code type, the raw JSON string, and a map of the individual parsed fields.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class ParsedResultItem
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`parsedFields`](#parsedfields) | *Map\<String, ParsedField\>* | A map of parsed fields extracted from the parsed result. |
28+
| [`jsonString`](#jsonstring) | *String* | The raw JSON string representation of the parsed result. |
29+
| [`codeType`](#codetype) | *String* | The type of the encrypted code associated to the attached parsed result. |
30+
31+
### parsedFields
32+
33+
A map of the parsed fields extracted from the parsed result. Each field can then be accessed by the associated key, allowing the developer to present the parsed info in a user-friendly manner.
34+
35+
```dart
36+
Map<String, ParsedField> parsedFields;
37+
```
38+
39+
### jsonString
40+
41+
The text of the parsed result as a JSON string.
42+
43+
```dart
44+
String jsonString;
45+
```
46+
47+
### codeType
48+
49+
The type of the encrypted code associated to the attached parsed result. The code can be a MRZ document (passport, visa, etc.), a driver license (North America or South Africa), or an Aadhar card.
50+
51+
```dart
52+
String codeType;
53+
```
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
layout: default-layout
3+
title: ParsedResult Class - Dynamsoft Capture Vision Flutter Edition
4+
description: The ParsedResult class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.
5+
keywords: originalImageHashId, items, errorCode, ParsedResult, api reference, barcode result, capture, flutter, code parser
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
breadcrumbText: ParsedResult
9+
---
10+
11+
# ParsedResult Class
12+
13+
The `ParsedResult` class represents the result of a code parsing process. It provides access to the individual parsed items resulting from a document or an encrypted text.
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
class ParsedResult
21+
```
22+
23+
## Properties
24+
25+
| Property | Type | Description |
26+
| -------- | ---- | ----------- |
27+
| [`items`](#items) | *List\<ParsedResultItem\>?* | A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. |
28+
29+
The following properties are inherited from [`CapturedResult`](./capture-vision-router-lite/captured-result.md):
30+
31+
| Property | Type | Description |
32+
| -------- | ---- | ----------- |
33+
| [`originalImageHashId`](../capture-vision-router-lite/captured-result.md#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
34+
| [`rotationTransformMatrix`](../capture-vision-router-lite/captured-result.md#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
35+
| [`errorCode`](../capture-vision-router-lite/captured-result.md#errorcode) | *int* | The error code associated with the capture result. |
36+
| [`errorMessage`](../capture-vision-router-lite/captured-result.md#errormessage) | *String* | The error message associated with the capture result. |
37+
38+
### items
39+
40+
A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text.
41+
42+
```dart
43+
List<ParsedResultItem>? items;
44+
```

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ class SimplifiedBarcodeReaderSettings
2929
|----------|------|-------------|
3030
| [`barcodeFormatIds`](#barcodeformatids) | [*EnumBarcodeFormat*](./enum/barcode-format.md) | Specifies which barcode format(s) the Barcode Reader will target. |
3131
| [`expectedBarcodesCount`](#expectedbarcodescount) | *int* | Determines the expected barcode count, which can be set to 0 if the barcode count is unknown. |
32-
| [`localizationModes`](#localizationmodes) | *List<EnumLocalizationMode>* | Defines which localization modes (as [`EnumLocalizationMode`](./enum/localization-mode.md)) the barcode reader will use during the detection process. |
32+
| [`localizationModes`](#localizationmodes) | *List\<EnumLocalizationMode\>* | Defines which localization modes (as [`EnumLocalizationMode`](./enum/localization-mode.md)) the barcode reader will use during the detection process. |
3333
| [`deblurModes`](#deblurmodes) | *List<EnumDeblurMode>* | Sets which deblur algorithms (as [`EnumDeblurMode`](./enum/deblur-mode.md)) the library will apply during the detection process when dealing with blurry images/frames. |
3434
| [`minResultConfidence`](#minresultconfidence) | *int* | Specifies the minimum barcode result confidence to help filter out inaccurate results. |
3535
| [`minBarcodeTextLength`](#minbarcodetextlength) | *int* | Sets the minimum barcode text length (in characters) for the barcode result to be considered valid. |
3636
| [`barcodeTextRegExPattern`](#barcodetextregexpattern) | *String* | Defines a regular expression pattern that the barcode text must match to be considered valid. |
3737
| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | Establishes the maximum number of threads available for a single detection task. |
38-
| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List<EnumGrayscaleTransformationMode>* | Determines which grayscale transformation modes (as [`EnumGrayscaleTransformationMode`](./enum/grayscale-transformation-mode.md)) the barcode reader will apply before the detection process. |
39-
| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List<EnumGrayscaleEnhancementMode>* | Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](./enum/grayscale-enhancement-mode.md)) the library will apply before the detection process. |
38+
| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List\<EnumGrayscaleTransformationMode\>* | Determines which grayscale transformation modes (as [`EnumGrayscaleTransformationMode`](./enum/grayscale-transformation-mode.md)) the barcode reader will apply before the detection process. |
39+
| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List\<EnumGrayscaleEnhancementMode\>* | Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](./enum/grayscale-enhancement-mode.md)) the library will apply before the detection process. |
4040
| [`scaleDownThreshold`](#scaledownthreshold) | *int* | Defines the threshold for scaling down the image/frame before processing to help with memory overhead. |
4141

4242
### barcodeFormatIds

0 commit comments

Comments
 (0)