Class BarcodeItem

The number of 1D stacks in the barcode. Applies only to DATABAR and DATABAR_EXPANDED barcodes.

Default Value

1;
Copy

As quad, but extended to appropriate height for oned barcodes.

As quadNormalized, but extended to appropriate height for oned barcodes.

The parsed known document format (if parsed successfully).

Barcode format.

Default Value

"NONE";
Copy

The index of the barcode to uniquely identify it. In case of frame accumulation, the index remains the same across frames.

Default Value

-1;
Copy

True if this result is the 2D part of a GS1 Composite barcode. Can only happen if GS1_COMPOSITE scanning is disabled and a part of the composite (1D) or (2D) is scanned separately. When GS1_COMPOSITE scanning is enabled, parts of the composite barcode are never returned separately, even if their respective format is enabled in the decoding options.

Default Value

false;
Copy

True if the barcode contains a GS1 message. Requires GS1 handling to be enabled in the decoding option.

Default Value

false;
Copy

True if this is a 1D barcode that is printed upside-down, that is, the barcode was scanned right-to-left.

Default Value

false;
Copy

The four corners of the barcode in the input image, in clockwise order starting from the top left, in image coordinates.

The four corners of the barcode in the input image, in clockwise order starting from the top left, normalized to the range [0, 1].

Raw bytes of barcode contents. Some barcode formats are able to encode binary data. If a barcode contains binary data, it's provided as a list of bytes in the rawBytes field. Some barcode formats additionally allow pieces of the data within to have different encodings - UTF-8, ASCII, binary, etc. The rawBytesEncodings field lists the encoding of each range in the rawBytes array. For barcode formats that contain a GS1 message (e.g. GS1 Composite), we recommend to use a GS1Handling and extract the GS1 message from the text.

Encoding information for the rawBytes field. Each element of this list covers some portion of the rawBytes array. Taken together, the elements of the list cover the entirety of the rawBytes array without overlap and without holes. The elements are ordered in increasing order of the start and end indices.

The size score is a floating point value between 0 and 1 that represents the relative size of the barcode in the input image. Barcodes taking up a small portion of the input image will have a score close to 0, while barcodes that take a large portion will have a score close to 1.

Default Value

0.0;
Copy

A crop from the input image containing the barcode.

Default Value

null;
Copy

If this barcode is part of a structured append sequence, this field contains information about the sequence.

Text contained in the barcode. Binary data is returned in the rawBytes field only.

If this is a UPC/EAN barcode that has an EAN-2 or EAN-5 extension, this field contains the extension value. Requires the UPC_EAN_EXTENSION format to be enabled in the decoding options.