Skip to content

Commit 95062d0

Browse files
update to internal commit b1969b85
1 parent b036ecd commit 95062d0

File tree

7 files changed

+582
-4
lines changed

7 files changed

+582
-4
lines changed

_data/product_version.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ version_info_list_mobile:
2626
- value: latest version
2727
- value: 10.x
2828
child:
29+
- 10.4.2000_maui
2930
- 10.2.1101_maui
3031
- 10.2.1100_android
3132
- 10.2.1101_ios

_includes/sidelist-programming/programming-maui-v10.4.2000.html

Lines changed: 324 additions & 0 deletions
Large diffs are not rendered by default.

_includes/sidelist-programming/programming-maui.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@
2424
<ul lang="maui">
2525
<li lang="maui"><a href="{{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html" class="otherLinkColour">CaptureVisionRouterModule</a></li>
2626
<li lang="maui"><a href="{{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html" class="otherLinkColour">CapturedResultFilter</a></li>
27-
<li lang="maui"><a href="{{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html" class="otherLinkColour">CapturedResultReceiver</a></li>
28-
<li lang="maui"><a href="{{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/captured-result.html" class="otherLinkColour">CapturedResult</a></li>
27+
<li lang="maui"><a href="{{ site.dbr_maui_api }}capture-vision-router-lite/captured-result-receiver.html" class="otherLinkColour">CapturedResultReceiver</a></li>
28+
<li lang="maui"><a href="{{ site.dbr_maui_api }}capture-vision-router-lite/captured-result.html" class="otherLinkColour">CapturedResult</a></li>
2929
<li lang="maui"><a href="{{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html" class="otherLinkColour">IntermediateResultManager</a></li>
30-
<li lang="maui"><a href="{{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/preset-template.html" class="otherLinkColour">PresetTemplate</a></li>
31-
<li lang="maui"><a href="{{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a></li>
30+
<li lang="maui"><a href="{{ site.dbr_maui_api }}capture-vision-router-lite/preset-template.html" class="otherLinkColour">PresetTemplate</a></li>
31+
<li lang="maui"><a href="{{ site.dbr_maui_api }}capture-vision-router-lite/simplified-capture-vision-settings.html" class="otherLinkColour">SimplifiedCaptureVisionSettings</a></li>
3232
</ul>
3333
</li>
3434
</ul>
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: default-layout
3+
title: CapturedResultReceiver Interface - Dynamsoft Capture Vision Router Lite MAUI
4+
description: CapturedResultReceiver interface of DCV MAUI edition is designed as a standardized way for retrieving captured results.
5+
keywords: decoded barcodes, parsed results, captured results, CRR, result receiver, output
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# CapturedResultReceiver
12+
13+
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.
14+
15+
## Definition
16+
17+
*Namespace:* Dynamsoft.CaptureVisionRouter.Maui
18+
19+
*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui
20+
21+
```csharp
22+
interface ICapturedResultReceiver
23+
```
24+
25+
## Methods
26+
27+
| Method | Description |
28+
| ------ | ----------- |
29+
| [`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. |
30+
| [`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. |
31+
32+
### OnCapturedResultReceived
33+
34+
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.
35+
36+
```csharp
37+
void OnCapturedResultReceived(CapturedResult result);
38+
```
39+
40+
**Parameters**
41+
42+
`[in] result`: The captured result, an instance of [`CapturedResult`](captured-result.md).
43+
44+
### OnDecodedBarcodesReceived
45+
46+
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.
47+
48+
```csharp
49+
void OnDecodedBarcodesReceived(DecodedBarcodesResult result);
50+
```
51+
52+
**Parameters**
53+
54+
`[in] result`: The decoded barcode result, an instance of `DecodedBarcodesResult`.
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
layout: default-layout
3+
title: CapturedResult Class - Dynamsoft Capture Vision Router Lite MAUI
4+
description: CapturedResult class of DCV MAUI edition represents the result of a capture operation on an image.
5+
keywords: decoded barcode, parsed result, error code, output, captured result
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# CapturedResult
12+
13+
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.
14+
15+
> You might also looking for:
16+
>
17+
> - [DecodedBarcodesResult]({{ site.dbr_maui_api }}decoded-barcodes-result.html)
18+
19+
## Definition
20+
21+
*Namespace:* Dynamsoft.CaptureVisionRouter.Maui
22+
23+
*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui
24+
25+
```csharp
26+
class CapturedResult
27+
```
28+
29+
## Properties
30+
31+
| Property | Description |
32+
| --------- | ----------- |
33+
| [`OriginalImageHashId`](#originalimagehashid) | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
34+
| [`RotationTransformMatrix`](#rotationtransformmatrix) | The rotation transformation matrix of the original image relative to the rotated image. |
35+
| [`ErrorCode`](#errorcode) | The error code associated with the capture result. |
36+
| [`ErrorMessage`](#errormessage) | The error message associated with the capture result. |
37+
| [`DecodedBarcodesResult`](#decodedbarcodesresult) | An array of `BarcodeResultItem` objects, each representing a decoded barcode within the original image. |
38+
39+
### OriginalImageHashId
40+
41+
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.
42+
43+
```csharp
44+
string OriginalImageHashId { get;}
45+
```
46+
47+
### RotationTransformMatrix
48+
49+
The rotation transformation matrix of the original image relative to the rotated image.
50+
51+
```csharp
52+
Matrix RotationTransformMatrix { get; }
53+
```
54+
55+
### ErrorCode
56+
57+
Error code associated with the capture result.
58+
59+
```csharp
60+
int ErrorCode { get; }
61+
```
62+
63+
### ErrorMessage
64+
65+
Error string providing details about the error.
66+
67+
```csharp
68+
string ErrorMessage { get; }
69+
```
70+
71+
### DecodedBarcodesResult
72+
73+
A [`DecodedBarcodesResult`]({{ site.dbr_maui_api }}decoded-barcodes-result.html) object that represents all decoded barcode within the original image.
74+
75+
```csharp
76+
DecodedBarcodesResult DecodedBarcodesResult { get; }
77+
```
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default-layout
3+
title: EnumPresetTemplate - Dynamsoft Capture Vision Router Lite MAUI
4+
description: The enumeration PresetTemplate of Dynamsoft Vision Router describes the preset template.
5+
keywords: CaptureVisionTemplate, PresetTemplate, single barcode template, speed first, read-rate first
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
breadcrumbText: PresetTemplate
10+
---
11+
12+
# EnumPresetTemplate
13+
14+
`EnumPresetTemplate` class defines the preset tempate strings. These strings can be used when specifying template name with [`StartCapturing`](../multiple-file-processing.md#startcapturing) or [`Capture`](../single-file-processing.md#capture) methods.
15+
16+
## Definition
17+
18+
*Namespace:* Dynamsoft.CaptureVisionRouter.Maui
19+
20+
*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui
21+
22+
```csharp
23+
public class EnumPresetTemplate
24+
{
25+
public const string PT_DEFAULT = "Default";
26+
public const string PT_READ_BARCODES = "ReadBarcodes_Default";
27+
public const string PT_READ_BARCODES_SPEED_FIRST = "ReadBarcodes_SpeedFirst";
28+
public const string PT_READ_BARCODES_READ_RATE_FIRST = "ReadBarcodes_ReadRateFirst";
29+
public const string PT_READ_SINGLE_BARCODE = "ReadSingleBarcode";
30+
}
31+
```
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
layout: default-layout
3+
title: SimplifiedCaptureVisionSettings Class - Dynamsoft Capture Vision Router Lite MAUI
4+
description: SimplifiedCaptureVisionSettings class of DCV MAUI edition provides settings for capturing and recognizing images with the CaptureVisionRouter class.
5+
keywords: roi, result item type, min interval, timeout
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# SimplifiedCaptureVisionSettings
12+
13+
The `SimplifiedCaptureVisionSettings` class contains settings for capturing and recognizing images with the `CaptureVisionRouter` class.
14+
15+
## Definition
16+
17+
*Namespace:* Dynamsoft.CaptureVisionRouter.Maui
18+
19+
*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui
20+
21+
```csharp
22+
class SimplifiedCaptureVisionSettings
23+
```
24+
25+
## Properties
26+
27+
| Property | Type | Description |
28+
| ---------- | ---- | ----------- |
29+
| [`CapturedResultItemTypes`](#capturedresultitemtypes) | *EnumCapturedResultItemType* | Specifies the type(s) of CapturedItem(s) that will be captured. |
30+
| [`Roi`](#roi) | *[Quadrilateral]({{ site.dcv_maui_api }}core/quadrilateral.html)* | Specifies the region of interest (ROI) where the image capture and recognition will take place. |
31+
| [`RoiMeasuredInPercentage`](#roimeasuredinpercentage) | *bool* | Specifies whether the ROI is measured in pixels or as a percentage of the image size. |
32+
| [`MaxParallelTasks`](#maxparalleltasks) | *int* | Specifies the maximum number of parallel tasks that can be used for image capture and recognition. |
33+
| [`MinImageCaptureInterval`](#minimagecaptureinterval) | *int* | Set the minimum capture interval. It is measured in millisecond. |
34+
| [`Timeout`](#timeout) | *int* | Specifies the maximum time (in milliseconds) allowed for image capture and recognition. |
35+
| [`BarcodeSettings`](#barcodesettings) | *[SimplifiedBarcodeReaderSettings]({{ site.dbr_maui_api }}simplified-barcode-reader-settings.html)* | Specifies the settings for `DynamsoftBarcodeReader` tasks. |
36+
37+
### CapturedResultItemTypes
38+
39+
Specifies the type(s) of CapturedItem(s) that will be captured.
40+
41+
```csharp
42+
EnumCapturedResultItemType CapturedResultItemTypes { get; set; }
43+
```
44+
45+
### Roi
46+
47+
Specifies the region of interest (ROI) where the image capture and recognition will take place.
48+
49+
```csharp
50+
Quadrilateral Roi { get; set; }
51+
```
52+
53+
### RoiMeasuredInPercentage
54+
55+
Specifies whether the ROI is measured in pixels or as a percentage of the image size.
56+
57+
```csharp
58+
bool RoiMeasuredInPercentage { get; set; }
59+
```
60+
61+
### MaxParallelTasks
62+
63+
Specifies the maximum number of parallel tasks that can be used for image capture and recognition.
64+
65+
```csharp
66+
int MaxParallelTasks { get; set; }
67+
```
68+
69+
### MinImageCaptureInterval
70+
71+
Set the minimum capture interval. It is measured in millisecond.
72+
73+
```csharp
74+
int MinImageCaptureInterval { get; set; }
75+
```
76+
77+
### Timeout
78+
79+
Specifies the maximum time (in milliseconds) allowed for image capture and recognition.
80+
81+
```csharp
82+
int Timeout { get; set; }
83+
```
84+
85+
### BarcodeSettings
86+
87+
Specifies the settings for `DynamsoftBarcodeReader` tasks with a [`SimplifiedBarcodeReaderSettings`]({{ site.dbr_maui_api }}simplified-barcode-reader-settings.html) object.
88+
89+
```csharp
90+
SimplifiedBarcodeReaderSettings BarcodeSettings { get; set; }
91+
```

0 commit comments

Comments
 (0)