Preview

_includes/sidelist-programming/programming-flutter.html

@@ -34,8 +34,12 @@
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/captured-result-receiver.html" class="otherLinkColour">CapturedResultReceiver</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/captured-result.html" class="otherLinkColour">CapturedResult</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/decoded-barcodes-result.html" class="otherLinkColour">DecodedBarcodesResult</a></li>
+                <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/barcode-result-item.html" class="otherLinkColour">BarcodeResultItem</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/camera-enhancer.html" class="otherLinkColour">CameraEnhancer</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
+                <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/parsed-result.html" class="otherLinkColour">ParsedResult</a></li>
+                <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/parsed-result-item.html" class="otherLinkColour">ParsedResultItem</a></li>
+                <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/parsed-field.html" class="otherLinkColour">ParsedField</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router-lite/simplified-barcode-reader-settings.html" class="otherLinkColour">SimplifiedBarcodeReaderSettings</a></li>
             </ul>
@@ -49,6 +53,8 @@
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/grayscale-enhancement-mode.html"  class="otherLinkColour">EnumGrayscaleEnhancementMode</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/grayscale-transformation-mode.html"  class="otherLinkColour">EnumGrayscaleTransformationMode</a></li>
                 <li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/captured-result-item-type.html"  class="otherLinkColour">EnumCapturedResultItemType</a></li>
+                <li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/mapping-status.html"  class="otherLinkColour">EnumMappingStatus</a></li>
+                <li lang="flutter"><a href="{{ site.dbr_flutter_api }}enum/validation-status.html"  class="otherLinkColour">EnumValidationStatus</a></li>
             </ul>
         </li>
     </ul>

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

@@ -12,7 +12,7 @@ breadcrumbText: BarcodeScanResult
 
 `BarcodeScanResult` is a result class that contains all the decoded barcodes and their associated info.
 
-## Definition
+## Definition   
 
 *Assembly:* dynamsoft-barcode-reader-bundle-flutter
 
@@ -25,22 +25,22 @@ class BarcodeScanResult
 
 | Property | Type | Description |
 | -------- | ---- | ----------- |
-| [`barcodes`](#barcodes) | *List\<BarcodeResultItem\>* | Represents all the decoded barcodes in a list of [`BarcodeResultItem`](../barcode-result-item.md). |
+| [`barcodes`](#barcodes) | *List\<BarcodeResultItem\>* | Represents all the decoded barcodes in a list of [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md). |
 | [`status`](#status) | [*EnumResultStatus*](../enum/result-status.md) | Represents the result status, which can be finished, canceled or exception. |
 | [`errorCode`](#errorcode) | *int* | Represents the error code should something go wrong during the barcode scanning process. |
 | [`errorString`](#errorstring) | *string* | Represents the error message associated with the error code should something go wrong during the barcode scanning process. |
 
 ### barcodes
 
-Represents all the decoded barcodes in an array of [`BarcodeResultItem`](../barcode-result-item.md).
+Represents all the decoded barcodes in an array of [`BarcodeResultItem`](../capture-vision-router-lite/barcode-result-item.md).
 
 ```dart
 List<BarcodeResultItem>? barcodes;
 ```
 
-**See also**
+**Remarks**
 
-- [`BarcodeResultItem`](../barcode-result-item.md).
+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.
 
 ### status
 

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

@@ -37,5 +37,5 @@ The BarcodeScanner class is built on top of the Capture Vision Foundational API
 
 ### BarcodeScanResult
 
-[`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.
+[`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.
 

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

@@ -0,0 +1,116 @@
+---
+layout: default-layout
+title: BarcodeResultItem Class - Dynamsoft Barcode Reader Flutter Edition
+description: BarcodeResultItem class represents a barcode result item decoded by barcode reader engine. It is derived from CapturedResultItem.
+keywords: GetFormat, GetText, GetLocation, GetConfidence, GetModuleSize, BarcodeResultItem, api reference, flutter, barcode reader
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: BarcodeResultItem
+---
+
+# BarcodeResultItem Class
+
+The `BarcodeResultItem` class represents a single barcode result decoded by the barcode reader. It is part of the [`DecodedBarcodesResult`](../api-reference/capture-vision-router-lite/decoded-barcodes-result.md), which is what the library outputs at the end of the barcode recognition process.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class BarcodeResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`format`](#format) | *[EnumBarcodeFormat](./enum/barcode-format.md)* | The format of the barcode represented as [`EnumBarcodeFormat`](./enum/barcode-format.md). |
+| [`formatString`](#formatstring) | *String* | The format of the barcode as a text string. |
+| [`text`](#text) | *String* | The decoded text of the barcode. |
+| [`bytes`](#bytes) | *Uint8List* | The raw bytes of the barcode. |
+| [`location`](#location) | *Quadrilateral* | The location of the barcode in the image/frame. |
+| [`confidence`](#confidence) | *int* | The confidence of the barcode result. |
+| [`angle`](#angle) | *int* | The angle at which the barcode is detected if it's not aligned in the image/frame. |
+| [`moduleSize`](#modulesize) | *int* | The size of the smallest module (dot or line) of the barcode. |
+| [`isDPM`](#isdpm) | *bool* | Indicates whether the barcode is a Dot Peen Marking (DPM). |
+| [`isMirrored`](#ismirrored) | *bool* | Indicates whether the barcode image is mirrored. |
+
+### format
+
+The format of the barcode represented as [`EnumBarcodeFormat`](./enum/barcode-format.md).
+
+```dart
+EnumBarcodeFormat format;
+```
+
+### formatString
+
+The format of the barcode as a text string instead of a `EnumBarcodeFormat`.
+
+```dart
+String formatString;
+```
+
+### text
+
+The decoded text of the barcode.
+
+```dart
+String text;
+```
+
+### bytes
+
+The raw bytes of the barcode.
+
+```dart
+Uint8List bytes;
+```
+
+### location
+
+The location of the barcode in the image/frame as a `Quadrilateral`. The quadrilateral contains the four vertex points of the location, with the first vertex being the left-most vertex, then going in a clockwise direction for the remaining points.
+
+```dart
+Quadrilateral location;
+```
+
+### confidence
+
+The confidence of the barcode result is a measure of the result's accuracy. If the confidence is lower than 30, the result will not be output by default as it is considered quite inaccurate.
+
+```dart
+int confidence;
+```
+
+### angle
+
+The angle at which the barcode is detected if it's not aligned in the image/frame.
+
+```dart
+int angle;
+```
+
+### moduleSize
+
+The size of the smallest module (dot or line) of the barcode.
+
+```dart
+int moduleSize;
+```
+
+### isDPM
+
+Indicates whether the barcode is a Dot Peen Marking (DPM), which is a unique type of Datamatrix code.
+
+```dart
+bool isDPM;
+```
+
+### isMirrored
+
+Indicates whether the barcode image is mirrored.
+
+```dart
+bool isMirrored;
+```

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

@@ -13,7 +13,7 @@ noTitleIndex: true
 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.
 
 > [!TIP]
-> 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.
+> In the context of the Barcode Reader, you will most likely be using the [DecodedBarcodesResult](decoded-barcodes-result.md) as the main result type.
 
 ## Definition
 

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

@@ -24,16 +24,16 @@ class DecodedBarcodesResult
 
 | Property | Type | Description |
 | -------- | ---- | ----------- |
-| [`items`](#items) | *List<BarcodeResultItem>?* | A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. |
+| [`items`](#items) | *List\<BarcodeResultItem\>?* | A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. |
 
 The following properties are inherited from [`CapturedResult`](./capture-vision-router-lite/captured-result.md):
 
 | Property | Type | Description |
 | -------- | ---- | ----------- |
-| [`originalImageHashId`](#originalimagehashid) | *String* | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
-| [`rotationTransformMatrix`](#rotationtransformmatrix) |  *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
-| [`errorCode`](#errorcode) | *int* | The error code associated with the capture result. |
-| [`errorMessage`](#errormessage) | *String* | The error message associated with the capture result. |
+| [`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. |
+| [`rotationTransformMatrix`](../capture-vision-router-lite/captured-result.md#rotationtransformmatrix) |  *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
+| [`errorCode`](../capture-vision-router-lite/captured-result.md#errorcode) | *int* | The error code associated with the capture result. |
+| [`errorMessage`](../capture-vision-router-lite/captured-result.md#errormessage) | *String* | The error message associated with the capture result. |
 
 ### items
 

programming/flutter/api-reference/capture-vision-router-lite/parsed-field.md

@@ -0,0 +1,57 @@
+---
+layout: default-layout
+title: ParsedField Class - Dynamsoft Capture Vision Flutter Edition
+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.
+keywords: originalImageHashId, items, errorCode, ParsedField, api reference, barcode result, capture, flutter, code parser
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: ParsedField
+---
+
+# ParsedField Class
+
+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.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class ParsedField
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`value`](#value) | *String* | The raw string value of the parsed field. |
+| [`mappingStatus`](#mappingstatus) | [*EnumMappingStatus*](../enum/mapping-status.md) | A status representing whether the field was mapped from the source data or not. |
+| [`validationStatus`](#validationstatus) | [*EnumValidationStatus*](../enum/validation-status.md) | The status of a field's value after the internal validation checks. |
+
+### value
+
+The raw string value of the parsed field.
+
+```dart
+String value;
+```
+
+### mappingStatus
+
+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`.
+
+```dart
+EnumMappingStatus mappingStatus;
+```
+
+### validationStatus
+
+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`.
+
+```dart
+String codeType;
+```
+
+**Remarks**
+
+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.

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

@@ -0,0 +1,53 @@
+---
+layout: default-layout
+title: ParsedResultItem Class - Dynamsoft Capture Vision Flutter Edition
+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.
+keywords: originalImageHashId, items, errorCode, ParsedResultItem, api reference, barcode result, capture, flutter, code parser
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: ParsedResultItem
+---
+
+# ParsedResultItem Class
+
+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.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class ParsedResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`parsedFields`](#parsedfields) | *Map\<String, ParsedField\>* | A map of parsed fields extracted from the parsed result. |
+| [`jsonString`](#jsonstring) | *String* | The raw JSON string representation of the parsed result. |
+| [`codeType`](#codetype) | *String* | The type of the encrypted code associated to the attached parsed result. |
+
+### parsedFields
+
+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.
+
+```dart
+Map<String, ParsedField> parsedFields;
+```
+
+### jsonString
+
+The text of the parsed result as a JSON string.
+
+```dart
+String jsonString;
+```
+
+### codeType
+
+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. 
+
+```dart
+String codeType;
+```

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

@@ -0,0 +1,44 @@
+---
+layout: default-layout
+title: ParsedResult Class - Dynamsoft Capture Vision Flutter Edition
+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.
+keywords: originalImageHashId, items, errorCode, ParsedResult, api reference, barcode result, capture, flutter, code parser
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: ParsedResult
+---
+
+# ParsedResult Class
+
+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.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class ParsedResult
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`items`](#items) | *List\<ParsedResultItem\>?* | A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text. |
+
+The following properties are inherited from [`CapturedResult`](./capture-vision-router-lite/captured-result.md):
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`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. |
+| [`rotationTransformMatrix`](../capture-vision-router-lite/captured-result.md#rotationtransformmatrix) |  *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
+| [`errorCode`](../capture-vision-router-lite/captured-result.md#errorcode) | *int* | The error code associated with the capture result. |
+| [`errorMessage`](../capture-vision-router-lite/captured-result.md#errormessage) | *String* | The error message associated with the capture result. |
+
+### items
+
+A list of [`ParsedResultItem`](parsed-result-item.md), the basic unit representing a single parsed result from an encrypted text.
+
+```dart
+List<ParsedResultItem>? items;
+```