Public Member Functions

byte[] GetRawData ()
 

Public Attributes

readonly int Symbology
 
readonly String SymbologyName
 
readonly boolean IsGs1DataCarrier
 
readonly boolean IsRecognized
 
readonly String Data
 
Quadrilateral Location
 

Static Public Attributes

static final int SymbologyUnknown
 
static final int SymbologyEan13
 
static final int SymbologyEan8
 
static final int SymbologyUpca
 
static final int SymbologyUpce
 
static final int SymbologyCode128
 
static final int SymbologyCode11
 
static final int SymbologyCode25
 
static final int SymbologyCode39
 
static final int SymbologyCode93
 
static final int SymbologyInterleaved2of5
 
static final int SymbologyQr
 
static final int SymbologyDataMatrix
 
static final int SymbologyPdf417
 
static final int SymbologyMsiPlessey
 
static final int SymbologyGs1Databar
 
static final int SymbologyGs1DatabarExpanded
 
static final int SymbologyGs1DatabarLimited
 
static final int SymbologyCodabar
 
static final int SymbologyAztec
 
static final int SymbologyMaxicode
 
static final int SymbologyTwoDigitAddOn
 
static final int SymbologyFiveDigitAddOn
 
static final int[] AllSymbologies
 

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.

Member Function Documentation

byte [] GetRawData ( )

The raw byte data contained in the barcode.

Use this method in case you are encoding binary data in barcodes\2D codes that can not be represented as UTF-8 strings.

Returns
The raw byte data.

Member Data Documentation

final int SymbologyUnknown
static

Sentinel value to represent an unknown symbology.

final int SymbologyEan13
static

EAN13 1D barcode symbology.

final int SymbologyEan8
static

EAN8 1D barcode symbology.

final int SymbologyUpca
static

UPC12/UPCA 1D barcode symbology.

final int SymbologyUpce
static

UPCE 1D barcode symbology.

final int SymbologyCode128
static

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

Only available in the Professional and Enterprise Packages.

final int SymbologyCode11
static

Code 11 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyCode25
static

Code25 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyCode39
static

Code39 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyCode93
static

Code 93 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyInterleaved2of5
static

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

Only available in the Professional and Enterprise Packages.

final int SymbologyQr
static

QR Code 2D barcode symbology.

final int SymbologyDataMatrix
static

Datamatrix 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyPdf417
static

PDF417 barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyMsiPlessey
static

MSI Plessey 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyGs1Databar
static

Databar 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyGs1DatabarExpanded
static

Databar Expanded 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyGs1DatabarLimited
static

GS1 DataBar Limited 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyCodabar
static

Codabar 1D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyAztec
static

Aztec 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyMaxicode
static

Maxicode 2D barcode symbology.

Only available in the Professional and Enterprise Packages.

final int SymbologyTwoDigitAddOn
static

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: SymbologyEan13, SymbologyUpca, SymbologyUpce, or SymbologyEan8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

final int SymbologyFiveDigitAddOn
static

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: SymbologyEan13, SymbologyUpca, SymbologyUpce, or SymbologyEan8 and the maximum number of codes per frame has to be set to at least 2.

Only available in the Professional and Enterprise Packages.

final int [] AllSymbologies
static

Enumerates all symbologies.

readonly int Symbology

Returns the symbology of a recognized barcode.

Codes for which IsRecognized() returns false, this is SymbologyUnknown. For all other codes, it is the symbology of the recognized code.

readonly String SymbologyName

Convenience property to directly get the name of the symbology as a string.

The symbology name as a lower-case string, e.g. ean13, or codabar.

readonly boolean IsGs1DataCarrier

Whether the code is a GS1 data carrier.

True if the code is a GS1 data carrier, false if not. False is returned for codes that have only been localized but not recognized.

readonly boolean IsRecognized

Whether the code was completely recognized.

This property is true for barcodes that were completely recognized and false for codes that were localized but not recognized. For codes returned by ScanditBarcodeScanner.Android.IScanSession.NewlyRecognizedCodes() and ScanditBarcodeScanner.Android.IScanSession.AllRecognizedCodes() this method always returns true, for codes returned by IScanSession.NewlyLocalizedCodes() IsRecognized() always returns false.

readonly String Data

The data contained in the barcode/2D code, e.g.

the 13 digit number of a 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 GetRawData() if your application scans these types of codes and you are expecting binary/non-printable data.

Quadrilateral Location

The location of the code in the image.

The location as a a polygon with 4 corners. The corners are in the coordinate system of the raw preview image. In order to be displayed they must be transformed to the coordinate system of the view. The meaning of the values of topLeft, topRight etc is such that the topLeft point corresponds to the top-left corner of the barcode regardless of how it is oriented in the image.

See also
ScanditBarcodeScanner.Android.BarcodePicker.ConvertPointToPickerCoordinates(Point)