BarcodeResultItem Class
The BarcodeResultItem class represents a single barcode result decoded by the barcode reader. It is part of the DecodedBarcodesResult, which is what the library outputs at the end of the barcode recognition process.
Definition
Assembly: dynamsoft-capture-vision-react-native
interface BarcodeResultItem extends CapturedResultItem
Properties
| Property | Type | Description |
|---|---|---|
format |
BigInt | The format of the barcode. |
formatString |
string | The format of the barcode as a text string. |
text |
string | The decoded text of the barcode. |
bytes |
string | The raw bytes of the barcode. |
location |
Quadrilateral | The location of the barcode in the image/frame. |
confidence |
int | The confidence of the barcode result. |
angle |
int | The angle at which the barcode is detected if it’s not aligned in the image/frame. |
moduleSize |
int | The size of the smallest module (dot or line) of the barcode. |
isDPM |
bool | Indicates whether the barcode is a Direct Part Marking (DPM). |
isMirrored |
bool | Indicates whether the barcode image is mirrored. |
pdf417Details |
PDF417Details | Represents extended info that is specific to PDF417 codes, if the decoded barcode is a PDF417 code. |
oneDCodeDetails |
OneDCodeDetails | Represents extended info that is specific to 1D codes, if the decoded barcode is a 1D code. |
dataMatrixDetails |
DataMatrixDetails | Represents extended info that is specific to DataMatrix codes, if the decoded barcode is a DataMatrix code. |
aztecDetails |
AztecDetails | Represents extended info that is specific to Aztec codes, if the decoded barcode is an Aztec code. |
qrCodeDetails |
QRCodeDetails | Represents extended info that is specific to QR Codes, if the decoded barcode is a QR Code. |
eciSegments |
The ECI segments of the decoded barcode. |
format
The format of the barcode. One of the EnumBarcodeFormat.
format: EnumBarcodeFormat | bigint;
formatString
The format of the barcode as a text string instead of a EnumBarcodeFormat.
formatString: string;
text
The decoded text of the barcode.
text: string;
bytes
A base64 string representing the raw bytes of the barcode.
bytes?: string;
location
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.
location: Quadrilateral;
confidence
The confidence of the barcode result is a measure of the result’s accuracy. If the confidence is lower than 30, the result will not be output by default as it is considered quite inaccurate.
confidence: number;
angle
The angle at which the barcode is detected if it’s not aligned in the image/frame.
angle: number;
moduleSize
The size of the smallest module (dot or line) of the barcode.
moduleSize: number;
isDPM
Indicates whether the barcode is a Dot Peen Marking (DPM), which is a unique type of DataMatrix code.
isDPM: boolean;
isMirrored
Indicates whether the barcode image is mirrored.
isMirrored: boolean;
qrCodeDetails
Represents extended info (as QRCodeDetails) that is specific to QR Codes, if the decoded barcode is a QR Code.
qrCodeDetails?: QRCodeDetails;
aztecDetails
Represents extended info (as AztecDetails) that is specific to Aztec codes, if the decoded barcode is an Aztec code.
aztecDetails?: AztecDetails;
dataMatrixDetails
Represents extended info (as DataMatrixDetails) that is specific to DataMatrix codes, if the decoded barcode is a DataMatrix code.
dataMatrixDetails?: DataMatrixDetails;
oneDCodeDetails
Represents extended info (as OneDCodeDetails) that is specific to 1D codes, if the decoded barcode is a 1D code.
oneDCodeDetails?: OneDCodeDetails;
pdf417Details
Represents extended info (as PDF417Details) that is specific to PDF417 codes, if the decoded barcode is a PDF417 code.
pdf417Details?: PDF417Details;
eciSegments
The Extended Channel Interpretation (ECI) segments of the decoded barcode. Each ECI segment specifies the character encoding used for a portion of the decoded bytes. The value is null if no ECI information is present.
eciSegments?: ECISegment[];
Remarks
- Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.