Skip to content

Commit 56e6c99

Browse files
Dynamsoft-HenryDynamsoft-Henry
authored
Merge pull request #374 from dynamsoft-docs/preview
Preview
2 parents 0673894 + fb21c7a commit 56e6c99

File tree

21 files changed

+222
-537
lines changed

21 files changed

+222
-537
lines changed

‎_includes/sidelist-programming/programming-flutter.html‎

Lines changed: 88 additions & 83 deletions
Large diffs are not rendered by default.

‎programming/android/api-reference/enum/barcode-format.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public @interface EnumBarcodeFormat {
103103
public static final long BF_PHARMACODE_TWO_TRACK = 1L << 35;
104104
/**Matrix25.*/
105105
public static final long BF_MATRIX_25 = 1L << 36;
106-
/**Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC, BF_KIX.*/
106+
/**Combined value of BF_USPSINTELLIGENTMAIL, BF_POSTNET, BF_PLANET, BF_AUSTRALIANPOST, BF_RM4SCC, BF_KIX.*/
107107
public static final long BF_POSTALCODE = 0x3F0000000000000;
108108
/**USPS Intelligent Mail barcode.*/
109109
public static final long BF_USPSINTELLIGENTMAIL = 1L << 52;

‎programming/android/samples/index.md‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,23 @@ noTitleIndex: false
99

1010
# Android Barcode Scanner Demo & Samples
1111

12-
- [Android Barcode Scanner Demo \& Samples](#android-barcode-scanner-demo--samples)
13-
- [Demos](#demos)
14-
- [Android Barcode Scanner Demo](#android-barcode-scanner-demo)
15-
- [Android BarcodeScanner Samples](#android-barcodescanner-samples)
16-
- [ScanSingleBarcode](#scansinglebarcode)
17-
- [ScanMultipleBarcodes](#scanmultiplebarcodes)
18-
- [ScenarioOrientedSamples](#scenarioorientedsamples)
19-
- [Android Foundational API Samples](#android-foundational-api-samples)
20-
- [Read Single Barcode (With CameraEnhancer)](#read-single-barcode-with-cameraenhancer)
21-
- [Read Single Barcode (With CameraX)](#read-single-barcode-with-camerax)
22-
- [Decode Barcodes from an Image](#decode-barcodes-from-an-image)
23-
- [General Barcode Decoding Settings](#general-barcode-decoding-settings)
24-
- [Decode Tiny Barcodes](#decode-tiny-barcodes)
25-
- [Locate an Item with Barcode](#locate-an-item-with-barcode)
26-
- [Android ID Scanning Samples](#android-id-scanning-samples)
27-
- [Scan a Driver's License (via PDF417 Barcode)](#scan-a-drivers-license-via-pdf417-barcode)
28-
- [Other Use Case Samples for Android Platform](#other-use-case-samples-for-android-platform)
29-
- [Scan VIN Barcode](#scan-vin-barcode)
12+
- [Demos](#demos)
13+
- [Android Barcode Scanner Demo](#android-barcode-scanner-demo)
14+
- [Android BarcodeScanner Samples](#android-barcodescanner-samples)
15+
- [ScanSingleBarcode](#scansinglebarcode)
16+
- [ScanMultipleBarcodes](#scanmultiplebarcodes)
17+
- [ScenarioOrientedSamples](#scenarioorientedsamples)
18+
- [Android Foundational API Samples](#android-foundational-api-samples)
19+
- [Read Single Barcode (With CameraEnhancer)](#read-single-barcode-with-cameraenhancer)
20+
- [Read Single Barcode (With CameraX)](#read-single-barcode-with-camerax)
21+
- [Decode Barcodes from an Image](#decode-barcodes-from-an-image)
22+
- [General Barcode Decoding Settings](#general-barcode-decoding-settings)
23+
- [Decode Tiny Barcodes](#decode-tiny-barcodes)
24+
- [Locate an Item with Barcode](#locate-an-item-with-barcode)
25+
- [Android ID Scanning Samples](#android-id-scanning-samples)
26+
- [Scan a Driver's License (via PDF417 Barcode)](#scan-a-drivers-license-via-pdf417-barcode)
27+
- [Other Use Case Samples for Android Platform](#other-use-case-samples-for-android-platform)
28+
- [Scan VIN Barcode](#scan-vin-barcode)
3029

3130
## Demos
3231

‎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: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,42 @@ breadcrumbText: BarcodeResultItem
1010

1111
# BarcodeResultItem Class
1212

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.
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.
1714

1815
## Definition
1916

2017
*Assembly:* dynamsoft_capture_vision_flutter
2118

2219
```dart
23-
class BarcodeResultItem
20+
class BarcodeResultItem extends CapturedResultItem
2421
```
2522

2623
## Properties
2724

2825
| Property | Type | Description |
2926
| -------- | ---- | ----------- |
30-
| [`format`](#format) | *[EnumBarcodeFormat](../enum/barcode-format.md)* | The format of the barcode represented as [`EnumBarcodeFormat`](../enum/barcode-format.md). |
27+
| [`format`](#format) | *BigInt* | The format of the barcode. |
3128
| [`formatString`](#formatstring) | *String* | The format of the barcode as a text string. |
3229
| [`text`](#text) | *String* | The decoded text of the barcode. |
3330
| [`bytes`](#bytes) | *Uint8List* | The raw bytes of the barcode. |
3431
| [`location`](#location) | *Quadrilateral* | The location of the barcode in the image/frame. |
3532
| [`confidence`](#confidence) | *int* | The confidence of the barcode result. |
3633
| [`angle`](#angle) | *int* | The angle at which the barcode is detected if it's not aligned in the image/frame. |
3734
| [`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). |
35+
| [`isDPM`](#isdpm) | *bool* | Indicates whether the barcode is a Direct Part Marking (DPM). |
3936
| [`isMirrored`](#ismirrored) | *bool* | Indicates whether the barcode image is mirrored. |
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. |
4042

4143
### format
4244

43-
The format of the barcode represented as a [`EnumBarcodeFormat`](../enum/barcode-format.md).
45+
The format of the barcode. One of the [`EnumBarcodeFormat`]({{ site.dcv_flutter_api }}core/enum/barcode-format.html).
4446

4547
```dart
46-
EnumBarcodeFormat format;
48+
BigInt format;
4749
```
4850

4951
### 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#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. |
3737

3838
### items
3939

‎programming/flutter/api-reference/enum/qr-code-correction.md‎ renamed to ‎programming/flutter/api-reference/barcode-reader/enum/qr-code-correction.md‎

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.

0 commit comments

Comments
 (0)