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

SBSScanSettings.h
Go to the documentation of this file.
1 //
2 // SBSScanSettings.h
3 // BarcodeScanner
4 //
5 // Created by Moritz Hartmeier on 20/05/15.
6 // Copyright (c) 2015 Scandit AG. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 
11 #import "SBSCommon.h"
12 #import "SBSSymbologySettings.h"
13 #import "SBSScanAreaSettings.h"
14 
29 @interface SBSScanSettings : NSObject<NSCopying>
30 
36 + (nonnull instancetype)defaultSettings;
37 
50 + (nonnull instancetype)pre47DefaultSettings;
51 
52 
60 + (nullable instancetype)settingsWithDictionary:(nonnull NSDictionary<NSString *, id> *)dictionary
61  error:(NSError * _Nullable * _Nullable)error;
62 
70 @property (nonatomic, assign) SBSWorkingRange workingRange;
71 
85  - (void)enableSymbologies:(nonnull NSSet<NSNumber *> *)symbologies;
86 
115 - (void)setSymbology:(SBSSymbology)symbology enabled:(BOOL)enabled;
116 
120 - (nonnull NSSet<NSNumber *> *)enabledSymbologies;
121 
130 - (nonnull SBSSymbologySettings *)settingsForSymbology:(SBSSymbology)symbology;
131 
141 @property (nonatomic, assign) BOOL force2dRecognition;
142 
150 @property (nonatomic, assign) NSInteger maxNumberOfCodesPerFrame;
151 
165 @property (nonatomic, assign) NSInteger codeDuplicateFilter;
166 
179 @property (nonatomic, assign) NSInteger codeCachingDuration;
180 
187  @property (nonatomic, assign) float relativeZoom;
188 
200 @property (nonatomic, assign) SBSCameraFacingDirection cameraFacingPreference;
201 
209 @property (nullable, nonatomic, strong) NSString *deviceName;
210 
223 @property (nonatomic, assign) BOOL highDensityModeEnabled;
224 
238 @property (nonatomic, assign) CGRect activeScanningAreaLandscape;
239 
255 @property (nonatomic, assign) CGRect activeScanningAreaPortrait;
256 
264 @property (nonatomic, assign) BOOL restrictedAreaScanningEnabled;
265 
276 @property (nonatomic, assign) CGPoint scanningHotSpot;
277 
286 - (void)setActiveScanningArea:(CGRect)area;
287 
288 
301 @property (nonatomic, assign) BOOL motionCompensationEnabled;
302 
316 - (void)setProperty:(nonnull NSString *)property toValue:(int)value;
317 
326 @property (nonatomic, assign) BOOL codeRejectionEnabled;
327 
339 @property (nullable, nonatomic, strong) SBSScanAreaSettings *areaSettingsPortrait;
340 
352 @property (nullable, nonatomic, strong) SBSScanAreaSettings *areaSettingsLandscape;
353 
367 @property (nonatomic, assign, getter=isMatrixScanEnabled) BOOL matrixScanEnabled;
368 
369 @end
CGRect activeScanningAreaPortrait
The active scanning area when the picker is in portrait orientation.
Definition: SBSScanSettings.h:255
CGRect activeScanningAreaLandscape
The active scanning area when the picker is in landscape orientation.
Definition: SBSScanSettings.h:238
SBSScanAreaSettings * areaSettingsLandscape
Landscape area settings, if present.
Definition: SBSScanSettings.h:352
BOOL force2dRecognition
Forces the barcode scanner to always run the 2D decoders (QR Code, Data Matrix, etc.), even when the 2D detector did not detect the presence of a 2D code.
Definition: SBSScanSettings.h:141
BOOL codeRejectionEnabled
Whether code rejection should be enabled.
Definition: SBSScanSettings.h:326
BOOL motionCompensationEnabled
Enable/disable motion compensation.
Definition: SBSScanSettings.h:301
SBSScanAreaSettings * areaSettingsPortrait
Portrait area settings, if present.
Definition: SBSScanSettings.h:339
BOOL matrixScanEnabled
Whether matrix scan should be enabled.
Definition: SBSScanSettings.h:367
Holds settings specific to a single symbology such as checksums and active symbol count...
Definition: SBSSymbologySettings.h:66
SBSCameraFacingDirection
Definition: SBSCommon.h:38
NSInteger maxNumberOfCodesPerFrame
The maximum number of barcodes to be decoded every frame.
Definition: SBSScanSettings.h:150
nonnull instancetype pre47DefaultSettings()
Convenience method to retrieve default settings as they were before ScanditSDK 4.7.
Holds settings that affect the recognition of barcodes, such as enabled barcode symbologies, scanning hot spot etc.
Definition: SBSScanSettings.h:29
nonnull NSSet< NSNumber * > * enabledSymbologies()
Returns the set of enabled symbologies.
SBSSymbology
Enumerates the symbologies supported by Scandit Barcode Scanner.
Definition: SBSCode.h:44
nonnull instancetype defaultSettings()
Settings object with default values.
float relativeZoom
Definition: SBSScanSettings.h:187
SBSWorkingRange workingRange
The focus working range for the barcode picker.
Definition: SBSScanSettings.h:70
BOOL restrictedAreaScanningEnabled
Definition: SBSScanSettings.h:264
NSInteger codeDuplicateFilter
Specifies the duplicate filter to use for the session.
Definition: SBSScanSettings.h:165
Scanning area settings control where codes are to be searched in images/frames.
Definition: SBSScanAreaSettings.h:86
NSString * deviceName
Definition: SBSScanSettings.h:209
NSInteger codeCachingDuration
Determines how long codes are kept in the session.
Definition: SBSScanSettings.h:179
SBSCameraFacingDirection cameraFacingPreference
The preferred camera direction.
Definition: SBSScanSettings.h:200
BOOL highDensityModeEnabled
Definition: SBSScanSettings.h:223
SBSWorkingRange
Definition: SBSCommon.h:63
CGPoint scanningHotSpot
Defines the point at which barcodes and 2D codes are expected.
Definition: SBSScanSettings.h:276