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 "SBSScanCaseState.h"
13 
14 @class SBSScanCaseSettings;
15 @protocol SBSScanCaseDelegate;
16 
42 @interface SBSScanCase : NSObject
43 
53 @property (nonatomic, weak, readwrite, nullable) id<SBSScanCaseDelegate> delegate;
54 
68 @property (nonatomic, assign, readwrite) SBSScanCaseState state;
69 
82 @property (nonatomic, assign, readwrite) BOOL volumeButtonToScanEnabled;
83 
103 + (nonnull instancetype)acquireWithSettings:(nullable SBSScanCaseSettings *)settings delegate:(nullable id<SBSScanCaseDelegate>)delegate;
104 
122 - (nonnull instancetype)initWithSettings:(nullable SBSScanCaseSettings *)settings delegate:(nullable id<SBSScanCaseDelegate>)delegate SBS_DESIGNATED_INITIALIZER;
123 
142 - (nonnull instancetype)initWithSettings:(nullable SBSScanCaseSettings *)settings;
143 
157 - (void)applySettings:(nonnull SBSScanCaseSettings *)settings completionHandler:(nullable void (^)())completionHandler;
158 
177 - (void)setTimeout:(NSTimeInterval)timeout fromState:(SBSScanCaseState)fromState toState:(SBSScanCaseState)toState;
178 
197 - (void)setTimeout:(NSTimeInterval)timeout tolerance:(NSTimeInterval)tolerance fromState:(SBSScanCaseState)fromState toState:(SBSScanCaseState)toState;
198 
208 - (void)removeTimeoutFromState:(SBSScanCaseState)fromState;
209 
217 @property (nonnull, nonatomic, readonly, strong) UIViewController *cameraPreview;
218 
219 @end
id< SBSScanCaseDelegate > delegate
The delegate for this scan case.
Definition: SBSScanCase.h:53
SBSScanCaseState
Definition: SBSScanCaseState.h:18
Start a scanner for the Scandit case.
Definition: SBSScanCase.h:42
Holds settings that affect the recognition of barcodes (e.g. enabled barcode symbologies).
Definition: SBSScanCaseSettings.h:22
Calls the Protocol for events fired by SBSScanCase, e.g. when new codes are scanned.
Definition: SBSScanCaseDelegate.h:25
BOOL volumeButtonToScanEnabled
Turn on/off scanning via the volume button.
Definition: SBSScanCase.h:82
SBSScanCaseState state
The state of the scan case.
Definition: SBSScanCase.h:68
UIViewController * cameraPreview
The camera preview.
Definition: SBSScanCase.h:217