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

SBSScanCase.h
Go to the documentation of this file.
1 //
2 // SBSScanCase.h
3 // ScanditBarcodeScanner
4 //
5 // Created by Luca Torella on 17/02/16.
6 // Copyright © 2016 Scandit AG. All rights reserved.
7 //
8 
9 #import <Foundation/Foundation.h>
10 #import <UIKit/UIKit.h>
11 
12 #import "SBSCommon.h"
13 #import "SBSScanCaseState.h"
14 
15 @class SBSScanCaseSettings;
16 @protocol SBSScanCaseDelegate;
17 
43 @interface SBSScanCase : NSObject
44 
54 @property (nonatomic, weak, readwrite, nullable) id<SBSScanCaseDelegate> delegate;
55 
69 @property (nonatomic, assign, readwrite) SBSScanCaseState state;
70 
83 @property (nonatomic, assign, readwrite) BOOL volumeButtonToScanEnabled;
84 
92 @property (nonatomic, assign, readwrite) NSTimeInterval activateDurationAfterVolumeButtonRelease;
93 
94 
95 
96 
116 + (nonnull instancetype)acquireWithSettings:(nullable SBSScanCaseSettings *)settings delegate:(nullable id<SBSScanCaseDelegate>)delegate;
117 
135 - (nonnull instancetype)initWithSettings:(nullable SBSScanCaseSettings *)settings
136  delegate:(nullable id<SBSScanCaseDelegate>)delegate SBS_DESIGNATED_INITIALIZER;
137 
156 - (nonnull instancetype)initWithSettings:(nullable SBSScanCaseSettings *)settings;
157 
171 - (void)applySettings:(nonnull SBSScanCaseSettings *)settings
172  completionHandler:(nullable void (^)())completionHandler;
173 
194 - (void)setTimeout:(NSTimeInterval)timeout
195  fromState:(SBSScanCaseState)fromState
196  toState:(SBSScanCaseState)toState;
197 
216 - (void)setTimeout:(NSTimeInterval)timeout
217  tolerance:(NSTimeInterval)tolerance
218  fromState:(SBSScanCaseState)fromState
219  toState:(SBSScanCaseState)toState;
220 
230 - (void)removeTimeoutFromState:(SBSScanCaseState)fromState;
231 
239 @property (nonnull, nonatomic, readonly, strong) UIViewController *cameraPreview;
240 
250 @property (nonatomic, assign) BOOL scanBeepEnabled;
251 
261 @property (nonatomic, assign) BOOL errorSoundEnabled;
262 
276 - (BOOL)setScanSoundResource:(nonnull NSString *)path ofType:(nonnull NSString *)extension;
277 
294 - (BOOL)setErrorSoundResource:(nonnull NSString *)path ofType:(nonnull NSString *)extension;
295 
296 @end
id< SBSScanCaseDelegate > delegate
The delegate for this scan case.
Definition: SBSScanCase.h:54
SBSScanCaseState
Definition: SBSScanCaseState.h:18
Start a scanner for the Scandit case.
Definition: SBSScanCase.h:43
BOOL errorSoundEnabled
Whether to play an error sound when no code was scanned.
Definition: SBSScanCase.h:261
Holds settings that affect the recognition of barcodes (e.g. enabled barcode symbologies).
Definition: SBSScanCaseSettings.h:22
BOOL scanBeepEnabled
Whether to play a beep sound upon a successful scan.
Definition: SBSScanCase.h:250
Calls the Protocol for events fired by SBSScanCase, e.g. when new codes are scanned.
Definition: SBSScanCaseDelegate.h:25
NSTimeInterval activateDurationAfterVolumeButtonRelease
The duration in seconds for which the scanner should remain in active state after the volume button h...
Definition: SBSScanCase.h:92
BOOL volumeButtonToScanEnabled
Turn on/off scanning via the volume button.
Definition: SBSScanCase.h:83
SBSScanCaseState state
The state of the scan case.
Definition: SBSScanCase.h:69
UIViewController * cameraPreview
The camera preview.
Definition: SBSScanCase.h:239