Merge pull request #57 from dynamsoft-docs/preview

update to internal commit d5ac1c98

Author: Dynamsoft-Jerson

programming/android/api-reference/detected-quads-result.md

@@ -30,6 +30,8 @@ class DetectedQuadsResult
 | [`getRotationTransformMatrix`](#getrotationtransformmatrix) | The rotation transformation matrix of the original image relative to the rotated image. |
 | [`getOriginalImageHashId`](#getoriginalimagehashid) | The hash id of the original image. You can use this ID to get the original image via `IntermediateResultManager` class. |
 | [`getOriginalImageTag`](#getoriginalimagetag) | The tag of the original image, from which you get the detected quads result. |
+| [`getErrorCode`](#geterrorcode) | Gets the error code of the detected quads result, if an error occurred. |
+| [`getErrorMessage`](#geterrormessage) | Gets the error message of the detected quads result, if an error occurred. |
 
 ### getItems
 
@@ -78,3 +80,27 @@ The tag of the original image.
 **See Also**
 
 * [ImageTag]({{ site.dcv_android_api }}core/basic-structures/image-tag.html)
+
+### getErrorCode
+
+Gets the error code of the detected quads result, if an error occurred.
+
+```java
+int getErrorCode();
+```
+
+**Return value**
+
+Returns the error code of the detected quads result, or 0 if no error occurred.
+
+### getErrorMessage
+
+Gets the error message of the detected quads result, if an error occurred.
+
+```java
+String getErrorMessage();
+```
+
+**Return value**
+
+Returns a string that describes the error message.

programming/android/api-reference/normalized-images-result.md

@@ -30,6 +30,8 @@ class NormalizedImagesResult
 | [`getRotationTransformMatrix`](#getrotationtransformmatrix) | Gets the rotation transformation matrix of the original image relative to the rotated image. |
 | [`getOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash id of the original image. You can use this ID to get the original image via IntermediateResultManager class. |
 | [`getOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the original image. |
+| [`getErrorCode`](#geterrorcode) | Gets the error code of the normalized images result, if an error occurred. |
+| [`getErrorMessage`](#geterrormessage) | Gets the error message of the normalized images result, if an error occurred. |
 
 ### getItems
 
@@ -78,3 +80,27 @@ ImageTag getOriginalImageTag();
 **Return Value**
 
 The tag of the original image.
+
+### getErrorCode
+
+Gets the error code of the normalized images result, if an error occurred.
+
+```java
+int getErrorCode();
+```
+
+**Return value**
+
+Returns the error code of the normalized images result, or 0 if no error occurred.
+
+### getErrorMessage
+
+Gets the error message of the normalized images result, if an error occurred.
+
+```java
+String getErrorMessage();
+```
+
+**Return value**
+
+Returns a string that describes the error message.

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

@@ -26,9 +26,9 @@ class SimplifiedDocumentNormalizerSettings
 
 | Attributes | Type | Description |
 | ---------- | ---- | ----------- |
-| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *EnumGrayscaleTransformationMode[]* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. |
-| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *EnumGrayscaleEnhancementModes[]* | An array of GrayscaleEnhancementModes. |
-| [`colourMode`](#colourmode) | *EnumImageColourMode* | The grayscale transformation mode. It controls whether to decode the inverted text. |
+| [`grayscaleTransformationModes`](#grayscaletransformationmodes) | *int[]* | An array of GrayscaleTransformationMode. It controls whether to detect the inverted document boundary. |
+| [`grayscaleEnhancementModes`](#grayscaleenhancementmodes) | *int[]* | An array of GrayscaleEnhancementModes. |
+| [`colourMode`](#colourmode) | *int* | The grayscale transformation mode. It controls whether to decode the inverted text. |
 | [`pageSize`](#pagesize) | *int[]* | The page size. |
 | [`brightness`](#brightness) | *int* | The brightness. |
 | [`contrast`](#contrast) | *int* | The contrast. |
@@ -46,23 +46,26 @@ class SimplifiedDocumentNormalizerSettings
 Defines the grayscale transformation modes with an array of [`EnumGrayscaleTransformationMode`]({{ site.dcv_enumerations }}core/grayscale-transformation-mode.html?lang=android) items. This parameter is important when working with inverted documents, and must be used in order to locate the inverted document boundary.
 
 ```java
-EnumGrayscaleTransformationMode[] grayscaleTransformationModes;
+@EnumGrayscaleTransformationMode
+int[] grayscaleTransformationModes;
 ```
 
 ### grayscaleEnhancementModes
 
 Defines the grayscale enhancement modes with an array of [`EnumGrayscaleEnhancementModes`]({{ site.dcv_enumerations }}core/grayscale-enhancement-modes.html?lang=android) 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.
 
 ```java
-EnumGrayscaleEnhancementMode[] grayscaleEnhancementModes;
+@EnumGrayscaleEnhancementMode
+int[] grayscaleEnhancementModes;
 ```
 
 ### colourMode
 
 Defines the colour mode of the normalized image with an [`EnumImageColourMode`]({{ site.dcv_enumerations }}document-normalizer/image-colour-mode.html?lang=android) 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.
 
 ```java
-EnumImageColourMode colourMode;
+@EnumImageColourMode
+int colourMode;
 ```
 
 ### pageSize
@@ -78,6 +81,7 @@ int[] pageSize;
 Defines the brightness of the normalized image result with an integer.
 
 ```java
+@IntRange(from = -100, to = 100)
 int brightness;
 ```
 
@@ -86,6 +90,7 @@ int brightness;
 Defines the contrast of the normalized image result with an integer.
 
 ```java
+@IntRange(from = 512)
 int contrast;
 ```
 
@@ -110,6 +115,8 @@ int scaleDownThreshold;
 The minimum ratio between the target document area and the total image area. Only those exceeding this value will be outputted (measured in percentages).
 
 ```java
+@IntRange(from = 0, to = 100)
+// If expectedDocumentsCount is 1 && documentType is Document, the range is from 20 to 100.
 int minQuadrilateralAreaRatio;
 ```
 
@@ -118,6 +125,7 @@ int minQuadrilateralAreaRatio;
 The number of documents expected to be detected.
 
 ```java
+@IntRange(from = 0)
 int expectedDocumentsCount;
 ```
 

programming/assets/maui-exclude.png

@@ -0,0 +1,54 @@
+---
+layout: default-layout
+title: DetectedQuadResultItem - Dynamsoft Capture Vision MAUI SDK API Reference
+description: The class DetectedQuadResultItem of DCV MAUI represents a captured result item whose type is detected quads, which contains the location and confidence as a document boundary.
+keywords: detected quads, MAUI
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DetectedQuadResultItem
+
+The `DetectedQuadResultItem` class is an extension of the [`CapturedResultItem`]({{ site.dcv_maui_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
+
+*Namespace:* Dynamsoft.DocumentNormalizer.Maui
+
+*Assembly:* Dynamsoft.DocumentNormalizer.Maui
+
+```csharp
+class DetectedQuadResultItem : 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. |
+
+The following properties are inherited from [`CapturedResultItem`]({{ site.dcv_maui_api }}core/captured-result-item.html).
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`Type`]({{ site.dcv_maui_api }}core/captured-result-item.html#type) | *[EnumCapturedResultItemType]({{ site.dcv_maui_api }}core/enum/captured-result-item-type.html)* | Get the type of the captured result item, indicating what kind of data it represents. |
+| [`TargetROIDefName`]({{ site.dcv_maui_api }}core/captured-result-item.html#targetroidefname) | *string* | Gets the name of the [`TargetROIDef`]({{ site.dcv_parameters_reference }}target-roi-def/) object which includes a task that generated the result. |
+| [`TaskName`]({{ site.dcv_maui_api }}core/captured-result-item.html#taskname) | *string* | The name of the task that generated the result. |
+
+### Location
+
+A [Quadrilateral]({{ site.dcv_maui_api }}core/quadrilateral.html) object that represents the location of the detected quadrilateral within the image or frame.
+
+```csharp
+Quadrilateral Location { get; }
+```
+
+### ConfidenceAsDocumentBoundary
+
+The confidence score of the detected quadrilateral's boundary, measuring the certainty that the detected quadrilateral represents the boundary of a document.
+
+```csharp
+int ConfidenceAsDocumentBoundary { get; }
+```

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

@@ -0,0 +1,73 @@
+---
+layout: default-layout
+title: DetectedQuadsResult - Dynamsoft Capture Vision MAUI SDK API Reference
+description: The class DetectedQuadsResult represents a captured result whose type is detected quads, which contains an array of DetectedQuadResultItems and the rotation transformation matrix of the original image relative to the rotated image.
+keywords: detected quads result, java, kotlin
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DetectedQuadsResult
+
+The `DetectedQuadsResult` class represents a collection of [`DetectedQuadResultItems`](detected-quad-result-item.md), the basic unit of a detected quad result.
+
+## Definition
+
+*Namespace:* Dynamsoft.DocumentNormalizer.Maui
+
+*Assembly:* Dynamsoft.DocumentNormalizer.Maui
+
+```csharp
+class DetectedQuadsResult
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`Items`](#items) | *IList<DetectedQuadResultItem>* | An array of [`DetectedQuadResultItem`](./detected-quad-result-item.md), which are the detected quadrilateral items. |
+| [`RotationTransformMatrix`](#rotationtransformmatrix) | *Matrix* | The rotation transformation matrix of the original image relative to the rotated image. |
+| [`OriginalImageHashId`](#originalimagehashid) | *string* | The hash id of the original image. You can use this ID to get the original image via `IntermediateResultManager` class. |
+| [`ErrorCode`](#errorcode) | *int* | The error code of the detected quads result, if an error occurred. |
+| [`ErrorMessage`](#errormessage) | *String* | The error message of the detected quads result, if an error occurred. |
+
+### Items
+
+An array of [`DetectedQuadResultItem`](./detected-quad-result-item.md), which represents the basic unit of the captured result, in this case, a detected quadrilateral.
+
+```csharp
+IList<DetectedQuadResultItem> Items { get; }
+```
+
+### RotationTransformMatrix
+
+The rotation transformation matrix of the original image relative to the rotated image. Please see [Matrix](https://developer.maui.com/reference/maui/opengl/Matrix){:target="_blank"} for more info.
+
+```csharp
+Matrix RotationTransformMatrix { get; }
+```
+
+### OriginalImageHashId
+
+The hash ID of the original image. You can use this ID to get the original image via [`IntermediateResultManager`]({{ site.dcv_maui_api }}core/intermediate-results/intermediate-result-manager.html) class.
+
+```csharp
+string OriginalImageHashId { get; }
+```
+
+### ErrorCode
+
+The error code of the detected quads result, if an error occurred.
+
+```csharp
+int ErrorCode { get; }
+```
+
+### ErrorMessage
+
+The error message of the detected quads result, if an error occurred.
+
+```csharp
+String ErrorMessage { get; }
+```

programming/maui/api-reference/detected-quads-result.md

@@ -0,0 +1,41 @@
+---
+layout: default-layout
+title: DocumentNormalizerModule - Dynamsoft Capture Vision MAUI SDK API Reference
+description: The class DocumentNormalizerModule provides general functions for document normalization sdk.
+keywords: general functions, java, kotlin
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+noTitleIndex: true
+---
+
+# DocumentNormalizerModule
+
+The `DocumentNormalizerModule` class defines general functions of the document normalizer module.
+
+## Definition
+
+*Namespace:* Dynamsoft.DocumentNormalizer.Maui
+
+*Assembly:* Dynamsoft.DocumentNormalizer.Maui
+
+```csharp
+class DocumentNormalizerModule
+```
+
+## Methods
+
+| Method | Description |
+|------- |-------------|
+| [`GetVersion`](#getversion) | Gets the version of Dynamsoft Document Normalizer. |
+
+### GetVersion
+
+Gets the version of Dynamsoft Document Normalizer.
+
+```csharp
+static string GetVersion();
+```
+
+**Return Value**
+
+The version of Dynamsoft Document Normalizer.

programming/maui/api-reference/document-normalizer-module.md

@@ -0,0 +1,28 @@
+---
+layout: default-layout
+title: EnumImageColourMode - Dynamsoft Capture Vision MAUI
+description: Enumeration EnumImageColourMode of DCV MAUI Edition defines the colour mode of the normalized image.
+keywords: colour mode, binary, grayscale, colour
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: EnumImageColourMode
+---
+
+# EnumImageColourMode
+
+Enumeration `EnumImageColourMode` defines the colour mode of the normalized image.
+
+## Definition
+
+*Namespace:* Dynamsoft.DocumentNormalizer.Maui
+
+*Assembly:* Dynamsoft.DocumentNormalizer.Maui
+
+```csharp
+public enum EnumImageColourMode
+{
+    ICM_Colour = 0,
+    ICM_GRAYSCALE = 1,
+    ICM_BINARY = 2
+}
+```