Skip to content

Commit 5beafe9

Browse files
update to internal commit f2c69cde
1 parent 5f217cb commit 5beafe9

File tree

11 files changed

+149
-146
lines changed

11 files changed

+149
-146
lines changed

_includes/sidelist-programming/programming-flutter.html

Lines changed: 111 additions & 115 deletions
Large diffs are not rendered by default.

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,6 @@ noTitleIndex: true
1212

1313
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.
1414

15-
> [!NOTE]
16-
>
17-
> - Barcode decoding: [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html)
18-
> - Text line: [`RecognizedTextLinesResult`]({{ site.dlr_flutter_api }}recognized-text-lines-result.html)
19-
> - Document page(s): [`ProcessedDocumentResult`]({{ site.ddn_flutter_api }}processed-document-result.html)
20-
> - Parsed content (DL, MRZ, VIN, GS1 AI, etc.): [`ParsedResult`]({{ site.dcp_flutter_api }}parsed-result.html)
21-
2215
## Definition
2316

2417
*Assembly:* dynamsoft_capture_vision_flutter

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ class SimplifiedCaptureVisionSettings
3030
| [`minImageCaptureInterval`](#minimagecaptureinterval) | *int* | Sets the minimum interval (in milliseconds) between image captures. |
3131
| [`timeout`](#timeout) | *int* | Specifies the maximum time (in milliseconds) allowed for image capture and recognition. |
3232
| [`barcodeSettings`](#barcodesettings) | *[SimplifiedBarcodeReaderSettings]({{ site.dbr_flutter_api }}barcode-reader/simplified-barcode-reader-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
33-
| [`labelSettings`](#labelsettings) | *[SimplifiedLabelRecognizerSettings]({{ site.dbr_flutter_api }}simplified-label-recognizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
34-
| [`documentSettings`](#documentsettings) | *[SimplifiedDocumentNormalizerSettings]({{ site.dbr_flutter_api }}simplified-document-normalizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
33+
| [`labelSettings`](#labelsettings) | *[SimplifiedLabelRecognizerSettings]({{ site.dlr_flutter_api }}simplified-label-recognizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
34+
| [`documentSettings`](#documentsettings) | *[SimplifiedDocumentNormalizerSettings]({{ site.ddn_flutter_api }}simplified-document-normalizer-settings.html)* | The settings for the `DynamsoftBarcodeReader` tasks. |
3535

3636
### roi
3737

@@ -83,15 +83,15 @@ SimplifiedBarcodeReaderSettings? barcodeSettings;
8383

8484
### labelSettings
8585

86-
The settings for the `DynamsoftLabelRecognizer` tasks as a [`SimplifiedLabelRecognizerSettings`]({{ site.dbr_flutter_api }}simplified-label-recognizer-settings.html) object.
86+
The settings for the `DynamsoftLabelRecognizer` tasks as a [`SimplifiedLabelRecognizerSettings`]({{ site.dlr_flutter_api }}simplified-label-recognizer-settings.html) object.
8787

8888
```dart
8989
SimplifiedLabelRecognizerSettings? labelSettings;
9090
```
9191

9292
### documentSettings
9393

94-
The settings for the `DynamsoftDocumentNormalizer` tasks as a [`SimplifiedDocumentNormalizerSettings`]({{ site.dbr_flutter_api }}simplified-document-normalizer-settings.html) object.
94+
The settings for the `DynamsoftDocumentNormalizer` tasks as a [`SimplifiedDocumentNormalizerSettings`]({{ site.ddn_flutter_api }}simplified-document-normalizer-settings.html) object.
9595

9696
```dart
9797
SimplifiedDocumentNormalizerSettings? documentSettings;

programming/flutter/api-reference/core/captured-result-base.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ ignore: true
1313

1414
The `CapturedResultBase` class is the base class of all types of captured results.
1515

16+
> [!NOTE]
17+
> Sub classes:
18+
> - Barcode: [`DecodedBarcodesResult`]({{ site.dbr_flutter_api }}barcode-reader/decoded-barcodes-result.html)
19+
> - Text line: [`RecognizedTextLinesResult`]({{ site.dlr_flutter_api }}recognized-text-lines-result.html)
20+
> - Document page(s): [`ProcessedDocumentResult`]({{ site.ddn_flutter_api }}processed-document-result.html)
21+
> - Parsed content (DL, MRZ, VIN, GS1 AI, etc.): [`ParsedResult`]({{ site.dcp_flutter_api }}parsed-result.html)
22+
1623
## Definition
1724

1825
*Assembly:* dynamsoft_capture_vision_flutter

programming/flutter/api-reference/core/captured-result-item.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ noTitleIndex: true
1313
The `CapturedResultItem` class represents the most basic item in the captured result. Depending on the type of the [`CapturedResult`](captured-result.md), the captured result item can be a barcode, a text line, a normalized image, a detected quad, a parsed item, or an original image.
1414

1515
> [!NOTE]
16-
>
17-
> - Barcode: [BarcodeResultItem]({{ site.dbr_flutter_api }}barcode-reader/barcode-result-item.html)
16+
> Sub classes:
17+
> - Barcode: [`BarcodeResultItem`]({{ site.dbr_flutter_api }}barcode-reader/barcode-result-item.html)
1818
> - Text line: [`TextLineResultItem`]({{ site.dlr_flutter_api }}text-line-result-item.html)
1919
> - Document page(s):
2020
> - [`DeskewedImageResultItem`]({{ site.ddn_flutter_api }}deskewed-image-result-item.html)
@@ -72,4 +72,11 @@ EnumCapturedResultItemType type;
7272

7373
**Remarks**
7474

75-
The type of `CapturedResultItem` 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)
75+
| CapturedResultItemType | Sub Class |
76+
| ---------------------- | --------- |
77+
| `barcode` | [`BarcodeResultItem`]({{ site.dbr_flutter_api }}barcode-reader/barcode-result-item.html) |
78+
| `textLine` | [`TextLineResultItem`]({{ site.dlr_flutter_api }}text-line-result-item.html) |
79+
| `detectedQuad` | [`DetectedQuadResultItem`]({{ site.ddn_flutter_api }}detected-quad-result-item.html) |
80+
| `deskewedImage` | [`DeskewedImageResultItem`]({{ site.ddn_flutter_api }}deskewed-image-result-item.html) |
81+
| `parsedResult` | [`ParsedResultItem`]({{ site.dcp_flutter_api }}parsed-result-item.html) |
82+
| `enhancedImage` | [`EnhancedImageResultItem`]({{ site.ddn_flutter_api }}enhanced-image-result-item.html) |

programming/flutter/api-reference/core/enum/buffer-overflow-protection-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ breadcrumbText: BufferOverflowProtectionMode
1010
codeAutoHeight: true
1111
---
1212

13-
# Enumeration BufferOverflowProtectionMode
13+
# EnumBufferOverflowProtectionMode
1414

1515
`BufferOverflowProtectionMode` describes the protection modes to manage situations when the `ImageSourceAdapter`'s buffer exceeds its capacity.
1616

programming/flutter/api-reference/core/enum/image-colour-mode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ breadcrumbText: ImageColourMode
1010
codeAutoHeight: true
1111
---
1212

13-
# Enumeration ImageColourMode
13+
# EnumImageColourMode
1414

1515
`ImageColourMode` defines the colour mode of the enhanced image.
1616

programming/flutter/api-reference/core/quadrilateral.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ Quadrilateral({required this.points});
3434

3535
### points
3636

37-
A list of four points that make up the quadrilateral. The points list start from the top-left point of the quadrilateral and go clockwise. Each point has a x and y coordinate that must be set - please see the [Point (Flutter)](https://api.flutter.dev/flutter/dart-math/Point-class.html) class for further reference.
37+
A list of four points that make up the quadrilateral. The points list start from the top-left point of the quadrilateral and go clockwise.
3838

3939
```dart
4040
List<Point<int>> points;
4141
```
4242

4343
**Remarks**
4444

45-
The coordinates are typically set in pixels. However, if you are setting a region via the [`SimplifiedCaptureVisionSettings`](simplified-capture-vision-settings.md), you can set the coordinates of the Quadrilateral as percentages (of the frame dimensions) instead of pixels if `roiMeasuredInPercentage` is set to true.
45+
The coordinates are typically set in pixels. However, if you are setting a region via the [`SimplifiedCaptureVisionSettings`](../capture-vision-router/simplified-capture-vision-settings.md), you can set the coordinates of the Quadrilateral as percentages (of the frame dimensions) instead of pixels if `roiMeasuredInPercentage` is set to true.

programming/flutter/api-reference/utility/image-drawer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ Future<ImageData> drawOnImage(ImageData image, List<Quadrilateral> quadrilateral
3737
- `color`: ARGB colour value (0xAARRGGBB format)
3838
- `thickness`: The line thickness in pixels.
3939

40-
The method returns an [`ImageData`](image-data.md) object that represents the new image with the rendered shapes.
40+
The method returns an [`ImageData`](../core/image-data.md) object that represents the new image with the rendered shapes.

programming/flutter/api-reference/utility/image-io.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class ImageIO
2424

2525
### saveToFile
2626

27-
Saves the provided [`ImageData`](image-data.md) object (which represents an image) to a file at the specified file path.
27+
Saves the provided [`ImageData`](../core/image-data.md) object (which represents an image) to a file at the specified file path.
2828

2929
```dart
3030
Future<void> saveToFile(ImageData image, String path, bool overwrite) async
@@ -36,7 +36,7 @@ The `overwrite` input parameter should be set to true if the file already exists
3636

3737
### readFromFile
3838

39-
Reads an image from a file at the specified file path and returns an [`ImageData`](image-data.md) object that represents the image.
39+
Reads an image from a file at the specified file path and returns an [`ImageData`](../core/image-data.md) object that represents the image.
4040

4141
```dart
4242
Future<ImageData?> readFromFile(String path) async

0 commit comments

Comments
 (0)