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

SBSScanAreaSettings.h
Go to the documentation of this file.
1 //
2 // SBSScanAreaSettings.h
3 // ScanditBarcodeScanner
4 //
5 // Created by Marco Biasini on 27/09/16.
6 // Copyright © 2016 Scandit AG. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #import <CoreGraphics/CoreGraphics.h>
11 
12 #import "SBSCommon.h"
13 
40 
48 
69 
93 @interface SBSScanAreaSettings : NSObject
94 
95 
101 +(nonnull instancetype)defaultPortraitSettings;
102 
103 
109 +(nonnull instancetype)defaultLandscapeSettings;
110 
129 + (nullable instancetype)settingsWithDictionary:(nonnull NSDictionary<NSString *, id> *)dict
130  error:(NSError * _Nullable * _Nullable)error;
131 
139 @property (assign, nonatomic) CGRect searchArea;
140 
146 @property (assign, nonatomic) CGRect wideCodesLocationArea;
147 
154 
160 @property (assign, nonatomic) CGRect squareCodesLocationArea;
161 
168 
179 @property (assign, nonatomic) SBSDirection primaryDirection;
180 
181 
182 @end
Decoding is restricted to this area.
Definition: SBSScanAreaSettings.h:30
CGRect squareCodesLocationArea
Code location area for square codes.
Definition: SBSScanAreaSettings.h:160
#define SBS_ENUM_END(name)
Definition: SBSCommon.h:17
The area can be defined but will not be used by the barcode scanner.
Definition: SBSScanAreaSettings.h:46
CGRect wideCodesLocationArea
Code location area for wide codes.
Definition: SBSScanAreaSettings.h:146
nonnull instancetype defaultPortraitSettings()
Returns a new instance with default settings for portrait scanning.
SBSDirection
An enum describing possible directions on the screen.
Definition: SBSScanAreaSettings.h:54
SBSCodeLocationConstraint wideCodesLocationConstraint
Code location constraint for wide codes.
Definition: SBSScanAreaSettings.h:153
CGRect searchArea
The area in which codes are searched.
Definition: SBSScanAreaSettings.h:139
Vertical direction.
Definition: SBSScanAreaSettings.h:67
Scanning area settings control where codes are to be searched in images/frames.
Definition: SBSScanAreaSettings.h:93
SBSCodeLocationConstraint
Code location constraint.
Definition: SBSScanAreaSettings.h:22
The code location area is a hint.
Definition: SBSScanAreaSettings.h:39
Horizontal direction.
Definition: SBSScanAreaSettings.h:60
nonnull instancetype defaultLandscapeSettings()
Returns a new instance with default settings for landscape scanning.
SBSCodeLocationConstraint squareCodesLocationConstraint
Code location constraint for square codes.
Definition: SBSScanAreaSettings.h:167
SBSDirection primaryDirection
The primary direction to be used for scanning.
Definition: SBSScanAreaSettings.h:179
#define SBS_ENUM_BEGIN(name)
Definition: SBSCommon.h:16