QRCodeDetails

The QRCodeDetails class encapsulates all of the extended details of a QR Code that is not available in the regular barcode result, if the barcode is a QR Code.

If you would like to learn more about the QR Code format, please refer to this page.

Definition

Assembly: dynamsoft-capture-vision-react-native

interface QRCodeDetails

Properties

rows

Represents the number of rows that make up the QR Code.

rows: number;

columns

Represents the number of columns that make up the QR Code.

columns: number;

errorCorrectionLevel

Represents the error correction level of the QR Code as a EnumQRCodeErrorCorrectionLevel.

errorCorrectionLevel: number;

Remarks

There are four levels of error correction that determine how much damage a QR Code can sustain and still be readable. The error correction level is determined when the QR Code is generated, and then later gets encoded into the final QR code image.

version

Represents the version of the QR Code.

version: number;

model

Represents the number of models of the QR Code.

model: number;

mode

Identifies the first data encoding mode of the QR Code.

mode: number;

page

Identifies the position of the particular symbol (as in this specific QR Code) in the Structured Append format of the overall QR Code.

page: number;

Remarks

Structured Append is a QR Code feature that is used to split a (typically) large message across several QR Codes. This comes in handy for data that would typically be too large to fit into a single QR Code. In these cases, each QR Code contains extra metadata indicating its position in the sequence as well as the total number of codes in the sequence.

totalPage

Identifies the total number of symbols to be concatenated in the Structured Append format of the QR Code.

totalPage: number;

Remarks

Structured Append is a QR Code feature that is used to split a (typically) large message across several QR Codes. This comes in handy for data that would typically be too large to fit into a single QR Code. In these cases, each QR Code contains extra metadata indicating its position in the sequence as well as the total number of codes in the sequence.

parityData

Identifies the unique parity identifier of the QR Code in the Structured Append format. The parity identifier allows the library to confirm that the QR Codes of the Structured Append format belong to the same group.

parityData: number;

Remarks

Structured Append is a QR Code feature that is used to split a (typically) large message across several QR Codes. This comes in handy for data that would typically be too large to fit into a single QR Code. The Parity Data shall be an 8-bit byte following the Symbol Sequence indicator. The parity data is a value obtained by XORing the ASCII/JIS values of all the original input data byte by byte before division into symbol blocks.

dataMaskPattern

Represents the data mask pattern reference for the QR Code symbols.

dataMaskPattern: number;

Remarks

A data mask pattern prevents large blocks of black or white modules that could confuse a scanner. There are eight mask patterns, with each having its own unique formula to determine whether to invert the colour of each module. The process of choosing one of the eight mask patterns is determined by the generator, assessing which pattern will lead to the lowest penalty score. This score is calculated based on a variety of factors that are defined in the QR Code specification.

codewords

Represents the fundamental data units (or codewords) that are used to store the encoded data of a QR Code as well as the error correction info.

codewords: number[];

Remarks

Typically in a QR Code, there are data codewords and error correction codewords. Data codewords contain the actual info encoded onto the QR Code, while the error correction codewords are extra codewords that contain unnecessary or superfluous data. These error correction codewords help the reader identify the QR Code even if it’s damaged or distorted in some way.