Skip to content

Commit 3a6d52f

Browse files
update to internal commit 209d425a
1 parent b566a17 commit 3a6d52f

40 files changed

+1753
-67
lines changed

_config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@ dcp_flutter: /code-parser/docs/mobile/programming/flutter/
4141
dcp_flutter_api: /code-parser/docs/mobile/programming/flutter/api-reference/
4242
dce_flutter: /camera-enhancer/docs/mobile/programming/flutter/
4343
dce_flutter_api: /camera-enhancer/docs/mobile/programming/flutter/api-reference/
44+
ddn_flutter: /document-normalizer/docs/mobile/programming/flutter/
45+
ddn_flutter_api: /document-normalizer/docs/mobile/programming/flutter/api-reference/
46+
dlr_flutter: /label-recognizer/docs/mobile/programming/flutter/
47+
dlr_flutter_api: /label-recognizer/docs/mobile/programming/flutter/api-reference/
4448

4549
xamarin: /capture-vision/docs/mobile/programming/xamarin/
4650
xamarin-api: /capture-vision/docs/mobile/programming/xamarin/api-reference/

_includes/sidelist-full-tree.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@
1010
<a href="{{ site.dcv_maui }}" class="otherLinkColour">MAUI Edition Introduction</a>
1111
</li>
1212
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
13+
<li lang="flutter">
14+
<a href="{{ site.dcv_flutter }}" class="otherLinkColour">Flutter Edition Introduction</a>
15+
</li>
16+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-flutter.html" -%}

_includes/sidelist-programming/programming-flutter.html

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

programming/android/api-reference/core/basic-structures/image-source-adapter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class ImageSourceAdapter
3232
| [`getBufferOverflowProtectionMode`](#getbufferoverflowprotectionmode) | Get the current mode for handling buffer overflow. |
3333
| [`getColourChannelUsageType`](#getcolourchannelusagetype) | Get the current usage type for color channels in images. |
3434
| [`getImageCount`](#getimagecount) | Get the current number of images in the buffer. |
35-
| [`getImage`](#getimage) | Get a buffered image. Implementing classes should return a Promise that resolves with an instance of `DSImageData`. |
35+
| [`getImage`](#getimage) | Get a buffered image. Implementing classes should return a Promise that resolves with an instance of `ImageData`. |
3636
| [`getMaxImageCount`](#getmaximagecount) | Get the maximum number of images that can be buffered. |
3737
| [`hasImage`](#hasimage) | Checks if an image with the specified ID is present in the buffer. |
3838
| [`hasNextImageToFetch`](#hasnextimagetofetch) | Determines whether there are more images available to fetch. |

programming/android/api-reference/core/enum/region-object-element-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ public @interface EnumRegionObjectElementType
3333
/**The type of subclass DeskewedImageElement.*/
3434
int ROET_DESKEWED_IMAGE = 6;
3535
/**The type of subclass EnhancedImageElement.*/
36-
int ROET_ENHANCED_IMAGE = 6;
36+
int ROET_ENHANCED_IMAGE = 7;
3737
}
3838
```

programming/flutter/api-reference/capture-vision-router/capture-vision-router.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,35 @@ A `CaptureVisionRouter` instance accepts and processes images from an image sour
2323
class CaptureVisionRouter
2424
```
2525

26-
## Capture Methods
26+
## Static Properties
27+
28+
Returns the singleton instance of `CaptureVisionRouter`.
29+
30+
```dart
31+
static CaptureVisionRouter get instance;
32+
```
33+
34+
## Methods
35+
36+
- Capture from an Image
2737

2838
| Method | Description |
29-
| --- | --- |
39+
| ------ | ----------- |
3040
| [`capture`](#capture) | Processes an image using the specified template and outputs a CapturedResult. |
3141
| [`captureFile`](#capturefile) | Processes an image from a file path using the specified template. |
3242
| [`captureFileBytes`](#capturefilebytes) | Processes an image from a byte array using the specified template. |
43+
44+
- Capture from the Camera
45+
46+
| Method | Description |
47+
| ------ | ----------- |
3348
| [`startCapturing`](#startcapturing) | Starts the capturing process using the specified template. |
3449
| [`stopCapturing`](#stopcapturing) | Stops the capturing process and closes the camera. |
3550

3651
## Settings Management Methods
3752

3853
| Method | Description |
39-
| --- | --- |
54+
| ------ | ----------- |
4055
| [`getSimplifiedSettings`](#getsimplifiedsettings) | Returns a subset of the full applied settings as a SimplifiedCaptureVisionSettings object. |
4156
| [`getTemplateNames`](#gettemplatenames) | Returns a list of all available Capture Vision template names. |
4257
| [`initSettings`](#initsettings) | Initializes the settings using a JSON template string. |
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: default-layout
3+
title: CapturedResultFilter Class - Dynamsoft Capture Vision Flutter
4+
description: CapturedResultFilter class of DCV Flutter provides a filter for managing and filtering results.
5+
keywords: filter, capture vision, barcode reader, flutter, multiframeresultcrossfilter, result
6+
needGenerateH3Content: true
7+
needAutoGenerateSidebar: true
8+
noTitleIndex: true
9+
---
10+
11+
# CapturedResultFilter
12+
13+
Abstract class `CapturedResultFilter` is responsible for filtering captured results. It is officially implemented as [MultiFrameResultCrossFilter](multi-frame-result-cross-filter.md).
14+
15+
## Definition
16+
17+
*Assembly:* dynamsoft_capture_vision_flutter
18+
19+
```dart
20+
abstract class CapturedResultFilter
21+
```

programming/flutter/api-reference/capture-vision-router/captured-result-receiver.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ class CapturedResultReceiver
2424

2525
| Method | Description |
2626
| ------ | ----------- |
27-
| [`onCapturedResultReceived`](#oncapturedresultreceived) | This callback is triggered when any kind of captured result is available at the end of the recognition process. |
28-
| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | This callback is triggered when decoded barcode(s) are available at the end of the recognition process. |
29-
| [`onParsedResultsReceived`](#onparsedreultsreceived) | This callback is triggered when decoded barcode(s) are available at the end of the recognition process. |
27+
| [`onCapturedResultReceived`](#oncapturedresultreceived) | The callback invoked when captured results become available. It is triggered once for each image after its processing is completed. |
28+
| [`onDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | The callback invoked when decoded barcodes become available. It is triggered once for each image after its processing is completed. |
29+
| [`onParsedResultsReceived`](#onparsedreultsreceived) | The callback invoked when parsed results become available. It is triggered once for each image after its processing is completed.|
30+
| [`onProcessedDocumentResultReceived`](#onparsedreultsreceived) | The callback invoked when processed document results become available. It is triggered once for each image after its processing is completed. |
31+
| [`onRecognizedTextLinesReceived`](#onparsedreultsreceived) | The callback invoked when recognized text lines become available. It is triggered once for each image after its processing is completed. |
3032

3133
### onCapturedResultReceived
3234

@@ -59,3 +61,31 @@ This callback method delivers a [`ParsedResult`]({{ site.dcp_flutter_api }}parse
5961
```dart
6062
Future<void> Function(ParsedResult result)? onParsedResultsReceived;
6163
```
64+
65+
**Parameters**
66+
67+
`result`: The parsed result, an instance of [`ParsedResult`]({{ site.dcp_flutter_api }}parsed-result.html).
68+
69+
### onProcessedDocumentResultReceived
70+
71+
This callback method delivers a [`ProcessedDocumentResult`]({{ site.ddn_flutter_api }}processed-document-result.html), which is an object representing any captured result of type `detectedQuad`, `deskewedImage` and `enhancedImage` that is taken from an image or a video frame. The callback is triggered each time an image finishes processing, regardless of whether there is a valid result or not.
72+
73+
```dart
74+
Future<void> Function(ProcessedDocumentResult result)? onProcessedDocumentResultReceived;
75+
```
76+
77+
**Parameters**
78+
79+
`result`: The document processing results, an instance of [`ProcessedDocumentResult`]({{ site.ddn_flutter_api }}processed-document-result.html).
80+
81+
### onRecognizedTextLinesReceived
82+
83+
This callback method delivers a [`RecognizedTextLinesResult`]({{ site.dlr_flutter_api }}recognized-text-lines-result.html), which is an object representing any captured result of type `recognizedTextLines` that is taken from an image or a video frame. The callback is triggered each time an image finishes processing, regardless of whether there is a valid result or not.
84+
85+
```dart
86+
Future<void> Function(RecognizedTextLinesResult result)? onRecognizedTextLinesReceived;
87+
```
88+
89+
**Parameters**
90+
91+
`result`: The text recognition result, an instance of [`RecognizedTextLinesResult`]({{ site.dlr_flutter_api }}recognized-text-lines-result.html).

programming/flutter/api-reference/capture-vision-router/captured-result.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,55 +23,56 @@ The `CapturedResult` class represents the result of a capture operation on an im
2323
*Assembly:* dynamsoft_capture_vision_flutter
2424

2525
```dart
26-
class CapturedResult
26+
class CapturedResult extends CapturedResultBase
2727
```
2828

2929
## Properties
3030

3131
| Property | Type | Description |
32-
| --------- | ----------- |
33-
| [`originalImageHashId`](#originalimagehashid) | *String* | The hash ID of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
34-
| [`rotationTransformMatrix`](#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
35-
| [`errorCode`](#errorcode) | *int* | The error code associated with the capture result. |
36-
| [`errorMessage`](#errormessage) | *String* | The error message associated with the capture result. |
37-
| [`decodedBarcodesResult`](#decodedbarcodesresult) | [*DecodedBarcodesResult*]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html) | A [`DecodedBarcodesResult`](decoded-barcodes-result.md) object that represents all of the decoded barcode(s) within the original image. |
32+
| -------- | ---- | ----------- |
33+
| [`items`](#items) | *List\<CapturedResultItem\>?* | A list of [`CapturedResultItem`](captured-result-item.md) objects. |
34+
| [`decodedBarcodesResult`](#decodedbarcodesresult) | [*DecodedBarcodesResult*]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html) | All results of type `barcode` in the `CapturedResult` as a `DecodedBarcodesResult` object. |
35+
| [`recognizedTextLinesResult`](#recognizedtextlinesresult) | [*RecognizedTextLinesResult*]({{ site.dlr_flutter_api }}recognized-text-lines-result.html) | All results of type `textLine` in the `CapturedResult` as a `RecognizedTextLinesResult` object. |
36+
| [`processedDocumentResult`](#processeddocumentresult) | [*ProcessedDocumentResult*]({{ site.ddn_flutter_api }}processed-document-result.html) | All results of type `detectedQuad`, `deskewedImage` and `enhancedImage` in the `CapturedResult` as a `ProcessedDocumentResult` object. |
37+
| [`parsedResult`](#parsedresult) | [*ParsedResult*]({{ site.dcp_flutter_api }}parsed-result.html) | All results of type `parsedResult` in the `CapturedResult` as a `ParsedResult` object. |
3838

39-
### originalImageHashId
4039

41-
Returns the hash ID of the original image that contains the captured result. You can use this ID to get the original image via the [`IntermediateResultManager`](./intermediate-result-manager.md) class.
40+
### items
41+
42+
A list of [`CapturedResultItem`]({{ site.crr_flutter_api }}captured-result-item.html) objects.
4243

4344
```dart
44-
String originalImageHashId,
45+
List<CapturedResultItem>? items;
4546
```
4647

47-
### rotationTransformMatrix
48+
### decodedBarcodesResult
4849

49-
The rotation transformation matrix (represented as a [`Matrix4`](https://api.flutter.dev/flutter/package-vector_math_vector_math_64/Matrix4-class.html)]) of the original image relative to the rotated image.
50+
All results of type `barcode` in the `CapturedResult` as a `DecodedBarcodesResult` object.
5051

5152
```dart
52-
Matrix4 rotationTransformMatrix;
53+
DecodedBarcodesResult? decodedBarcodesResult;
5354
```
5455

55-
### errorCode
56+
### recognizedTextLinesResult
5657

57-
The error code produced by the library and associated with the captured result should something go wrong during the recognition process.
58+
All results of type `textLine` in the `CapturedResult` as a `RecognizedTextLinesResult` object.
5859

5960
```dart
60-
int errorCode;
61+
RecognizedTextLinesResult? recognizedTextLinesResult;
6162
```
6263

63-
### errorMessage
64+
#### processedDocumentResult
6465

65-
The error string associated with the error code, providing details about the error.
66+
All results of type `detectedQuad`, `deskewedImage` and `enhancedImage` in the `CapturedResult` as a `ProcessedDocumentResult` object.
6667

6768
```dart
68-
String errorMessage;
69+
ProcessedDocumentResult? processedDocumentResult;
6970
```
7071

71-
### decodedBarcodesResult
72+
### parsedResult
7273

73-
A [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html) object that represents all of the decoded barcode(s) within the original image.
74+
All results of type `parsedResult` in the `CapturedResult` as a `ParsedResult` object.
7475

7576
```dart
76-
DecodedBarcodesResult? decodedBarcodesResult;
77+
ParsedResult? parsedResult;
7778
```

programming/flutter/api-reference/utility/multi-frame-cross-filter.md renamed to programming/flutter/api-reference/capture-vision-router/multi-frame-cross-filter.md

File renamed without changes.

0 commit comments

Comments
 (0)