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 iOS

SBSScanCaseSettings Class Reference

Inherits NSObject, and <NSCopying>.

Instance Methods

(nonnull instancetype) - init
 
(nullable instancetype) - initWithDictionary:
 
(void) - enableSymbologies:
 
(void) - setSymbology:enabled:
 
(nonnull SBSSymbologySettings *) - settingsForSymbology:
 
(void) - setScanningAreaHeight:
 

Properties

SBSScanSettingsscanSettings
 

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
dictionaryDictionary, 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
symbologiesThe 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.

SBSScanCaseSettings *settings = ... ;
[settings setSymbology:SymbologyQR enabled:YES];
// the following line has the same effect:
[settings settingsForSymbology:SymbologyQR].enabled = YES;
Parameters
symbologyThe symbology to be enabled.
enabledYES 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
symbologyThe 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

Property Documentation

- (SBSScanSettings*) scanSettings
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: