Scandit Class Reference

Classes
class	Barcode
class	BarcodePicker
class	ScanSession
class	ScanSettings
class	SymbologySettings

Detailed Description

Module for all functionality of the barcode recognition plugin.

---

Class Documentation

class Scandit::Barcode

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 Members
String	data	the data contained in the barcode/2D code, for example the 13 digit number of an EAN13 code.
String	symbology	the symbology of a recognized barcode.

class Scandit::SymbologySettings

Holds settings specific to a particular symbology (1d, 2d)

Class Members
boolean	enabled	Enables/disables decoding of dark codes on bright background only. If color- inverted (bright on dark) codes for this symbology are required, enable them through the colorInvertedEnabled property. By default decoding of all symbologies is disabled. It is advised to only enable symbologies that are required by the application as every enabled symbology adds processing overhead.
boolean	colorInvertedEnabled	Enables/disables decoding of bright codes on dark background only. By default color-inverted decoding of all symbologies is disabled. It is advised to only enable symbologies that are required by the application as every enabled symbology adds processing overhead.
Extension[]	extensions	An array of all active custom extensions for the symbology. Extensions are custom features that are only supported by a small number of symbologies. For a list of supported extensions, consult the constants of this class.
Checksum[]	checksums	Array of additional checksums for this symbology. When a barcode has been decoded, the checksums contained are evaluated in addition to any mandatory checksum defined by the symbology specification. If any of the checksums matches, the code is returned as recognized, otherwise it is discarded.
int[]	activeSymbolCounts	Array containing the length of barcodes to be decoded for this symbology. Change this property to enable decoding of long codes which can not be decoded with the default settings, or to optimize decoder performance for codes of certain lengths. This is useful when it is known that the application only requires scanning of particular barcode lengths. The mapping from characters to symbols is symbology-specific. For some symbologies, the start and end characters are included, others include checksums characters in the symbol counts. The active symbol count setting is ignored for fixed-size barcodes (the EAN and UPC family of codes) as well as 2d codes. For other symbologies, see Calculating symbol counts for variable-length symbologies.