Scandit Class Reference

Classes

class  Barcode
 
class  BarcodePicker
 
class  Constraints
 
class  Margins
 
class  Point
 
class  Quadrilateral
 
class  Rect
 
class  ScanOverlay
 
class  ScanSession
 
class  ScanSettings
 
class  SymbologySettings
 

Detailed Description

Module for all functionality of the barcode recognition plugin.

Since
4.11.0

Class Documentation

class Scandit::Constraints

Constraints for the scanner view.

Margins have higher priority than width and height, for example if the horizontal margins and the width are all set, the width is ignored. If the width is set but no horizontal margins are set the plugin will set the left margin to 0. For the same scenario with the vertical margins and height, the top margin will be set to 0.

Since
4.13.1
Class Members
number leftMargin The left margin.

Can be specified as an integer to mean device independent pixels/points or alternatively as a string with an added '%' at the end. When expressing the margin in percent, it is set to the desired percentage of the screen width.

number topMargin The top margin.

Can be specified as an integer to mean device independent pixels/points or alternatively as a string with an added '%' at the end. When expressing the margin in percent, it is set to the desired percentage of the screen height.

number rightMargin The right margin.

Can be specified as an integer to mean device independent pixels/points or alternatively as a string with an added '%' at the end. When expressing the margins in percent, it is set to the desired percentage of the screen width.

number bottomMargin The bottom margin.

Can be specified as an integer to mean device independent pixels/points or alternatively as a string with an added '%' at the end. When expressing the margins in percent, it is set to the desired percentage of the screen height.

number width The width.

Can be specified as an integer to mean device independent pixels/points or alternatively as a string with an added '%' at the end. When expressing the width in percent, it is set to the desired percentage of the screen width.

number height The height.

Can be specified as an integer to mean device independent pixels/points or alternatively as a string with an added '%' at the end. When expressing the height in percent, it is set to the desired percentage of the screen height.

class Scandit::Quadrilateral

A 2-dimensional polygon with 4 corners.

Since
4.11.0
Class Members
Point topLeft Top left corner of the quadrilateral.
Point topRight Top right corner of the quadrilateral.
Point bottomLeft Bottom left corner of the quadrilateral.
Point bottomRight Bottom right corner of the quadrilateral.
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.

Since
4.11.0
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.

Since
4.11.0
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.

Since
4.11.0
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.

Since
4.11.0
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.

Since
4.11.0