Barcode Result Classes
iTextResult
iTextResult
is the class that stores the text result data.
- Objective-C
- Swift
@interface iTextResult : NSObject
class iTextResult : NSObject
Attribute | Descriptions |
---|---|
barcodeFormat |
Barcode type in BarcodeFormat group 1. |
barcodeFormat_2 |
Barcode type in BarcodeFormat group 2. |
barcodeFormatString |
Barcode type in BarcodeFormat group 1 as string. |
barcodeText |
The barcode text, ends by ‘\0’. |
barcodeBytes |
The barcode content in a byte array. |
localizationResult |
The corresponding localization result. |
detailedResult |
One of the following: iQRCodeDetails , iPDF417Details , iDataMatrixDetails , iAztecDetails , iOneDCodeDetails . |
extendedResults |
The extended result array. |
exception |
The exception message. |
isDPM |
This attribute stands for whether the result is a DPM result. |
isMirrored |
This attribute stands for whether the barcode is mirrored. |
iLocalizationResult
iLocalizationResult
is the extension of the class iTextResult
. It stores the localization result information.
- Objective-C
- Swift
@interface iLocalizationResult : NSObject
class iLocalizationResult : NSObject
Attribute | Descriptions |
---|---|
terminatePhase |
The terminate phase of localization result. |
barcodeFormat |
Barcode type in BarcodeFormat group 1. |
barcodeFormat_2 |
Barcode type in BarcodeFormat group 2. |
barcodeFormatString |
Barcode type in BarcodeFormat group 1 as string. |
resultPoints |
The vertices coordinates information of the barcode region. |
angle |
The angle of a barcode. Values range is from 0 to 360. |
moduleSize |
The barcode module size (the minimum bar width in pixel). |
pageNumber |
The page number the barcode located in. The index is 0-based. |
regionName |
The region name the barcode located in. |
documentName |
The document name. |
resultCoordinateType |
The coordinate type. |
accompanyingTextBytes |
The accompanying text content in a byte array. |
accompanyingTextBytesLength |
The length of the accompanying text byte array. |
confidence |
The confidence of the localization result. |
iExtendedResult
iExtendedResult
is the extension of the class iTextResult
. It stores the extended result information.
- Objective-C
- Swift
@interface iExtendedResult : NSObject
class iExtendedResult : NSObject
Attribute | Descriptions |
---|---|
resultType |
The extended result type. |
barcodeFormat |
Barcode type in BarcodeFormat group 1. |
barcodeFormat_2 |
Barcode type in BarcodeFormat group 2. |
barcodeFormatString |
Barcode type in BarcodeFormat group 1 as string. |
confidence |
The confidence of the result. The higher confidence means the higher accuracy. |
bytes |
The content in a byte array. |
bytesLength |
The length of the byte array. |
accompanyingTextBytes |
The accompanying text content in a byte array. |
accompanyingTextBytesLength |
The length of the accompanying text byte array. |
deformation |
The deformation value. |
detailedResult |
One of the following: iQRCodeDetails , iPDF417Details , iDataMatrixDetails , iAztecDetails , OneDCodeDetails . |
samplingImage |
The sampling image info. |
clarity |
The clarity of the barcode zone in percentage. |
iAztecDetails
iAztecDetails
is one of the detailedResult
in class iTextResult
. It stores the Aztec code details.
- Objective-C
- Swift
@interface iAztecDetails : NSObject
class iAztecDetails : NSObject
Attribute | Descriptions |
---|---|
moduleSize |
The barcode module size (the minimum bar width in pixel). |
rows |
The row count of the barcode. |
columns |
The column count of the barcode. |
layerNumber |
A negative number (-1, -2, -3, -4) specifies a compact Aztec code. A positive number (1, 2, .. 32) specifies a normal (full-rang) Aztec code. |
iDataMatrixDetails
iDataMatrixDetails
is one of the detailedResult
in class iTextResult
. It stores the DataMatrix code details.
- Objective-C
- Swift
@interface iDataMatrixDetails : NSObject
class iDataMatrixDetails : NSObject
Attribute | Descriptions |
---|---|
moduleSize |
The barcode module size (the minimum bar width in pixel). |
rows |
The row count of the barcode. |
columns |
The column count of the barcode. |
dataRegionRows |
The data region row count of the barcode. |
dataRegionColumns |
The data region column count of the barcode. |
dataRegionNumber |
The data region count. |
iOneDCodeDetails
iOneDCodeDetails
is one of the detailedResult
in class iTextResult
. It stores the OneD code details.
- Objective-C
- Swift
@interface iOneDCodeDetails : NSObject
class iOneDCodeDetails : NSObject
Attribute | Descriptions |
---|---|
moduleSize |
The barcode module size (the minimum bar width in pixel). |
startCharsBytes |
The start chars in a byte array. |
startCharsBytesLength |
The length of the start chars byte array. |
stopCharsBytes |
The stop chars in a byte array. |
stopCharsBytesLength |
The length of the stop chars byte array. |
checkDigitBytes |
The check digit chars in a byte array. |
checkDigitBytesLength |
The length of the check digit chars byte array. |
iPDF417Details
iPDF417Details
is one of the detailedResult
in class iTextResult
. It stores the PDF417 code details.
- Objective-C
- Swift
@interface iPDF417Details : NSObject
class iPDF417Details : NSObject
Attribute | Descriptions |
---|---|
moduleSize |
The barcode module size (the minimum bar width in pixel). |
rows |
The row count of the barcode. |
columns |
The column count of the barcode. |
errorCorrectionLevel |
The error correction level of the barcode. |
iQRCodeDetails
iQRCodeDetails
is one of the detailedResult
in class iTextResult
. It stores the QRCode details.
- Objective-C
- Swift
@interface iQRCodeDetails : NSObject
class iQRCodeDetails : NSObject
Attribute | Descriptions |
---|---|
moduleSize |
The barcode module size (the minimum bar width in pixels). |
rows |
The row count of the barcode. |
columns |
The column count of the barcode. |
errorCorrectionLevel |
The error correction level of the barcode. |
version |
The version of the QR Code. |
model |
Number of the models. |
mode |
Identify the first data encoding mode. |
page |
Identify the position of the particular symbol. |
totalPage |
Identify the total number of symbols to be concatenated in the Structured Append format. |
parityData |
The Parity Data shall be an 8 bit byte following the Symbol Sequence Indicator. The parity data is a value obtained by XORing byte by byte the ASCII/JIS values of all the original input data before division into symbol blocks. |
iSamplingImageData
iSamplingImageData
stores the detailed image data in iExtendedResult
.
- Objective-C
- Swift
@interface iSamplingImageData : NSObject
class iSamplingImageData : NSObject
Attribute | Descriptions |
---|---|
bytes |
The sampling image data in a byte array. |
width |
The width of the sampling image. |
height |
The height of the sampling image. |