Skip to content

Commit 54d832a

Browse files
update to internal commit 086d6c1c
1 parent 5b2fcc9 commit 54d832a

18 files changed

+140
-438
lines changed

_includes/sidelist-programming/programming-flutter.html

Lines changed: 73 additions & 66 deletions
Large diffs are not rendered by default.

programming/flutter/api-reference/barcode-reader/aztec-details.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ class AztecDetails
2525

2626
## Properties
2727

28+
| Property | Type | Description |
29+
| -------- | ---- | ----------- |
30+
| [`rows`](#rows) | *int* | Represents the number of rows that make up the Aztec Code. |
31+
| [`columns`](#columns) | *int* | Represents the number of columns that make up the Aztec Code. |
32+
| [`layerNumber`](#layernumber) | *int* | Represents the layer number of an Aztec code.|
33+
2834
### rows
2935

3036
Represents the number of rows that make up the Aztec Code.

programming/flutter/api-reference/barcode-reader/barcode-result-item.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,35 @@ The `BarcodeResultItem` class represents a single barcode result decoded by the
2020
*Assembly:* dynamsoft_capture_vision_flutter
2121

2222
```dart
23-
class BarcodeResultItem
23+
class BarcodeResultItem extends CapturedResultItem
2424
```
2525

2626
## Properties
2727

2828
| Property | Type | Description |
2929
| -------- | ---- | ----------- |
30-
| [`format`](#format) | *[EnumBarcodeFormat](../enum/barcode-format.md)* | The format of the barcode represented as [`EnumBarcodeFormat`](../enum/barcode-format.md). |
30+
| [`format`](#format) | *BigInt* | The format of the barcode. |
3131
| [`formatString`](#formatstring) | *String* | The format of the barcode as a text string. |
3232
| [`text`](#text) | *String* | The decoded text of the barcode. |
3333
| [`bytes`](#bytes) | *Uint8List* | The raw bytes of the barcode. |
3434
| [`location`](#location) | *Quadrilateral* | The location of the barcode in the image/frame. |
3535
| [`confidence`](#confidence) | *int* | The confidence of the barcode result. |
3636
| [`angle`](#angle) | *int* | The angle at which the barcode is detected if it's not aligned in the image/frame. |
3737
| [`moduleSize`](#modulesize) | *int* | The size of the smallest module (dot or line) of the barcode. |
38-
| [`isDPM`](#isdpm) | *bool* | Indicates whether the barcode is a Dot Peen Marking (DPM). |
38+
| [`isDPM`](#isdpm) | *bool* | Indicates whether the barcode is a Direct Part Marking (DPM). |
3939
| [`isMirrored`](#ismirrored) | *bool* | Indicates whether the barcode image is mirrored. |
40+
| [`pdf417Details`](#pdf417details) | *PDF417Details* | Represents extended info (as [`PDF417Details`](pdf417-details.md)) that is specific to PDF417 codes, if the decoded barcode is a PDF417 code. |
41+
| [`oneDCodeDetails`](#onedcodedetails) | *OneDCodeDetails* | Represents extended info (as [`OneDCodeDetails`](oned-details.md)) that is specific to 1D codes, if the decoded barcode is a 1D code. |
42+
| [`dataMatrixDetails`](#datamatrixdetails) | *DataMatrixDetails* | Represents extended info (as [`DataMatrixDetails`](datamatrix-details.md)) that is specific to DataMatrix codes, if the decoded barcode is a DataMatrix code. |
43+
| [`aztecDetails`](#aztecdetails) | *AztecDetails* | Represents extended info (as [`AztecDetails`](aztec-details.md)) that is specific to Aztec codes, if the decoded barcode is an Aztec code. |
44+
| [`qrCodeDetails`](#qrcodedetails) | *QRCodeDetails* | Represents extended info (as [`QRCodeDetails`](qr-code-details.md)) that is specific to QR Codes, if the decoded barcode is a QR Code. |
4045

4146
### format
4247

43-
The format of the barcode represented as a [`EnumBarcodeFormat`](../enum/barcode-format.md).
48+
The format of the barcode. One of the [`EnumBarcodeFormat`](../enum/barcode-format.md).
4449

4550
```dart
46-
EnumBarcodeFormat format;
51+
BigInt format;
4752
```
4853

4954
### formatString

programming/flutter/api-reference/barcode-reader/datamatrix-details.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ class DataMatrixDetails
2525

2626
## Properties
2727

28+
| Property | Type | Description |
29+
| -------- | ---- | ----------- |
30+
| [`rows`](#rows) | *int* | Represents the number of rows that make up the DataMatrix Code. |
31+
| [`columns`](#columns) | *int* | Represents the number of columns that make up the DataMatrix Code. |
32+
| [`dataRegionRows`](#layernumber) | *int* | Represents the number of rows in the data region of the DataMatrix code. |
33+
| [`dataRegionColumns`](#dataregioncolumns) | *int* | Represents the number of columns in the data region of the DataMatrix code. |
34+
| [`dataRegionNumber`](#dataregionnumber) | *int* | Represents the number of data regions in the DataMatrix code. |
35+
2836
### rows
2937

3038
Represents the number of rows that make up the DataMatrix Code.

programming/flutter/api-reference/barcode-reader/decoded-barcodes-result.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The `DecodedBarcodesResult` class represents the result of a barcode reading pro
1717
*Assembly:* dynamsoft_capture_vision_flutter
1818

1919
```dart
20-
class DecodedBarcodesResult
20+
class DecodedBarcodesResult extends CapturedResultBase
2121
```
2222

2323
## Properties
@@ -26,14 +26,14 @@ class DecodedBarcodesResult
2626
| -------- | ---- | ----------- |
2727
| [`items`](#items) | *List\<BarcodeResultItem\>?* | A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. |
2828

29-
The following properties are inherited from [`CapturedResult`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html):
29+
The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_flutter_api }}core/captured-result-base.html):
3030

31-
| Property | Type | Description |
32-
| -------- | ---- | ----------- |
33-
| [`originalImageHashId`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#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`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#rotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
35-
| [`errorCode`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errorcode) | *int* | The error code associated with the capture result. |
36-
| [`errorMessage`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errormessage) | *String* | The error message associated with the capture result. |
31+
| Properties | Types | Description |
32+
| ---------- | ----- | ----------- |
33+
| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#getoriginalimagehashid) | *String* | The hash id of the original image. |
34+
| [`rotationTransformMatrix`]({{ site.dcv_flutter_api }}core/captured-result-base.html#getrotationtransformmatrix) | *Matrix4* | The rotation transformation matrix of the original image relative to the rotated image. |
35+
| [`errorCode`]({{ site.dcv_flutter_api }}core/captured-result-base.html#geterrorcode) | *int* | The error code of this result. |
36+
| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#geterrormessage) | *String* | The error message of this result. |
3737

3838
### items
3939

File renamed without changes.

programming/flutter/api-reference/barcode-reader/oned-details.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@ class OneDCodeDetails
2525

2626
## Properties
2727

28+
| Property | Type | Description |
29+
| -------- | ---- | ----------- |
30+
| [`startCharsBytes`](#startcharsbytes) | *Uint8List?* | A byte list representing the characters of the start pattern of a 1D barcode. |
31+
| [`stopCharsBytes`](#stopcharsbytes) | *Uint8List?* | A byte list representing the characters of the stop pattern of a 1D barcode. |
32+
| [`checkDigitBytes`](#checkdigitbytes) | *Uint8List?* | A byte list representing the check digit of the barcode, if applicable. |
33+
| [`startPatternRange`](#startpatternrange) | *RangeValues* | Represents the position of the start pattern relative to the barcode location. |
34+
| [`middlePatternRange`](#middlepatternrange) | *RangeValues* | Represents the position of the middle pattern relative to the barcode location. |
35+
| [`endPatternRange`](#endpatternrange) | *RangeValues* | Represents the position of the end pattern relative to the barcode location. |
36+
2837
### startCharsBytes
2938

3039
A byte list representing the characters of the start pattern of a 1D barcode.
@@ -78,7 +87,7 @@ The start of this range represents the x-coordinate of the start position as a p
7887
Represents the position of the middle pattern relative to the barcode location. The middle, or center guard, pattern separates the two halves of the encoded data, and helps the Barcode Reader determine the reading direction while providing a fixed reference point for the reader.
7988

8089
```dart
81-
RangeValues startPatternRange;
90+
RangeValues middlePatternRange;
8291
```
8392

8493
**Remarks**

programming/flutter/api-reference/barcode-reader/pdf417-details.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@ class PDF417Details
2525

2626
## Properties
2727

28+
| Property | Type | Description |
29+
| -------- | ---- | ----------- |
30+
| [`rows`](#rows) | *int* | Represents the number of rows that make up the PDF417 Code. |
31+
| [`columns`](#columns) | *int* | Represents the number of columns that make up the PDF417 Code. |
32+
| [`errorCorrectionLevel`](#errorcorrectionlevel) | *int* | Specifies the error correction level of the PDF417 Code. |
33+
| [`hasLeftRowIndicator`](#hasleftrowindicator) | *bool* | Indicates whether the PDF417 code has the left row indicator or not. |
34+
| [`hasRightRowIndicator`](#hasrightrowindicator) | *bool* | Indicates whether the PDF417 code has the right row indicator or not. |
35+
| [`codewords`](#codewords) | *int* | The code words of the PDF417 Code. |
36+
2837
### rows
2938

3039
Represents the number of rows that make up the PDF417 Code.

programming/flutter/api-reference/barcode-reader/qr-code-details.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ class QRCodeDetails
2525

2626
## Properties
2727

28+
| Property | Type | Description |
29+
| -------- | ---- | ----------- |
30+
| [`rows`](#rows) | *int* | Represents the number of rows that make up the QR Code. |
31+
| [`columns`](#columns) | *int* | Represents the number of columns that make up the QR Code. |
32+
| [`errorCorrectionLevel`](#errorcorrectionlevel) | *EnumQRCodeErrorCorrectionLevel* | Represents the error correction level of the QR Code as a [`EnumQRCodeErrorCorrectionLevel`](../enum/qr-code-correction.md). |
33+
| [`version`](#version) | *int* | Represents the version of the QR Code. |
34+
| [`model`](#model) | *int* | Represents the number of models of the QR Code. |
35+
| [`mode`](#mode) | *int* | Identifies the first data encoding mode of the QR Code. |
36+
| [`page`](#page) | *int* | Identifies the position of the particular symbol (as in this specific QR Code) in the Structured Append format of the overall QR Code. |
37+
| [`totalPage`](#totalpage) | *int* | The total number of symbols to be concatenated into the Structured Append format of the QR Code. |
38+
| [`parityData`](#paritydata) | *int* | The Parity Data of the QR Code. |
39+
| [`dataMaskPattern`](#datamaskpattern) | *int* | Represents the data mask pattern reference for the QR Code symbols. |
40+
| [`codewords`](#codewords) | *byte[]?* | The codewords of the QR Code. |
41+
2842
### rows
2943

3044
Represents the number of rows that make up the QR Code.

programming/flutter/api-reference/barcode-reader/simplified-barcode-reader-settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class SimplifiedBarcodeReaderSettings
4444
Specifies which barcode format(s) (as [`EnumBarcodeFormat`](../enum/barcode-format.md)) the Barcode Reader will target. To learn more on how to set the barcode formats, please refer to the [Foundational Guide](../../foundational-user-guide.md#specify-barcode-formats-and-count).
4545

4646
```dart
47-
EnumBarcodeFormat barcodeFormatIds;
47+
BigInt barcodeFormatIds;
4848
```
4949

5050
### expectedBarcodesCount
@@ -110,7 +110,7 @@ int minBarcodeTextLength;
110110
Defines a regular expression pattern that the barcode text must match to be considered valid. Any barcode results that do not follow this RegEx pattern will be discarded by the library.
111111

112112
```dart
113-
String barcodeTextRegExPattern;
113+
String? barcodeTextRegExPattern;
114114
```
115115

116116
### maxThreadsInOneTask

0 commit comments

Comments
 (0)