Inherits NSObject.
Instance Methods | |
| (BOOL) | - isExtensionEnabled: |
| (void) | - setExtension:enabled: |
Properties | |
| SBSSymbology | symbology |
| BOOL | enabled |
| BOOL | colorInvertedEnabled |
| NSSet< NSNumber * > * | checksums |
| NSSet< NSNumber * > * | activeSymbolCounts |
| NSSet< NSString * > * | enabledExtensions |
Detailed Description
Holds settings specific to a single symbology such as checksums and active symbol count.
Method Documentation
| - (BOOL) isExtensionEnabled: | (nonnull NSString *) | 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
- YES if the extension is enabled, NO if not.
- Since
- 4.7.0
| - (void) setExtension: | (nonnull NSString *) | extension | |
| enabled: | (BOOL) | 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 Symbology Extensions section.
- Parameters
-
extension Name of the extension. enabled Whether the extension should be enabled/disabled.
- Since
- 4.7.0
Property Documentation
|
readnonatomicassign |
|
readwritenonatomicassign |
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.
- Since
- 4.7.0
|
readwritenonatomicassign |
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.
- Since
- 4.7.0
|
readwritenonatomicstrong |
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.
- Since
- 4.7.0
|
readwritenonatomicstrong |
This function allows to control the length of barcodes to be decoded.
Call this function 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.7.0
|
readnonatomicassign |
Retrieve the currently enabled extensions for this symbology.
- Since
- 4.16.0
The documentation for this class was generated from the following file: