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/capture-vision-router/decoded-barcodes-result.md), which is what the library outputs at the end of the barcode recognition process.
13
+
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.
14
17
15
18
## Definition
16
19
@@ -24,7 +27,7 @@ class BarcodeResultItem
24
27
25
28
| Property | Type | Description |
26
29
| -------- | ---- | ----------- |
27
-
|[`format`](#format)|*[EnumBarcodeFormat](./enum/barcode-format.md)*| The format of the barcode represented as [`EnumBarcodeFormat`](./enum/barcode-format.md). |
30
+
|[`format`](#format)|*[EnumBarcodeFormat](../enum/barcode-format.md)*| The format of the barcode represented as [`EnumBarcodeFormat`](../enum/barcode-format.md). |
28
31
|[`formatString`](#formatstring)|*String*| The format of the barcode as a text string. |
29
32
|[`text`](#text)|*String*| The decoded text of the barcode. |
30
33
|[`bytes`](#bytes)|*Uint8List*| The raw bytes of the barcode. |
@@ -37,7 +40,7 @@ class BarcodeResultItem
37
40
38
41
### format
39
42
40
-
The format of the barcode represented as a [`EnumBarcodeFormat`](./enum/barcode-format.md).
43
+
The format of the barcode represented as a [`EnumBarcodeFormat`](../enum/barcode-format.md).
41
44
42
45
```dart
43
46
EnumBarcodeFormat format;
@@ -69,7 +72,7 @@ Uint8List bytes;
69
72
70
73
### location
71
74
72
-
The location of the barcode in the image/frame as a `Quadrilateral`. The quadrilateral contains the four vertex points of the location, with the first vertex being the left-most vertex, then going in a clockwise direction for the remaining points.
75
+
The location of the barcode in the image/frame as a [`Quadrilateral`]({{ site.dcv_flutter_api }}core/quadrilateral.html). The quadrilateral contains the four vertex points of the location, with the first vertex being the left-most vertex, then going in a clockwise direction for the remaining points.
73
76
74
77
```dart
75
78
Quadrilateral location;
@@ -101,7 +104,7 @@ int moduleSize;
101
104
102
105
### isDPM
103
106
104
-
Indicates whether the barcode is a Dot Peen Marking (DPM), which is a unique type of Datamatrix code.
107
+
Indicates whether the barcode is a Dot Peen Marking (DPM), which is a unique type of DataMatrix code.
Copy file name to clipboardExpand all lines: programming/flutter/api-reference/barcode-reader/decoded-barcodes-result.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,14 +26,14 @@ class DecodedBarcodesResult
26
26
| -------- | ---- | ----------- |
27
27
|[`items`](#items)|*List\<BarcodeResultItem\>?*| A list of [`BarcodeResultItem`](barcode-result-item.md), the basic unit representing a single barcode result. |
28
28
29
-
The following properties are inherited from [`CapturedResult`](./capture-vision-router/captured-result.md):
29
+
The following properties are inherited from [`CapturedResult`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html):
30
30
31
31
| Property | Type | Description |
32
32
| -------- | ---- | ----------- |
33
-
|[`originalImageHashId`](../capture-vision-router/captured-result.md#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`](../capture-vision-router/captured-result.md#rotationtransformmatrix)|*Matrix4*| The rotation transformation matrix of the original image relative to the rotated image. |
35
-
|[`errorCode`](../capture-vision-router/captured-result.md#errorcode)|*int*| The error code associated with the capture result. |
36
-
|[`errorMessage`](../capture-vision-router/captured-result.md#errormessage)|*String*| The error message associated with the capture result. |
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. |
The `SimplifiedBarcodeReaderSettings` class comes from the [`SimplifiedCaptureVisionSettings`](./capture-vision-router/simplified-capture-vision-settings.md) class and contains a limited subset of the parameters that influence the Barcode Reader's performance. If you would like to get familiar with the full parameters available to the Barcode Reader, please visit the [main parameters page]({{ site.dcvb_parameters }}file/index.html?product=dbr&lang=objectivec-swift).
13
+
The `SimplifiedBarcodeReaderSettings` class comes from the [`SimplifiedCaptureVisionSettings`]({{ site.dcv_flutter_api }}capture-vision-router/simplified-capture-vision-settings.html) class and contains a limited subset of the parameters that influence the Barcode Reader's performance. If you would like to get familiar with the full parameters available to the Barcode Reader, please visit the [main parameters page]({{ site.dcvb_parameters }}file/index.html).
14
14
15
15
> [!TIP]
16
-
> If you visit the main parameters page, the majority of the settings related to the Barcode Reader will be in `BarcodeReaderTaskSetting`, `ImageParameter`, and `BarcodeFormatSpecification`.
16
+
> If you visit the main parameters page, the majority of the settings related to the Barcode Reader will be in `BarcodeReaderTaskSetting`, `ImageParameter`, and `BarcodeFormatSpecification`. In order to use any of the settings that are not available in `SimplifiedBarcodeReaderSettings`, you will need to use a Capture Vision JSON template. Please see this [section](../../foundational-user-guide.md#using-a-json-template) of the user guide on how to use JSON templates.
17
17
18
18
## Definition
19
19
@@ -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*](../enum/barcode-format.md)| 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`](../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. |
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`](../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. |
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`](../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).
45
45
46
46
```dart
47
47
EnumBarcodeFormat barcodeFormatIds;
@@ -63,24 +63,28 @@ int expectedBarcodesCount;
63
63
64
64
### localizationModes
65
65
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.
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
67
68
68
```dart
69
69
List<EnumLocalizationMode> localizationModes;
70
70
```
71
71
72
72
**Remarks**
73
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 [EnumLocalizationMode](enum/localization-mode.md) page to learn which modes to apply based on the targeted barcode format(s).
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
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
+
Sets which deblur algorithms (as [`EnumDeblurMode`](../enum/deblur-mode.md)) the library will apply during the detection process when dealing with blurry images/frames.
79
79
80
80
```dart
81
81
List<EnumDeblurMode> deblurModes;
82
82
```
83
83
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
+
84
88
### minResultConfidence
85
89
86
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.
@@ -119,34 +123,38 @@ int maxThreadsInOneTask;
119
123
120
124
### grayscaleTransformationModes
121
125
122
-
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.*
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.**
-[ GTM_ORIGINAL ]: Process original coloured barcodes only.
131
-
-[ GTM_INVERTED ]: Process inverted coloured barcodes only.
132
-
-[ GTM_ORIGINAL, GTM_INVERTED ]: Process both original and inverted coloured barcodes. The library will search for the original coloured barcodes first.
133
-
-[ GTM_INVERTED, GTM_ORIGINAL ]: Process both original and inverted coloured barcodes. The library will search for the inverted coloured barcodes first.
134
+
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.
134
140
135
141
### grayscaleEnhancementModes
136
142
137
-
Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](./enum/grayscale-enhancement-mode.md)) the library will apply before the detection process.
143
+
Sets which grayscale enhancement modes (as [`EnumGrayscaleEnhancementModes`](../enum/grayscale-enhancement-mode.md)) the library will apply before the detection process.
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.
145
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).
146
154
147
155
### scaleDownThreshold
148
156
149
-
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 shrinked by half.
157
+
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