Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ dcp_flutter: /code-parser/docs/mobile/programming/flutter/
dcp_flutter_api: /code-parser/docs/mobile/programming/flutter/api-reference/
dce_flutter: /camera-enhancer/docs/mobile/programming/flutter/
dce_flutter_api: /camera-enhancer/docs/mobile/programming/flutter/api-reference/
ddn_flutter: /document-normalizer/docs/mobile/programming/flutter/
ddn_flutter_api: /document-normalizer/docs/mobile/programming/flutter/api-reference/
dlr_flutter: /label-recognition/docs/mobile/programming/flutter/
dlr_flutter_api: /label-recognition/docs/mobile/programming/flutter/api-reference/

xamarin: /capture-vision/docs/mobile/programming/xamarin/
xamarin-api: /capture-vision/docs/mobile/programming/xamarin/api-reference/
Expand Down
1 change: 1 addition & 0 deletions _data/full_tree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ tree_file_list:
- sidelist-programming/programming-android.html
- sidelist-programming/programming-ios.html
- sidelist-programming/programming-maui.html
- sidelist-programming/programming-flutter.html
4 changes: 4 additions & 0 deletions _includes/sidelist-full-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@
<a href="{{ site.dcv_maui }}" class="otherLinkColour">MAUI Edition Introduction</a>
</li>
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
<li lang="flutter">
<a href="{{ site.dcv_flutter }}" class="otherLinkColour">Flutter Edition Introduction</a>
</li>
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-flutter.html" -%}
695 changes: 695 additions & 0 deletions _includes/sidelist-programming/programming-flutter.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ void updateSettings(String templateName, SimplifiedCaptureVisionSettings setting

`[in] templateName`: Specify the name of the template that you want to update.

`[in] settings`: An object of SimplifiedCaptureVisionSettings.
`[in] settings`: An object of `SimplifiedCaptureVisionSettings`.

**Exception**

Expand Down Expand Up @@ -194,6 +194,8 @@ Returns an object that contains settings for the specified `CaptureVisionTemplat
String outputSettings(String templateName, boolean includeDefaultValues) throws CaptureVisionRouterException;
```

**Parameters**

`[in] templateName`: The name of the template that you want to output.

`[in] includeDefaultValues`: A boolean value that indicates whether to include default values in the output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ CapturedResult capture(ImageData imageData, String templateName);

**Parameters**

`[in] buffer`: A [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object that contains image info.
`[in] imageData`: A [`ImageData`]({{ site.dcv_android_api }}core/basic-structures/image-data.html) object that contains image info.

`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ class ImageSourceAdapter
| [`getBufferOverflowProtectionMode`](#getbufferoverflowprotectionmode) | Get the current mode for handling buffer overflow. |
| [`getColourChannelUsageType`](#getcolourchannelusagetype) | Get the current usage type for color channels in images. |
| [`getImageCount`](#getimagecount) | Get the current number of images in the buffer. |
| [`getImage`](#getimage) | Get a buffered image. Implementing classes should return a Promise that resolves with an instance of `DSImageData`. |
| [`getImage`](#getimage) | Get a buffered image. Implementing classes should return a Promise that resolves with an instance of `ImageData`. |
| [`getMaxImageCount`](#getmaximagecount) | Get the maximum number of images that can be buffered. |
| [`hasImage`](#hasimage) | Checks if an image with the specified ID is present in the buffer. |
| [`hasNextImageToFetch`](#hasnextimagetofetch) | Determines whether there are more images available to fetch. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ public @interface EnumRegionObjectElementType
/**The type of subclass DeskewedImageElement.*/
int ROET_DESKEWED_IMAGE = 6;
/**The type of subclass EnhancedImageElement.*/
int ROET_ENHANCED_IMAGE = 6;
int ROET_ENHANCED_IMAGE = 7;
}
```

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: default-layout
title: CapturedResultFilter Class - Dynamsoft Capture Vision Flutter
description: CapturedResultFilter class of DCV Flutter provides a filter for managing and filtering results.
keywords: filter, capture vision, barcode reader, flutter, multiframeresultcrossfilter, result
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# CapturedResultFilter

Abstract class `CapturedResultFilter` is responsible for filtering captured results. It is officially implemented as [MultiFrameResultCrossFilter](multi-frame-cross-filter.md).

## Definition

*Assembly:* dynamsoft_capture_vision_flutter

```dart
abstract class CapturedResultFilter
```
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ class CapturedResultReceiver

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

### onCapturedResultReceived

Expand Down Expand Up @@ -59,3 +61,31 @@ This callback method delivers a [`ParsedResult`]({{ site.dcp_flutter_api }}parse
```dart
Future<void> Function(ParsedResult result)? onParsedResultsReceived;
```

**Parameters**

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

### onProcessedDocumentResultReceived

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.

```dart
Future<void> Function(ProcessedDocumentResult result)? onProcessedDocumentResultReceived;
```

**Parameters**

`result`: The document processing results, an instance of [`ProcessedDocumentResult`]({{ site.ddn_flutter_api }}processed-document-result.html).

### onRecognizedTextLinesReceived

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.

```dart
Future<void> Function(RecognizedTextLinesResult result)? onRecognizedTextLinesReceived;
```

**Parameters**

`result`: The text recognition result, an instance of [`RecognizedTextLinesResult`]({{ site.dlr_flutter_api }}recognized-text-lines-result.html).
Original file line number Diff line number Diff line change
Expand Up @@ -10,68 +10,63 @@ noTitleIndex: true

# CapturedResult

The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array of [`CapturedResultItem`](captured-result-item.md), each of which may be a barcode, text line, detected quad, normalized image, original image, or parsed item depending on the functional product that is used.

> [!TIP]
> In the context of the Barcode Reader, you will most likely be using the [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html) as the main result type.

> [!NOTE]
> The type of `CapturedResult` is dependent on the functional product that is used by the Capture Vision Router instance. To learn about the different types of functional products that Capture Vision supports, please visit the [Capture Vision Introduction]({{ site.introduction }}index.html#functional-products).
The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array of [`CapturedResultItem`](../core/captured-result-item.md), each of which may be a barcode, text line, detected quad, normalized image, original image, or parsed item depending on the functional product that is used.

## Definition

*Assembly:* dynamsoft_capture_vision_flutter

```dart
class CapturedResult
class CapturedResult extends CapturedResultBase
```

## Properties

| Property | Type | Description |
| --------- | ----------- |
| [`originalImageHashId`](#originalimagehashid) | *String* | The hash ID of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. |
| [`rotationTransformMatrix`](#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
| [`errorCode`](#errorcode) | *int* | The error code associated with the capture result. |
| [`errorMessage`](#errormessage) | *String* | The error message associated with the capture result. |
| [`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. |
| -------- | ---- | ----------- |
| [`items`](#items) | *List\<CapturedResultItem\>?* | A list of [`CapturedResultItem`](captured-result-item.md) objects. |
| [`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. |
| [`recognizedTextLinesResult`](#recognizedtextlinesresult) | [*RecognizedTextLinesResult*]({{ site.dlr_flutter_api }}recognized-text-lines-result.html) | All results of type `textLine` in the `CapturedResult` as a `RecognizedTextLinesResult` object. |
| [`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. |
| [`parsedResult`](#parsedresult) | [*ParsedResult*]({{ site.dcp_flutter_api }}parsed-result.html) | All results of type `parsedResult` in the `CapturedResult` as a `ParsedResult` object. |

### originalImageHashId

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.
### items

A list of [`CapturedResultItem`]({{ site.dcv_flutter_api }}captured-result-item.html) objects.

```dart
String originalImageHashId,
List<CapturedResultItem>? items;
```

### rotationTransformMatrix
### decodedBarcodesResult

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.
All results of type `barcode` in the `CapturedResult` as a `DecodedBarcodesResult` object.

```dart
Matrix4 rotationTransformMatrix;
DecodedBarcodesResult? decodedBarcodesResult;
```

### errorCode
### recognizedTextLinesResult

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

```dart
int errorCode;
RecognizedTextLinesResult? recognizedTextLinesResult;
```

### errorMessage
#### processedDocumentResult

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

```dart
String errorMessage;
ProcessedDocumentResult? processedDocumentResult;
```

### decodedBarcodesResult
### parsedResult

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.
All results of type `parsedResult` in the `CapturedResult` as a `ParsedResult` object.

```dart
DecodedBarcodesResult? decodedBarcodesResult;
ParsedResult? parsedResult;
```
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Future<ImageData?> getOriginalImage(String hashId) async

**Remarks**

In order to get the hashID input parameter, please access the `originalImageHashId` of the [`CapturedResult`](captured-result.md). The `CapturedResult` can be a [`DecodedBarcodesResult`](decoded-barcodes-result.md) (if the Barcode Reader is used) and so the `originalImageHashId` can be obtained from the `DecodedBarcodesResult` object directly since it extends the `CapturedResult` class.
In order to get the hashID input parameter, please access the `originalImageHashId` of the [`CapturedResult`](captured-result.md). The `CapturedResult` can be a [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html) (if the Barcode Reader is used) and so the `originalImageHashId` can be obtained from the `DecodedBarcodesResult` object directly since it extends the `CapturedResult` class.

The method returns a [`ImageData`](image-data.md) object which contains all the info of the original image, including a byte array to represent the raw image.
The method returns a [`ImageData`]({{ site.dcv_flutter_api }}core/image-data.html) object which contains all the info of the original image, including a byte array to represent the raw image.

## Code Snippet

Expand Down
Loading