Scandit.Barcode Class Reference

Classes

enum  CompositeFlag
 
enum  Symbology
 

Public Attributes

String data
 
int[] rawData
 
Symbology symbology
 
CompositeFlag compositeFlag
 
boolean isRecognized
 
Quadrilateral location
 
Quadrilateral predictedLocation
 
Quadrilateral convertedPredictedLocation
 
Quadrilateral convertedLocation
 
boolean shouldAnimateFromPreviousToNextState
 
boolean deltaTimeForPrediction
 

Detailed Description

Represents a recognized/localized barcode/2D code.

The Barcode class represents a barcode, or 2D code that has been localized or recognized by the barcode recognition engine.


Class Documentation

enum Scandit::Barcode::CompositeFlag

Composite flags for barcodes/2D codes.

Class Members
NONE Code is not part of a composite code.
UNKNOWN Code could be part of a composite code.

This flag is set by linear (1d) symbologies that have no composite flag support but can be part of a composite code like the EAN/UPC symbology family.

LINKED Code is the linear component of a composite code.

This flag can be set by GS1 DataBar or GS1-128 (Code 128).

GS1_TYPE_A Code is a GS1 Composite Code Type A (CC-A).

This flag can be set by MicroPDF417 codes.

GS1_TYPE_B Code is a GS1 Composite Code Type B (CC-B).

This flag can be set by MicroPDF417 codes.

GS1_TYPE_C Code is a GS1 Composite Code Type C (CC-C).

This flag can be set by PDF417 codes.

enum Scandit::Barcode::Symbology

An enumeration of all supported barcode symbologies.

Class Members
UNKNOWN Sentinel value to represent an unknown symbology.
EAN13 EAN13 1D barcode symbology.
EAN8 EAN8 1D barcode symbology.
UPCA UPC12/UPCA 1D barcode symbology.
UPCE UPCE 1D barcode symbology.
CODE11 Code 11 barcode symbology.

Only available in the Professional and Enterprise Packages.

CODE25 Code 25 barcode symbology.

Only available in the Professional and Enterprise Packages.

CODE39 Code39 barcode symbology.

Only available in the Professional and Enterprise Packages.

CODE93 Code 93 barcode symbology.

Only available in the Professional and Enterprise Packages.

CODE128 Code 128 1D barcode symbology, including GS1-Code128.

Only available in the Professional and Enterprise Packages.

ITF Interleaved-Two-of-Five (ITF) 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

QR QR Code 2D barcode symbology.
DATA_MATRIX Datamatrix 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

PDF417 PDF417 barcode symbology.

Only available in the Professional and Enterprise Packages.

MICRO_PDF417 MicroPDF417 barcode symbology.

Only available in the Professional and Enterprise Packages.

MSI_PLESSEY MSI Plessey 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

GS1_DATABAR Databar 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

GS1_DATABAR_LIMITED Databar Limited 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

GS1_DATABAR_EXPANDED Databar Expanded 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

CODABAR Codabar 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

AZTEC Aztec 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

DOTCODE DotCode 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

MICROQR Micro QR 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

MAXICODE Maxicode 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

FIVE_DIGIT_ADD_ON Five-digit add-on for UPC and EAN codes.

In order to scan five-digit add-on codes, at least one of these symbologies must be activated as well: SYMBOLOGY_EAN13, SYMBOLOGY_UPCA, SYMBOLOGY_UPCE, or SYMBOLOGY_EAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

TWO_DIGIT_ADD_ON Two-digit add-on for UPC and EAN codes.

In order to scan two-digit add-on codes, at least one of these symbologies must be activated as well: SYMBOLOGY_EAN13, SYMBOLOGY_UPCA, SYMBOLOGY_UPCE, or SYMBOLOGY_EAN8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

KIX Royal Dutch TPG Post KIX.

Only available in Professional and Enterprise Packages.

RM4SCC Royal Mail 4 State Customer Code (RM4SCC).

Only available in Professional and Enterprise Packages.

CODE32 Code 32 barcode symbology.

Only available in Professional and Enterprise Packages.

LAPA4SC LAPA 4 State Code.

Only available in Professional and Enterprise Packages.

Member Data Documentation

String data

The data contained in the barcode/2D code, for example the 13 digit number of an EAN13 code.

For some types of barcodes/2D codes (for example DATAMATRIX, AZTEC, PDF417), the data string may contain non-printable characters and nul-bytes in the middle of the string. Use rawData if your application scans these types of codes and you are expecting binary/non-printable data.

int [] rawData

The data contained in the barcode/2D code, for example the 13 digit number of an EAN13 code.

The data is stored as an array of integers, where each item in the array corresponds to the char code. Use this property instead of data if your application expects to scan codes containing binary data that can not be represented as UTF-8 strings.

Symbology symbology

the symbology of a recognized barcode.

CompositeFlag compositeFlag

The composite flag of the barcode.

For codes that have been localized but not recognized, CompositeFlag.UNKNOWN is returned.

boolean isRecognized

Specifies if the barcode has been recognized or not.

Quadrilateral location

The location of the barcode in the frame.

Quadrilateral predictedLocation

The predicted location of the barcode in the frame.

(Only available for tracked codes if MatrixScan is enabled.)

Quadrilateral convertedPredictedLocation

The converted predicted location of the barcode in the coordinate system of the picker.

(Only available for tracked codes if MatrixScan is enabled.)

Quadrilateral convertedLocation

The converted location of the barcode in the coordinate system of the picker.

(Only available for tracked codes if MatrixScan is enabled.)

boolean shouldAnimateFromPreviousToNextState

If the barcode should animate to the next state, used for visualizing tracked codes.

(Only available for tracked codes if MatrixScan is enabled.)

boolean deltaTimeForPrediction

The predicted time until the predicted location, used for visualizing tracked codes.

(Only available for tracked codes if MatrixScan is enabled.)