You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The `BarcodeResultItem` class represents a single barcode result decoded by the barcode reader. It is part of the [`DecodedBarcodesResult`](../api-reference/barcode-reader/decoded-barcodes-result.md), which is what the library outputs at the end of the barcode recognition process.
14
-
15
-
> [!NOTE]
16
-
> BarcodeResultItem implements the [`CapturedResultItem`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result-item.html) class.
13
+
The `BarcodeResultItem` class represents a single barcode result decoded by the barcode reader. It is part of the [`DecodedBarcodesResult`](decoded-barcodes-result.md), which is what the library outputs at the end of the barcode recognition process.
17
14
18
15
## Definition
19
16
@@ -37,15 +34,15 @@ class BarcodeResultItem extends CapturedResultItem
37
34
|[`moduleSize`](#modulesize)|*int*| The size of the smallest module (dot or line) of the barcode. |
38
35
|[`isDPM`](#isdpm)|*bool*| Indicates whether the barcode is a Direct Part Marking (DPM). |
39
36
|[`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. |
37
+
|[`pdf417Details`](#pdf417details)|*[PDF417Details](pdf417-details.md)*| Represents extended info that is specific to PDF417 codes, if the decoded barcode is a PDF417 code. |
38
+
|[`oneDCodeDetails`](#onedcodedetails)|*[OneDCodeDetails](oned-details.md)*| Represents extended info that is specific to 1D codes, if the decoded barcode is a 1D code. |
39
+
|[`dataMatrixDetails`](#datamatrixdetails)|*[DataMatrixDetails](datamatrix-details.md)*| Represents extended info that is specific to DataMatrix codes, if the decoded barcode is a DataMatrix code. |
40
+
|[`aztecDetails`](#aztecdetails)|*[AztecDetails](aztec-details.md)*| Represents extended info that is specific to Aztec codes, if the decoded barcode is an Aztec code. |
41
+
|[`qrCodeDetails`](#qrcodedetails)|*[QRCodeDetails](qr-code-details.md)*| Represents extended info that is specific to QR Codes, if the decoded barcode is a QR Code. |
45
42
46
43
### format
47
44
48
-
The format of the barcode. One of the [`EnumBarcodeFormat`](../enum/barcode-format.md).
45
+
The format of the barcode. One of the [`EnumBarcodeFormat`]({{ site.dcv_flutter_api }}core/enum/barcode-format.html).
Copy file name to clipboardExpand all lines: programming/flutter/api-reference/barcode-reader/decoded-barcodes-result.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,10 +30,10 @@ The following properties are inherited from [`CapturedResultBase`]({{ site.dcv_f
30
30
31
31
| Properties | Types | Description |
32
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. |
33
+
|[`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) |*String*| The hash id of the original image. |
34
+
|[`rotationTransformMatrix`]({{ site.dcv_flutter_api }}core/captured-result-base.html#rotationtransformmatrix) |*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#errorcode) |*int*| The error code of this result. |
36
+
|[`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) |*String*| The error message of this result. |
Copy file name to clipboardExpand all lines: programming/flutter/api-reference/barcode-reader/qr-code-details.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ class QRCodeDetails
29
29
| -------- | ---- | ----------- |
30
30
|[`rows`](#rows)|*int*| Represents the number of rows that make up the QR Code. |
31
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). |
32
+
|[`errorCorrectionLevel`](#errorcorrectionlevel)|*EnumQRCodeErrorCorrectionLevel*| Represents the error correction level of the QR Code as a [`EnumQRCodeErrorCorrectionLevel`](enum/qr-code-correction.md). |
33
33
|[`version`](#version)|*int*| Represents the version of the QR Code. |
34
34
|[`model`](#model)|*int*| Represents the number of models of the QR Code. |
35
35
|[`mode`](#mode)|*int*| Identifies the first data encoding mode of the QR Code. |
@@ -57,7 +57,7 @@ int columns;
57
57
58
58
### errorCorrectionLevel
59
59
60
-
Represents the error correction level of the QR Code as a [`EnumQRCodeErrorCorrectionLevel`](../enum/qr-code-correction.md).
60
+
Represents the error correction level of the QR Code as a [`EnumQRCodeErrorCorrectionLevel`](enum/qr-code-correction.md).
Copy file name to clipboardExpand all lines: programming/flutter/api-reference/barcode-reader/simplified-barcode-reader-settings.md
+31-41Lines changed: 31 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,21 +27,21 @@ class SimplifiedBarcodeReaderSettings
27
27
28
28
| Property | Type | Description |
29
29
|----------|------|-------------|
30
-
|[`barcodeFormatIds`](#barcodeformatids)|[*EnumBarcodeFormat*](../enum/barcode-format.md)| Specifies which barcode format(s) the Barcode Reader will target. |
30
+
|[`barcodeFormatIds`](#barcodeformatids)|[*EnumBarcodeFormat*]({{ site.dcv_flutter_api }}core/enum/barcode-format.html) | Specifies which barcode format(s) the Barcode Reader will target. |
31
31
|[`expectedBarcodesCount`](#expectedbarcodescount)|*int*| Determines the expected barcode count, which can be set to 0 if the barcode count is unknown. |
32
-
|[`localizationModes`](#localizationmodes)|*List\<EnumLocalizationMode\>*| Defines which localization modes (as [`EnumLocalizationMode`](../enum/localization-mode.md)) the barcode reader will use during the detection process. |
33
-
|[`deblurModes`](#deblurmodes)|*List<EnumDeblurMode>*| Sets which deblur algorithms (as [`EnumDeblurMode`](../enum/deblur-mode.md)) the library will apply during the detection process when dealing with blurry images/frames. |
32
+
|[`localizationModes`](#localizationmodes)|*List\<EnumLocalizationMode\>*| Defines which localization modes (as [`EnumLocalizationMode`]({{ site.dcv_flutter_api }}core/enum/localization-mode.html)) the barcode reader will use during the detection process. |
33
+
|[`deblurModes`](#deblurmodes)|*List<EnumDeblurMode>*| Sets which deblur algorithms (as [`EnumDeblurMode`]({{ site.dcv_flutter_api }}core/enum/deblur-mode.html)) the library will apply during the detection process when dealing with blurry images/frames. |
34
34
|[`minResultConfidence`](#minresultconfidence)|*int*| Specifies the minimum barcode result confidence to help filter out inaccurate results. |
35
35
|[`minBarcodeTextLength`](#minbarcodetextlength)|*int*| Sets the minimum barcode text length (in characters) for the barcode result to be considered valid. |
36
36
|[`barcodeTextRegExPattern`](#barcodetextregexpattern)|*String*| Defines a regular expression pattern that the barcode text must match to be considered valid. |
37
37
|[`maxThreadsInOneTask`](#maxthreadsinonetask)|*int*| Establishes the maximum number of threads available for a single detection task. |
38
-
|[`grayscaleTransformationModes`](#grayscaletransformationmodes)|*List\<EnumGrayscaleTransformationMode\>*| Determines which grayscale transformation modes (as [`EnumGrayscaleTransformationMode`](../enum/grayscale-transformation-mode.md)) the barcode reader will apply before the detection process. |
39
-
|[`grayscaleEnhancementModes`](#grayscaleenhancementmodes)|*List\<EnumGrayscaleEnhancementMode\>*| Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](../enum/grayscale-enhancement-mode.md)) the library will apply before the detection process. |
38
+
|[`grayscaleTransformationModes`](#grayscaletransformationmodes)|*List\<EnumGrayscaleTransformationMode\>*| Determines which grayscale transformation modes (as [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-transformation-mode.html)) the barcode reader will apply before the detection process. |
39
+
|[`grayscaleEnhancementModes`](#grayscaleenhancementmodes)|*List\<EnumGrayscaleEnhancementMode\>*| Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`]({{ site.dcv_flutter_api }}core/enum/grayscale-enhancement-mode.html)) the library will apply before the detection process. |
40
40
|[`scaleDownThreshold`](#scaledownthreshold)|*int*| Defines the threshold for scaling down the image/frame before processing to help with memory overhead. |
41
41
42
42
### barcodeFormatIds
43
43
44
-
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).
44
+
Specifies which barcode format(s) (as [`EnumBarcodeFormat`]({{ site.dcv_flutter_api }}core/enum/barcode-format.html)) 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).
45
45
46
46
```dart
47
47
BigInt barcodeFormatIds;
@@ -57,101 +57,91 @@ int expectedBarcodesCount;
57
57
58
58
**Remarks**
59
59
60
-
- 0: detects at least one barcode.
61
-
- N ( N > 0 ): detects N barcodes.
62
-
- Dynamsoft Barcode Reader works in a loop trying different parameters to reach the number of expected barcodes specified by this parameter. If ExpectedBarcodesCount is 0, the loop stops after at least one barcode is found in an iteration. If ExpectedBarcodesCount is N, the loop stops once N barcodes are detected.
60
+
- Set `expectedBarcodesCount` to 0 if the barcode count is unknown. The library will try to find at least 1 barcode.
61
+
- Set `expectedBarcodesCount` to 1 to reach the highest speed for processing single barcode.
62
+
- Set `expectedBarcodesCount` to "n" if there will be "n" barcodes to process from an image.
63
+
- Set `expectedBarcodesCount` to the highest expected value if there exists multiple barcodes but the exact count is not confirmed.
63
64
64
65
### localizationModes
65
66
66
-
Defines which localization modes (as a list of [`EnumLocalizationMode`](../enum/localization-mode.md)) the barcode reader will use during the detection process. Each [`EnumLocalizationMode`](../enum/localization-mode.md)) represents a different localization method, some of which are more optimized for certain barcode formats over others.
67
+
Determines how to localize the barcodes.
68
+
69
+
- View more information about [LocalizationMode Parameters]({{ site.dcvb_parameters }}reference/barcode-reader-task-settings/localization-modes.html).
70
+
- View the available [`EnumLocalizationMode`]({{ site.dcv_flutter_api }}core/enum/localization-mode.html) members.
67
71
68
72
```dart
69
73
List<EnumLocalizationMode> localizationModes;
70
74
```
71
75
72
-
**Remarks**
73
-
74
-
Certain localization modes are specially optimized for certain barcode formats. For example, `lines` is designed primarily for 1D and PDF417 barcodes, while `statisticsMarks` is optimized for DPM codes. If you want to further improve the read rate of certain barcode types, please go through the [`EnumLocalizationMode`](../enum/localization-mode.md) page to learn which modes to apply based on the targeted barcode format(s).
75
-
76
76
### deblurModes
77
77
78
-
Sets which deblur algorithms (as [`EnumDeblurMode`](../enum/deblur-mode.md)) the library will apply during the detection process when dealing with blurry images/frames.
78
+
Determines which deblur algorithms to apply when decoding the barcodes.
79
+
80
+
- View more information about [DeblurMode Parameters]({{ site.dcvb_parameters }}reference/barcode-reader-task-settings/deblur-modes.html).
81
+
- View the available [`EnumDeblurMode`]({{ site.dcv_flutter_api }}core/enum/deblur-mode.html) members.
79
82
80
83
```dart
81
84
List<EnumDeblurMode> deblurModes;
82
85
```
83
86
84
-
**Remarks**
85
-
86
-
If you would like to learn about the different modes in depth, please visit this [page]({{ site.dcvb_parameters }}reference/barcode-reader-task-settings/deblur-modes.html#candidate-modes-introduction).
87
-
88
87
### minResultConfidence
89
88
90
-
Specifies the minimum barcode result confidence to help filter out inaccurate results. Confidence is a measure of a barcode result's accuracy, so by setting this parameter to a higher value, you ensure that the library will relay only the more accurate results.
89
+
Specifies the minimum barcode result confidence to help filter out low-confidence results.
91
90
92
91
```dart
93
92
int minResultConfidence;
94
93
```
95
94
96
95
**Remarks**
97
96
98
-
The default `minresultConfidence` value is 30, which is a sufficient level of accuracy for most scenarios.
97
+
The default `minResultConfidence` value is 30.
99
98
100
99
### minBarcodeTextLength
101
100
102
-
Sets the minimum barcode text length (in characters) for the barcode result to be considered valid. Any results that do not meet this text length will be discarded by the library.
101
+
Sets the minimum barcode text length to filter out non-target barcodes.
103
102
104
103
```dart
105
104
int minBarcodeTextLength;
106
105
```
107
106
108
107
### barcodeTextRegExPattern
109
108
110
-
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.
109
+
Defines a regular expression pattern to filter out non-target barcodes.
111
110
112
111
```dart
113
112
String? barcodeTextRegExPattern;
114
113
```
115
114
116
115
### maxThreadsInOneTask
117
116
118
-
Establishes the maximum number of threads available for a single detection task.
117
+
Set the maximum available threads count in one barcode decoding task.
119
118
120
119
```dart
121
120
int maxThreadsInOneTask;
122
121
```
123
122
124
123
### grayscaleTransformationModes
125
124
126
-
Determines which grayscale transformation modes (as [`EnumGrayscaleTransformationMode`](../enum/grayscale-transformation-mode.md)) the barcode reader will apply before the detection process. **This parameter controls the library's ability to read inverted barcodes.**
125
+
Determines whether to decode inverted barcodes.
126
+
127
+
- View more information about [GrayscaleTransformationMode Parameter]({{ site.dcvb_parameters }}reference/image-parameter/grayscale-transformation-modes.html).
128
+
- View the available [`EnumGrayscaleTransformationMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-transformation-mode.html) members.
The order in which the transformations modes is set will determine the priority that the library will follow when searching for barcodes. Please see the table below for more info.
135
-
136
-
-[ .original ]: Process original coloured barcodes only.
137
-
-[ .inverted ]: Process inverted coloured barcodes only.
138
-
-[ .original, .inverted ]: Process both original and inverted coloured barcodes. The library will search for the original coloured barcodes first.
139
-
-[ .inverted, .original ]: Process both original and inverted coloured barcodes. The library will search for the inverted coloured barcodes first.
140
-
141
134
### grayscaleEnhancementModes
142
135
143
-
Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](../enum/grayscale-enhancement-mode.md)) the library will apply before the detection process.
136
+
Determines how to enhance the quality of the grayscale image.
137
+
138
+
- View more information about [GrayscaleEnhancementMode Parameter]({{ site.dcvb_parameters }}reference/image-parameter/grayscale-enhancement-modes.html).
139
+
- View the available [`EnumGrayscaleEnhancementMode`]({{ site.dcv_flutter_api }}core/enum/grayscale-enhancement-mode.html) members.
The grayscaleEnhancementModes are image processing methods that help enhance the quality of the grayscale image, which is an essential part of the detection process. By default, the library doesn't do any image preprocessing. Therefore, if your image has some distortion or is of lower quality, using the right image preprocessing methods can help produce a higher quality grayscale image and improve the readability of the image or frame.
152
-
153
-
To learn more about the different grayscale enhancement modes and what each of them does, please visit this [page]({{ site.dcvb_parameters }}reference/image-parameter/grayscale-enhancement-modes.html#candidate-modes-introduction).
154
-
155
145
### scaleDownThreshold
156
146
157
147
Defines the threshold for scaling down the image/frame before processing to help with memory overhead. If both the width and height are larger than the threshold, the image is shrunk by half.
0 commit comments