Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 88 additions & 83 deletions _includes/sidelist-programming/programming-flutter.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion programming/android/api-reference/enum/barcode-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ public @interface EnumBarcodeFormat {
public static final long BF_PHARMACODE_TWO_TRACK = 1L << 35;
/**Matrix25.*/
public static final long BF_MATRIX_25 = 1L << 36;
/**Combined value of BF2_USPSINTELLIGENTMAIL, BF2_POSTNET, BF2_PLANET, BF2_AUSTRALIANPOST, BF2_RM4SCC, BF_KIX.*/
/**Combined value of BF_USPSINTELLIGENTMAIL, BF_POSTNET, BF_PLANET, BF_AUSTRALIANPOST, BF_RM4SCC, BF_KIX.*/
public static final long BF_POSTALCODE = 0x3F0000000000000;
/**USPS Intelligent Mail barcode.*/
public static final long BF_USPSINTELLIGENTMAIL = 1L << 52;
Expand Down
35 changes: 17 additions & 18 deletions programming/android/samples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,23 @@ noTitleIndex: false

# Android Barcode Scanner Demo & Samples

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

## Demos

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ class AztecDetails

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`rows`](#rows) | *int* | Represents the number of rows that make up the Aztec Code. |
| [`columns`](#columns) | *int* | Represents the number of columns that make up the Aztec Code. |
| [`layerNumber`](#layernumber) | *int* | Represents the layer number of an Aztec code.|

### rows

Represents the number of rows that make up the Aztec Code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,40 +10,42 @@ breadcrumbText: BarcodeResultItem

# BarcodeResultItem Class

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.

> [!NOTE]
> BarcodeResultItem implements the [`CapturedResultItem`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result-item.html) class.
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.

## Definition

*Assembly:* dynamsoft_capture_vision_flutter

```dart
class BarcodeResultItem
class BarcodeResultItem extends CapturedResultItem
```

## Properties

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

### format

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

```dart
EnumBarcodeFormat format;
BigInt format;
```

### formatString
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ class DataMatrixDetails

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`rows`](#rows) | *int* | Represents the number of rows that make up the DataMatrix Code. |
| [`columns`](#columns) | *int* | Represents the number of columns that make up the DataMatrix Code. |
| [`dataRegionRows`](#layernumber) | *int* | Represents the number of rows in the data region of the DataMatrix code. |
| [`dataRegionColumns`](#dataregioncolumns) | *int* | Represents the number of columns in the data region of the DataMatrix code. |
| [`dataRegionNumber`](#dataregionnumber) | *int* | Represents the number of data regions in the DataMatrix code. |

### rows

Represents the number of rows that make up the DataMatrix Code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The `DecodedBarcodesResult` class represents the result of a barcode reading pro
*Assembly:* dynamsoft_capture_vision_flutter

```dart
class DecodedBarcodesResult
class DecodedBarcodesResult extends CapturedResultBase
```

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

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

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`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. |
| [`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. |
| [`errorCode`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errorcode) | *int* | The error code associated with the capture result. |
| [`errorMessage`]({{ site.dcv_flutter_api }}capture-vision-router/captured-result.html#errormessage) | *String* | The error message associated with the capture result. |
| Properties | Types | Description |
| ---------- | ----- | ----------- |
| [`originalImageHashId`]({{ site.dcv_flutter_api }}core/captured-result-base.html#originalimagehashid) | *String* | The hash id of the original image. |
| [`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. |
| [`errorCode`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errorcode) | *int* | The error code of this result. |
| [`errorMessage`]({{ site.dcv_flutter_api }}core/captured-result-base.html#errormessage) | *String* | The error message of this result. |

### items

Expand Down
11 changes: 10 additions & 1 deletion programming/flutter/api-reference/barcode-reader/oned-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ class OneDCodeDetails

## Properties

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

### startCharsBytes

A byte list representing the characters of the start pattern of a 1D barcode.
Expand Down Expand Up @@ -78,7 +87,7 @@ The start of this range represents the x-coordinate of the start position as a p
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.

```dart
RangeValues startPatternRange;
RangeValues middlePatternRange;
```

**Remarks**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ class PDF417Details

## Properties

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

### rows

Represents the number of rows that make up the PDF417 Code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ class QRCodeDetails

## Properties

| Property | Type | Description |
| -------- | ---- | ----------- |
| [`rows`](#rows) | *int* | Represents the number of rows that make up the QR Code. |
| [`columns`](#columns) | *int* | Represents the number of columns that make up the QR Code. |
| [`errorCorrectionLevel`](#errorcorrectionlevel) | *EnumQRCodeErrorCorrectionLevel* | Represents the error correction level of the QR Code as a [`EnumQRCodeErrorCorrectionLevel`](enum/qr-code-correction.md). |
| [`version`](#version) | *int* | Represents the version of the QR Code. |
| [`model`](#model) | *int* | Represents the number of models of the QR Code. |
| [`mode`](#mode) | *int* | Identifies the first data encoding mode of the QR Code. |
| [`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. |
| [`totalPage`](#totalpage) | *int* | The total number of symbols to be concatenated into the Structured Append format of the QR Code. |
| [`parityData`](#paritydata) | *int* | The Parity Data of the QR Code. |
| [`dataMaskPattern`](#datamaskpattern) | *int* | Represents the data mask pattern reference for the QR Code symbols. |
| [`codewords`](#codewords) | *byte[]?* | The codewords of the QR Code. |

### rows

Represents the number of rows that make up the QR Code.
Expand All @@ -43,7 +57,7 @@ int columns;

### errorCorrectionLevel

Represents the error correction level of the QR Code as a [`EnumQRCodeErrorCorrectionLevel`](../enum/qr-code-correction.md).
Represents the error correction level of the QR Code as a [`EnumQRCodeErrorCorrectionLevel`](enum/qr-code-correction.md).

```dart
EnumQRCodeErrorCorrectionLevel errorCorrectionLevel;
Expand Down
Loading