Skip to content

Commit

Permalink
Merge pull request #157 from dynamsoft-docs/preview
Browse files Browse the repository at this point in the history
update to internal commit ee48cb75
  • Loading branch information
Dynamsoft-Jerson authored Oct 24, 2024
2 parents c9b11df + 847f56d commit 2f9c41f
Show file tree
Hide file tree
Showing 31 changed files with 1,998 additions and 234 deletions.
7 changes: 6 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ ddn_android_api: /document-normalizer/docs/mobile/programming/android/api-refere
ddn_android: /document-normalizer/docs/mobile/programming/android/
ddn_ios_api: /document-normalizer/docs/mobile/programming/ios/api-reference/
ddn_ios: /document-normalizer/docs/mobile/programming/ios/
ddn_maui_api: /document-normalizer/docs/mobile/programming/maui/api-reference/
ddn_maui: /document-normalizer/docs/mobile/programming/maui/
dce_android_api: /camera-enhancer/docs/mobile/programming/android/
dce_ios_api: /camera-enhancer/docs/mobile/programming/ios/

Expand All @@ -65,7 +67,6 @@ dlr_android: /label-recognition/docs/mobile/programming/android/
dlr_android_api: /label-recognition/docs/mobile/programming/android/api-reference/
dlr_ios: /label-recognition/docs/mobile/programming/objectivec-swift/
dlr_ios_api: /label-recognition/docs/mobile/programming/objectivec-swift/api-reference/

dcp_android: /code-parser/docs/mobile/programming/android/
dcp_android_api: /code-parser/docs/mobile/programming/android/api-reference/
dcp_ios: /code-parser/docs/mobile/programming/ios/
Expand All @@ -81,6 +82,10 @@ dcvb_root: /capture-vision/docs/core/

dbr_maui: /barcode-reader/docs/mobile/programming/maui/
dbr_maui_api: /barcode-reader/docs/mobile/programming/maui/api-reference/
dlr_maui: /label-recognition/docs/mobile/programming/maui/
dlr_maui_api: /label-recognition/docs/mobile/programming/maui/api-reference/
ddn_maui: /document-normalizer/docs/mobile/programming/maui/
ddn_maui_api: /document-normalizer/docs/mobile/programming/maui/api-reference/
dcv_maui: /capture-vision/docs/mobile/programming/maui/
dcv_maui_api: /capture-vision/docs/mobile/programming/maui/api-reference/
dce_maui: /camera-enhancer/docs/mobile/programming/maui/
Expand Down
5 changes: 3 additions & 2 deletions _data/product_version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ useGroupedVersion: true
# - latest version

version_info_list_mobile:
- value: latest version (2.4.2000)
- value: latest version
- value: 2.x
child:
- 2.2.3000
- 2.2.3000_android
- 2.2.3000_ios
147 changes: 72 additions & 75 deletions _includes/sidelist-programming/programming-maui.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class LicenseModule
| ------ | ----------- |
| [`getVersion`](#getversion) | Get the version of Dynamsoft License module. |

## getVersion
### getVersion

Get the version of Dynamsoft License module.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
layout: default-layout
title: CapturedResultReceiver Interface - Dynamsoft Capture Vision MAUI Edition
description: CapturedResultReceiver interface of DCV MAUI edition is designed as a standardized way for retrieving captured results.
keywords: decoded barcodes, parsed results, captured results, CRR, result receiver, output
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# CapturedResultReceiver

The `CapturedResultReceiver` interface is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. By implementing the `CapturedResultReceiver`, you will receive the callback of the various types of captured results, such as original image, decoded barcode, recognized text line, detected quad, normalized image, or parsed data. The `CapturedResultReceiver` can add a receiver for any type of captured result or for a specific type of captured result, based on the method that is implemented.

## Definition

*Namespace:* Dynamsoft.CaptureVisionRouter.Maui

*Assembly:* Dynamsoft.CaptureVisionRouter.Maui

```csharp
interface ICapturedResultReceiver
```

## Methods

| Method | Description |
| ------ | ----------- |
| [`OnCapturedResultReceived`](#oncapturedresultreceived) | This callback method delivers a `CapturedResult`, which is an object containning all kinds of captured result items that are captured from the image. |
| [`OnDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | This callback method delivers a `DecodedBarcodesResult`, which is an object containning all `CRIT_BARCODE` typed captured result items that are captured from the image. |
| [`OnParsedResultsReceived`](#onparsedresultsreceived) | This callback method delivers a `ParsedResult`, which is an object containning all `CRIT_PARSED_RESULT` typed captured result items that are captured from the image. |

### OnCapturedResultReceived

This callback method delivers a `CapturedResult`, which is an object containning all kinds of captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnCapturedResultReceived(CapturedResult result);
```

**Parameters**

`[in] result`: The captured result, an instance of [`CapturedResult`](captured-result.md).

### OnDecodedBarcodesReceived

This callback method delivers a `DecodedBarcodesResult`, which is an object containning all `CRIT_BARCODE` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnDecodedBarcodesReceived(DecodedBarcodesResult result);
```

**Parameters**

`[in] result`: The decoded barcode result, an instance of `DecodedBarcodesResult`.

### OnParsedResultsReceived

This callback method delivers a `ParsedResult`, which is an object containning all `CRIT_PARSED_RESULT` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnParsedResultsReceived(ParsedResult result);
```

**Parameters**

`[in] result`: The parsed result, an instance of [`ParsedResult`]({{site.dcp_maui_api}}parsed-result.html).
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,16 @@ interface ICapturedResultReceiver

| Method | Description |
| ------ | ----------- |
| [`OnCapturedResultReceived`](#oncapturedresultreceived) | The callback triggered when a generic captured result is available, occurring each time an image finishes its processing. |
| [`OnDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The callback triggered when decoded barcodes are available, occurring each time an image finishes its processing. |
| [`OnParsedResultsReceived`](#onparsedresultsreceived) | The callback triggered when parsed results are available, occurring each time an image finishes its processing. |
| [`OnCapturedResultReceived`](#oncapturedresultreceived) | This callback method delivers a `CapturedResult`, which is an object containning all kinds of captured result items that are captured from the image. |
| [`OnDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | This callback method delivers a `DecodedBarcodesResult`, which is an object containning all `CRIT_BARCODE` typed captured result items that are captured from the image. |
| [`OnParsedResultsReceived`](#onparsedresultsreceived) | This callback method delivers a `ParsedResult`, which is an object containning all `CRIT_PARSED_RESULT` typed captured result items that are captured from the image. |
| [`OnRecognizedTextLinesReceived`](#onrecognizedtextlinesreceived) | This callback method delivers a `RecognizedTextLinesResult`, which is an object containning all `CRIT_TEXT_LINE` typed captured result items that are captured from the image. |
| [`OnDetectedQuadsReceived`](#ondetectedquadsreceived) | This callback method delivers a `DetectedQuadsResult`, which is an object containning all `CRIT_DETECTED_QUAD` typed captured result items that are captured from the image. |
| [`OnNormalizedImagesReceived`](#onnormalizedimagesreceived) | This callback method delivers a `NormalizedImagesResult`, which is an object containning all `CRIT_NORMALIZED_IMAGE` typed captured result items that are captured from the image. |

### OnCapturedResultReceived

The callback method triggered when a generic captured result is available, occurring each time an image finishes its processing. This callback can be used for any result that does not fit into the specific categories of the other callbacks.
This callback method delivers a `CapturedResult`, which is an object containning all kinds of captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnCapturedResultReceived(CapturedResult result);
Expand All @@ -44,7 +47,7 @@ void OnCapturedResultReceived(CapturedResult result);

### OnDecodedBarcodesReceived

The callback triggered when decoded barcodes are available, occurring each time an image finishes its processing. This callback is used to handle barcodes that have been successfully decoded by Dynamsoft Barcode Reader
This callback method delivers a `DecodedBarcodesResult`, which is an object containning all `CRIT_BARCODE` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnDecodedBarcodesReceived(DecodedBarcodesResult result);
Expand All @@ -56,7 +59,7 @@ void OnDecodedBarcodesReceived(DecodedBarcodesResult result);

### OnParsedResultsReceived

The callback triggered when parsed results are available, occurring each time an image finishes its processing. This callback is used for handling results that have been parsed into a structured format by Dynamsoft Code Parser.
This callback method delivers a `ParsedResult`, which is an object containning all `CRIT_PARSED_RESULT` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnParsedResultsReceived(ParsedResult result);
Expand All @@ -65,3 +68,39 @@ void OnParsedResultsReceived(ParsedResult result);
**Parameters**

`[in] result`: The parsed result, an instance of [`ParsedResult`]({{site.dcp_maui_api}}parsed-result.html).

### OnRecognizedTextLinesReceived

This callback method delivers a `RecognizedTextLinesResult`, which is an object containning all `CRIT_TEXT_LINE` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnRecognizedTextLinesReceived(RecognizedTextLinesResult result);
```

**Parameters**

`[in] result`: The recognized text line result, an instance of `RecognizedTextLinesResult`.

### OnDetectedQuadsReceived

This callback method delivers a `DetectedQuadsResult`, which is an object containning all `CRIT_DETECTED_QUAD` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnDetectedQuadsReceived(DetectedQuadsResult result);
```

**Parameters**

`[in] result`: The detected quads result, an instance of `DetectedQuadsResult`.

### OnNormalizedImagesReceived

This callback method delivers a `NormalizedImagesResult`, which is an object containning all `CRIT_NORMALIZED_IMAGE` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing.

```csharp
void OnNormalizedImagesReceived(NormalizedImagesResult result);
```

**Parameters**

`[in] result`: The normalized image result, an instance of `NormalizedImagesResult`.
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
---
layout: default-layout
title: CapturedResult Class - Dynamsoft Capture Vision MAUI Edition
description: CapturedResult class of DCV MAUI edition represents the result of a capture operation on an image.
keywords: decoded barcode, parsed result, error code, output, captured result
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# CapturedResult

The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array that contains multiple items, each of which may be a barcode, text line, detected quad, normalized image, original image, parsed item, etc.

> You might also looking for:
>
> - [DecodedBarcodesResult]({{ site.dbr_maui_api }}decoded-barcodes-result.html)
> - [ParsedResults]({{ site.dcp_maui_api }}parsed-result.html)
## Definition

*Namespace:* Dynamsoft.CaptureVisionRouter.Maui

*Assembly:* Dynamsoft.CaptureVisionRouter.Maui

```csharp
class CapturedResult
```

## Properties

| Property | Description |
| --------- | ----------- |
| [`OriginalImageHashId`](#originalimagehashid) | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
| [`RotationTransformMatrix`](#rotationtransformmatrix) | The rotation transformation matrix of the original image relative to the rotated image. |
| [`ErrorCode`](#errorcode) | The error code associated with the capture result. |
| [`ErrorMessage`](#errormessage) | The error message associated with the capture result. |
| [`DecodedBarcodesResult`](#decodedbarcodesresult) | An array of `BarcodeResultItem` objects, each representing a decoded barcode within the original image. |
| [`ParsedResult`](#parsedresult) | An array of `ParsedResultItem` objects. |

### OriginalImageHashId

The hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) class.

```csharp
string OriginalImageHashId { get;}
```

### RotationTransformMatrix

The rotation transformation matrix of the original image relative to the rotated image.

```csharp
Matrix RotationTransformMatrix { get; }
```

### ErrorCode

Error code associated with the capture result.

```csharp
int ErrorCode { get; }
```

### ErrorMessage

Error string providing details about the error.

```csharp
string ErrorMessage { get; }
```

### DecodedBarcodesResult

A [`DecodedBarcodesResult`]({{ site.dbr_maui_api }}decoded-barcodes-result.html) object that represents all decoded barcode within the original image.

```csharp
DecodedBarcodesResult DecodedBarcodesResult { get; }
```

### ParsedResult

A [`ParsedResult`]({{ site.dcp_maui_api }}parsed-result.html) that represents all parsed result items within the original image.

```csharp
ParsedResult ParsedResult { get; }
```
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ class CapturedResult
| [`ErrorMessage`](#errormessage) | The error message associated with the capture result. |
| [`DecodedBarcodesResult`](#decodedbarcodesresult) | An array of `BarcodeResultItem` objects, each representing a decoded barcode within the original image. |
| [`ParsedResult`](#parsedresult) | An array of `ParsedResultItem` objects. |
| [`RecognizedTextLinesResult`](#recognizedtextlinesresult) | An array of `RecognizedTextLinesResultItem` objects, each representing a recognized text line within the original image. |
| [`DetectedQuadsResult`](#detectedquadsresult) | An array of `DetectedQuadsResultItem` objects, each representing a detected quad within the original image. |
| [`NormalizedImagesResult`](#normalizedimagesresult) | An array of `NormalizedImagesResultItem` objects, each representing a normalized image within the original image. |

### OriginalImageHashId

Expand Down Expand Up @@ -85,3 +88,27 @@ A [`ParsedResult`]({{ site.dcp_maui_api }}parsed-result.html) that represents al
```csharp
ParsedResult ParsedResult { get; }
```

### RecognizedTextLinesResult

A [`RecognizedTextLinesResult`]({{ site.dtr_maui_api }}recognized-text-lines-result.html) object that represents all recognized text lines within the original image.

```csharp
RecognizedTextLinesResult RecognizedTextLinesResult { get; }
```

### DetectedQuadsResult

A [`DetectedQuadsResult`]({{ site.dqr_maui_api }}detected-quads-result.html) object that represents all detected quads within the original image.

```csharp
DetectedQuadsResult DetectedQuadsResult { get; }
```

### NormalizedImagesResult

A [`NormalizedImagesResult`]({{ site.dnr_maui_api }}normalized-images-result.html) object that represents all normalized images within the original image.

```csharp
NormalizedImagesResult NormalizedImagesResult { get; }
```
Loading

0 comments on commit 2f9c41f

Please sign in to comment.