Inherits NSObject, and <NSCopying>.
Instance Methods | |
| (nonnull instancetype) | - init |
| (nullable instancetype) | - initWithDictionary: |
| (void) | - enableSymbologies: |
| (void) | - setSymbology:enabled: |
| (nonnull SBSSymbologySettings *) | - settingsForSymbology: |
| (void) | - setScanningAreaHeight: |
| (void) | - setScanningAreaHeight2d: |
Properties | |
| SBSScanSettings * | scanSettings |
Detailed Description
Holds settings that affect the recognition of barcodes (e.g. enabled barcode symbologies).
The settings are passed to the SBSScanCase when it is constructed.
- Since
- 4.13.0
Method Documentation
| - (nonnull instancetype) init |
Initialize a new setting object.
- Returns
- new settings object
| - (nullable instancetype) initWithDictionary: | (nullable NSDictionary< NSString *, id > *) | dictionary |
Returns a settings instance initialized with the values contained in dictionary.
- Parameters
-
dictionary Dictionary, e.g. as deserialized from JSON to use for initializing the settings.
- Returns
- new settings object
| - (void) enableSymbologies: | (nonnull NSSet< NSNumber * > *) | symbologies |
Enable decoding of the given symbologies.
This function provides a convenient shortcut to enabling/disabling decoding of a particular symbology without having to go through SBSSymbologySettings.
By default, all symbologies are turned off and symbologies need to be explicitly enabled.
- Parameters
-
symbologies The symbologies that should be enabled.
- Since
- 4.13.0
| - (void) setSymbology: | (SBSSymbology) | symbology | |
| enabled: | (BOOL) | enabled | |
Enable/disable decoding of a certain symbology.
This function provides a convenient shortcut to enabling/disabling decoding of a particular symbology without having to go through SBSSymbologySettings.
- Parameters
-
symbology The symbology to be enabled. enabled YES when decoding of the symbology should be enabled, NO if not.
- Since
- 4.13.0
| - (nonnull SBSSymbologySettings *) settingsForSymbology: | (SBSSymbology) | symbology |
Retrieve symbology-specific settings.
- Parameters
-
symbology The symbology for which to retrieve the settings.
- Returns
- The symbology-specific settings object.
- Since
- 4.13.0
| - (void) setScanningAreaHeight: | (float) | height |
Set the active scanning height.
Use this method to set the active scanning height.
- Since
- 4.13.0
| - (void) setScanningAreaHeight2d: | (float) | height |
Set the active scanning height for 2d codes.
Use this method to set the active scanning height for 2d codes.
- Since
- 5.7
Property Documentation
|
readnonatomicassign |
Retrieve the scan settings to initialize a barcode picker.
Use these scan to initialize the barcode picker for use with the Scandit Scan case. Note that while it's possible for you to modify the settings returned by this property, it is not recommended to do so.
- Since
- 4.13.0
The documentation for this class was generated from the following file: