Preview

.github/workflows/main.yml

@@ -8,7 +8,7 @@ on:
   push:
     branches: 
     - main 
-    #- preview 
+    - preview 
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

_config.yml

@@ -19,6 +19,9 @@ dcv_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
 
 dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
 
+dcv_flutter: /capture-vision/docs/mobile/programming/flutter/
+dcv_flutter_api: /capture-vision/docs/mobile/programming/flutter/api-reference/
+
 dcv_introduction: /capture-vision/docs/core/introduction/
 
 dce_android_api: /camera-enhancer/docs/mobile/programming/android/

programming/flutter/api-reference/deskewed-image-result-item.md

@@ -0,0 +1,70 @@
+---
+layout: default-layout
+title: DeskewedImageResultItem - Dynamsoft Capture Vision Flutter SDK API Reference
+description: The class DeskewedImageResultItem represents a captured result item whose type is a deskewed image. It stores the deskewed image information.
+keywords: deskewed image result item, dart
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DeskewedImageResultItem
+
+The `DeskewedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html) that represents a deskewed image. This is the most basic unit of the deskewed image result, one of the captured result types that the Capture Vision Router can output. 
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class DeskewedImageResultItem extends CapturedResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the deskewed image. |
+| [`sourceDeskewQuad`](#location) | *Quadrilateral* | The quadrilateral from which you get the deskewed image result item. |
+| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
+| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Matrix4* | The transformation matrix from the original image coordinate system to the local coordinate system. |
+
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html).
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
+| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
+| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
+
+### imageData
+
+An [`ImageData`]({{ site.dcv_flutter_api }}core/image-data.html) object for the deskewed image.
+
+```dart
+ImageData? imageData;
+```
+
+### sourceDeskewQuad
+
+The soure [Quadrilateral]({{ site.dcv_flutter_api }}core/quadrilateral.html) that used to deskew the image.
+
+```dart
+Quadrilateral sourceDeskewQuad;
+```
+
+### crossVerificationStatus
+
+The cross verification status of the result item. The cross verification status determines whether the result item is approved by the multi-frame cross verification mechanism. If approved, the cross verification status is `CVS_PASSED`. Otherwise, it is `CVS_FAILED`.
+
+```dart
+EnumCrossVerificationStatus crossVerificationStatus;
+```
+
+### originalToLocalMatrix
+
+The transformation matrix from the original image coordinate system to the local coordinate system.
+
+```dart
+Matrix4 originalToLocalMatrix;
+```

programming/flutter/api-reference/detected-quad-result-item.md

@@ -0,0 +1,61 @@
+---
+layout: default-layout
+title: DetectedQuadResultItem - Dynamsoft Capture Vision Flutter SDK API Reference
+description: The class DetectedQuadResultItem represents a captured result item whose type is detected quads, which contains the location and confidence as a document boundary.
+keywords: detected quads, dart
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DetectedQuadResultItem
+
+The `DetectedQuadResultItem` class is an extension of the [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html) that represents a detected quadrilateral. This is the most basic unit of a detected quadrilateral, one of the captured result types that the Capture Vision Router can output.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class DetectedQuadResultItem extends CapturedResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`location`](#location) | *Quadrilateral* | A Quadrilateral object as the location of current object. |
+| [`confidenceAsDocumentBoundary`](#confidenceasdocumentboundary) | *int* | The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document. |
+| [`crossVerificationStatus`](#crossverificationstatus) | *EnumCrossVerificationStatus* | The cross verification status of the result item. |
+
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html).
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
+| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
+| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
+
+### location
+
+Returns a [Quadrilateral]({{ site.dcv_flutter_api }}core/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame.
+
+```dart
+Quadrilateral location;
+```
+
+### confidenceAsDocumentBoundary
+
+Returns the confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
+
+```dart
+int confidenceAsDocumentBoundary;
+```
+
+### crossVerificationStatus
+
+Returns the cross verification status of the result. The cross verification status determines whether the result item is approved by the multi-frame cross verification mechanism. If approved, the cross verification status is `CVS_PASSED`. Otherwise, it is `CVS_FAILED`.
+
+```dart
+EnumCrossVerificationStatus crossVerificationStatus;
+```

programming/flutter/api-reference/enhanced-image-result-item.md

@@ -0,0 +1,52 @@
+---
+layout: default-layout
+title: EnhancedImageResultItem - Dynamsoft Capture Vision Flutter SDK API Reference
+description: The class EnhancedImageResultItem represents a captured result item whose type is a enhanced image. It stores the enhanced image information.
+keywords: enhanced image result item, dart
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# EnhancedImageResultItem
+
+The `EnhancedImageResultItem` class is an extension of [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html) that represents a enhanced image. This is the most basic unit of the enhanced image result, one of the captured result types that the Capture Vision Router can output. 
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class EnhancedImageResultItem extends CapturedResultItem
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`imageData`](#imagedata) | *ImageData* | An `ImageData` object as the enhanced image. |
+| [`originalToLocalMatrix`](#originaltolocalmatrix) | *Matrix4* | The transformation matrix from the original image coordinate system to the local coordinate system. |
+
+The following methods are inherited from [`CapturedResultItem`]({{ site.dcv_flutter_api }}core/captured-result-item.html).
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`targetROIDefName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#targetroidefname) | *String* | The name of the target region of interest (ROI) where the captured result was found. |
+| [`taskName`]({{ site.dcv_flutter_api }}core/captured-result-item.html#taskname) | *String* | The name of the recognition task that produced the CapturedResultItem. |
+| [`type`]({{ site.dcv_flutter_api }}core/captured-result-item.html#type) | [*EnumCapturedResultItemType*]({{ site.dcv_flutter_api }}core/enum/captured-result-item-type.md) | The type of the captured result item. |
+
+### imageData
+
+An [`ImageData`]({{ site.dcv_flutter_api }}core/image-data.html) object for the enhanced image.
+
+```dart
+ImageData? imageData;
+```
+
+### originalToLocalMatrix
+
+The transformation matrix from the original image coordinate system to the local coordinate system.
+
+```dart
+Matrix4 originalToLocalMatrix;
+```

programming/flutter/api-reference/processed-document-result.md

@@ -0,0 +1,62 @@
+---
+layout: default-layout
+title: ProcessedDocumentResult - Dynamsoft Capture Vision Flutter SDK API Reference
+description: The class ProcessedDocumentResult represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
+keywords: detected boundaries, deskew images, enhanced images, dart
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# ProcessedDocumentResult
+
+The class `ProcessedDocumentResult` represents a collection of captured result items whose types are detected boundaries, deskew images or enhanced images.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class ProcessedDocumentResult extends CapturedResultBase
+```
+
+## Properties
+
+| Property | Types | Description |
+| -------- | ----- | ----------- |
+| [`DeskewedImageResultItems`](#deskewedimageresultitems) | *List<DeskewedImageResultItem>* | An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image. |
+| [`DetectedQuadResultItems`](#detectedquadresultitems) | *List<DetectedQuadResultItem>* | An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary. |
+| [`EnhancedImageResultItems`](#enhancedimageresultitems) | *List<EnhancedImageResultItem>* | A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image. |
+
+The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_flutter_api }}core/captured-result-base.html):
+
+| Property | Types | Description |
+| -------- | ----- | ----------- |
+| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. |
+| [`rotationTransformMatrix`]({{ site.dcv_flutter_api }}core/captured-result-base.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
+| [`errorCode`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errorcode) | *int* | The error code of this result. |
+| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) | *String* | The error message of this result. |
+
+### deskewedImageResultItems
+
+An array of [`DeskewedImageResultItem`](deskewed-image-result-item.md) objects, where each `DeskewedImageResultItem` represents a single deskewed image.
+
+```dart
+List<DeskewedImageResultItem>? deskewedImageResultItems;
+```
+
+### detectedQuadResultItems
+
+An array of [`DetectedQuadResultItem`](detected-quad-result-item.md) objects, where each `DetectedQuadResultItem` represents a single detected boundary.
+
+```dart
+List<DetectedQuadResultItem>? detectedQuadResultItems;
+```
+
+### enhancedImageResultItems
+
+A array of [`EnhancedImageResultItem`](enhanced-image-result-item.md) objects, where each `EnhancedImageResultItem` represents a single enhnanced image.
+
+```dart
+List<EnhancedImageResultItem>? enhancedImageResultItems;
+```

programming/flutter/api-reference/simplified-document-normalizer-settings.md

@@ -0,0 +1,131 @@
+---
+layout: default-layout
+title: SimplifiedDocumentNormalizerSettings - Dynamsoft Capture Vision Flutter Edition API Reference
+description: The class SimplifiedDocumentNormalizerSettings of Dynamsoft Capture Vision Flutter edition represents the simplified document normalizer settings.
+keywords: document normalizer settings, Flutter, dart
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# SimplifiedDocumentNormalizerSettings
+
+The `SimplifiedDocumentNormalizerSettings` class represents a series of simple settings related to the document scanning.
+
+## Definition
+
+*Assembly:* dynamsoft_capture_vision_flutter
+
+```dart
+class SimplifiedDocumentNormalizerSettings
+```
+
+## Properties
+
+| Property | Types | Description |
+| -------- | ----- | ----------- |
+| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *List<EnumGrayscaleTransformationMode>* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. |
+| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *List<EnumGrayscaleEnhancementMode>* | An array of GrayscaleEnhancementModes. |
+| [`colourMode`](#colourmode) | *EnumImageColourMode* | The grayscale transformation mode. It controls whether to decode the inverted text. |
+| [`pageSize`](#pagesize) | *Size* | The page size. |
+| [`brightness`](#brightness) | *int* | The brightness. |
+| [`contrast`](#contrast) | *int* | The contrast. |
+| [`maxThreadsInOneTask`](#maxthreadsinonetask) | *int* | The maximum number of threads in one task. |
+| [`scaleDownThreshold`](#scaledownthreshold) | *int* | The scale down threshold. |
+| [`minQuadrilateralAreaRatio`](#minquadrilateralarearatio) | *int* | The minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages). |
+| [`expectedDocumentsCount`](#expecteddocumentscount) | *int* | The number of documents expected to be detected. |
+
+### grayscaleTransformationModes
+
+Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-transformation-mode.html) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary.
+
+```dart
+List<EnumGrayscaleTransformationMode> grayscaleTransformationModes;
+```
+
+### grayscaleEnhancementModes
+
+Defines the grayscale enhancement modes with an array of [`EnumGrayscaleEnhancementModes`]({{ site.dcv_flutter_api }}core/enum/grayscale-enhancement-modes.html) items. This parameter can be quite powerful in increasing the border detection rate of your application should you experience any trouble in that area. To learn more about the `grayscaleEnhancementModes` and how they can be used, please visit the main [GrayscaleEnhancementModes]({{ site.dcv_parameters }}reference/image-parameter/grayscale-enhancement-modes.html) parameter page.
+
+```dart
+List<EnumGrayscaleEnhancementMode> grayscaleEnhancementModes;
+```
+
+### colourMode
+
+Defines the colour mode of the normalized image with an [`EnumImageColourMode`]({{ site.dcv_flutter_api }}core/enum/image-colour-mode.html) member. By default, the normalized image will output in colour. In order to make the result image grayscale or binary, setting the `colourMode` to the corresponding pixel type will do the trick.
+
+```dart
+EnumImageColourMode colourMode;
+```
+
+### pageSize
+
+The page size of the normalized image.
+
+```dart
+Size pageSize;
+```
+
+### brightness
+
+The brightness of the normalized image result.
+
+```dart
+@IntRange
+int brightness;
+```
+
+**Range**
+
+[-100, 100]
+
+### contrast
+
+The contrast of the normalized image result.
+
+```dart
+int contrast;
+```
+
+**Range**
+
+[-100,100]
+
+### maxThreadsInOneTask
+
+The maximum number of threads dedicated to a single task.
+
+```dart
+int maxThreadsInOneTask;
+```
+
+### scaleDownThreshold
+
+If the original image size is quite large, then the `scaledownThreshold` can be used to shrink the image and speed up the processing. If the shorter edge size is larger than the defined scale down threshold, the library will calculate the required width and height of the image and shrink it to that size before moving forward in the process.
+
+```dart
+int scaleDownThreshold;
+```
+
+### minQuadrilateralAreaRatio
+
+The minimum ratio between the target document area and the total image area. Only those exceeding this value will be output (measured in percentages).
+
+```dart
+int minQuadrilateralAreaRatio;
+```
+
+**Range**
+
+[0, 100]
+
+If expectedDocumentsCount is 1 && documentType is Document, the range is from 20 to 100.
+
+### expectedDocumentsCount
+
+The number of documents expected to be detected.
+
+```dart
+int expectedDocumentsCount;
+```