-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #157 from dynamsoft-docs/preview
update to internal commit ee48cb75
- Loading branch information
Showing
31 changed files
with
1,998 additions
and
234 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
67 changes: 67 additions & 0 deletions
67
...e/capture-vision-router/auxiliary-classes/captured-result-receiver-v2.2.3000.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
87 changes: 87 additions & 0 deletions
87
...-reference/capture-vision-router/auxiliary-classes/captured-result-v2.2.3000.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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; } | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.