Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for React Native

Scandit.SymbologySettings Class Reference


enum  Checksum
enum  Extension

Public Attributes

boolean enabled
boolean colorInvertedEnabled
Extension[] extensions
Checksum[] checksums
int[] activeSymbolCounts

Detailed Description

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

Class Documentation

enum Scandit::SymbologySettings::Checksum

Checksums for the symbology.

Class Members
MOD_10 Modulo 10 checksum.
MOD_11 Modulo 11 checksum.
MOD_47 Modulo 47 checksum.
MOD_43 Modulo 43 checksum.
MOD_103 Modulo 103 checksum.
MOD_1010 Two modulo 10 checksums.
MOD_1110 A modulo 11 and a modulo 10 checksum.
enum Scandit::SymbologySettings::Extension

Extensions for the symbology.

Class Members
FULL_ASCII Interprets the Code39 code data using two symbols per output character to encode all ASCII characters.
REMOVE_LEADING_ZERO Removes the leading zero digit from the result.
RELAXED_SHARP_QUIET_ZONE_CHECK Enables scanning codes that have quiet zones (white area before and after the code) that are significantly smaller than allowed by the symbology specification.

Use this extension if you are having difficulties to scan codes due to quiet zone violations. However, enabling it may come at the cost of more false positives under certain circumstances.

RETURN_AS_UPCA Transforms the UPCE result into its UPCA representation.
REMOVE_LEADING_UPCA_ZERO Removes the leading zero digit from the result if the UPCA representation extension 'return_as_upca' is enabled.
STRIP_LEADING_FNC1 Removes the leading FNC1 character that indicates a GS1 code.

Member Data Documentation

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.