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 Android
Inherits NativeHandle.
Public Member Functions | |
boolean | isEnabled () |
boolean | isColorInvertedEnabled () |
void | setEnabled (boolean enabled) |
void | setColorInvertedEnabled (boolean enabled) |
void | setExtensionEnabled (String extension, boolean enabled) |
boolean | isExtensionEnabled (String extension) |
int | getChecksums () |
void | setChecksums (int checksums) |
int | getSymbology () |
short[] | getActiveSymbolCounts () |
void | setActiveSymbolCounts (short[] counts) |
String[] | getEnabledExtensions () |
Static Public Attributes | |
Optional Checksums | |
static final int | CHECKSUM_NONE |
static final int | CHECKSUM_MOD_10 |
static final int | CHECKSUM_MOD_11 |
static final int | CHECKSUM_MOD_47 |
static final int | CHECKSUM_MOD_43 |
static final int | CHECKSUM_MOD_103 |
static final int | CHECKSUM_MOD_1010 |
static final int | CHECKSUM_MOD_1110 |
static final int | CHECKSUM_MOD_16 |
Custom Symbology Extensions | |
These constant define symbology extensions that can be enabled by setExtensionEnabled() | |
static final String | EXTENSION_TINY |
static final String | EXTENSION_FULL_ASCII |
static final String | EXTENSION_REMOVE_LEADING_ZERO |
Detailed Description
Contains decoding of a specific symboloy.
The symbology settings class holds all settings that apply to a certain barcode symbology, such as whether the symbology is enabled, the enabled checksums etc.
- Since
- 4.7.0
Member Function Documentation
boolean isEnabled | ( | ) |
Whether decoding of this symbology is enabled.
This property only enables/disables decoding of dark codes on bright background. 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.
- Returns
- True when decoding is enabled, false if not.
- Since
- 4.7.0
boolean isColorInvertedEnabled | ( | ) |
Whether color-inverted decoding of this symbology is enabled.
This property only enables/disables decoding of bright codes on dark background. 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.
- Returns
- True when decoding is enabled, false if not.
- Since
- 4.7.0
void setEnabled | ( | boolean | enabled | ) |
Enabled/disable decoding of this symbology.
- See also
- isEnabled()
- Parameters
-
enabled whether decoding of this symbology should be enabled.
- Since
- 4.7.0
void setColorInvertedEnabled | ( | boolean | enabled | ) |
Enabled/disable color-inverted decoding of this symbology.
- See also
- isColorInvertedEnabled()
- Parameters
-
enabled whether color-inverted decoding of this symbology should be enabled.
- Since
- 4.7.0
void setExtensionEnabled | ( | String | extension, |
boolean | enabled | ||
) |
Activate/Deactivate a custom extension 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.
- Parameters
-
extension Name of the extension. enabled Whether the extension should be enabled/disabled.
- Since
- 4.7.0
boolean isExtensionEnabled | ( | String | extension | ) |
Determine whether a certain extension is enabled 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.
- Parameters
-
extension Name of the extension.
- Returns
- True if the extension is enabled, false if not.
- Since
- 4.7.0
int getChecksums | ( | ) |
Get active optional checksums for this symbology.
This property contains the 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.
- Returns
- An bitwise-ored combination of enabled optional checksums.
- Since
- 4.7.0
void setChecksums | ( | int | checksums | ) |
Set active optional checksums for this symbology.
- See also
- getChecksums()
- Parameters
-
checksums the new checksums to enable. At the moment, only one optional checksum is supported. This might change for future versions.
- See also
- 4.7.0
int getSymbology | ( | ) |
- Returns
- The symbology these symbology settings apply to.
- Since
- 4.7.0
short [] getActiveSymbolCounts | ( | ) |
Control the length of barcodes to be decoded.
Change this property 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.
- Returns
- array of enabled active symbol counts.
- Since
- 4.8.0
void setActiveSymbolCounts | ( | short[] | counts | ) |
Change the length of barcodes to be decoded.
- See also
- getActiveSymbolCounts
- Parameters
-
counts List of new active symbol counts to use.
- Since
- 4.8.0
String [] getEnabledExtensions | ( | ) |
Get list of currently enabled extensions of this symbology.
- Returns
- The list of currently enabled extensions. May be a list with zero elements in case no extensions are enabled.
Member Data Documentation
|
static |
No optional checksum.
|
static |
Modulo 10 checksum.
|
static |
Modulo 11 checksum.
|
static |
Modulo 47 checksum.
|
static |
Modulo 43 checksum.
|
static |
Modulo 103 checksum.
|
static |
Two modulo 10 checksums.
|
static |
A modulo 11 and a modulo 10 checksum.
|
static |
A modulo 16 checksum.
|
static |
Enable decoder optimizations for small data-matrix codes.
This extension has been deprecated in version 5.2 and no longer has any effect.
|
static |
Full-ASCII Code39 extension.
|
static |
Remove leading zero of UPCA codes.
When enabled, the leading zero of UPCA codes is removed. When false (the default), the leading zero is returned as part of the barcode data string
The documentation for this class was generated from the following file:
- SymbologySettings.java