Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

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 "SBSSymbologySettings.h"
12 #import "SBSCommon.h"
13 
28 @interface SBSScanSettings : NSObject<NSCopying>
29 
35 + (nonnull instancetype)defaultSettings;
36 
49 + (nonnull instancetype)pre47DefaultSettings;
50 
51 
59 + (nullable instancetype)settingsWithDictionary:(nonnull NSDictionary<NSString *, NSObject *> *)dict
60  error:(NSError * _Nullable * _Nullable)error;
61 
69 @property (nonatomic, assign) SBSWorkingRange workingRange;
70 
84  - (void)enableSymbologies:(nonnull NSSet<NSNumber *> *)symbologies;
85 
114 - (void)setSymbology:(SBSSymbology)symbology enabled:(BOOL)enabled;
115 
119 - (nonnull NSSet<NSNumber *> *)enabledSymbologies;
120 
129 - (nonnull SBSSymbologySettings *)settingsForSymbology:(SBSSymbology)symbology;
130 
140 @property (nonatomic, assign) BOOL force2dRecognition;
141 
149 @property (nonatomic, assign) NSInteger maxNumberOfCodesPerFrame;
150 
164 @property (nonatomic, assign) NSInteger codeDuplicateFilter;
165 
178 @property (nonatomic, assign) NSInteger codeCachingDuration;
179 
183  @property (nonatomic, assign) float relativeZoom;
184 
196 @property (nonatomic, assign) SBSCameraFacingDirection cameraFacingPreference;
197 
205 @property (nullable, nonatomic, strong) NSString *deviceName;
206 
219 @property (nonatomic, assign) BOOL highDensityModeEnabled;
220 
234 @property (nonatomic, assign) CGRect activeScanningAreaLandscape;
235 
251 @property (nonatomic, assign) CGRect activeScanningAreaPortrait;
252 
260 @property (nonatomic, assign) BOOL restrictedAreaScanningEnabled;
261 
272 @property (nonatomic, assign) CGPoint scanningHotSpot;
273 
282 - (void)setActiveScanningArea:(CGRect)area;
283 
284 
297 @property (nonatomic, assign) BOOL motionCompensationEnabled;
298 
312 - (void)setProperty:(nonnull NSString *)property toValue:(int)value;
313 
322 @property (nonatomic, assign) BOOL codeRejectionEnabled;
323 
324 @end
CGRect activeScanningAreaPortrait
The active scanning area when the picker is in portrait orientation.
Definition: SBSScanSettings.h:251
CGRect activeScanningAreaLandscape
The active scanning area when the picker is in landscape orientation.
Definition: SBSScanSettings.h:234
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:140
BOOL codeRejectionEnabled
Whether code rejection should be enabled.
Definition: SBSScanSettings.h:322
BOOL motionCompensationEnabled
Enable/disable motion compensation.
Definition: SBSScanSettings.h:297
Holds settings specific to a single symbology such as checksums and active symbol count...
Definition: SBSSymbologySettings.h:66
SBSCameraFacingDirection
Definition: SBSCommon.h:36
NSInteger maxNumberOfCodesPerFrame
The maximum number of barcodes to be decoded every frame.
Definition: SBSScanSettings.h:149
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:28
nonnull NSSet< NSNumber * > * enabledSymbologies()
Returns the set of enabled symbologies.
SBSSymbology
Enumerates the symbologies supported by Scandit Barcode Scanner.
Definition: SBSCode.h:46
nonnull instancetype defaultSettings()
Settings object with default values.
float relativeZoom
Definition: SBSScanSettings.h:183
SBSWorkingRange workingRange
The focus working range for the barcode picker.
Definition: SBSScanSettings.h:69
BOOL restrictedAreaScanningEnabled
Definition: SBSScanSettings.h:260
NSInteger codeDuplicateFilter
Specifies the duplicate filter to use for the session.
Definition: SBSScanSettings.h:164
NSString * deviceName
Definition: SBSScanSettings.h:205
NSInteger codeCachingDuration
Determines how long codes are kept in the session.
Definition: SBSScanSettings.h:178
SBSCameraFacingDirection cameraFacingPreference
The preferred camera direction.
Definition: SBSScanSettings.h:196
BOOL highDensityModeEnabled
Definition: SBSScanSettings.h:219
SBSWorkingRange
Definition: SBSCommon.h:61
CGPoint scanningHotSpot
Defines the point at which barcodes and 2D codes are expected.
Definition: SBSScanSettings.h:272