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

SBSBarcodePicker.h
Go to the documentation of this file.
1 //
2 // SBSBarcodePicker.h
3 // ScanditBarcodeScanner
4 //
5 // Created by Marco Biasini on 12/06/15.
6 // Copyright (c) 2015 Scandit AG. All rights reserved.
7 //
8 
10 #import "SBSPropertyObserver.h"
11 
12 @class SBSScanSession;
13 @class SBSScanSettings;
14 @class SBSBarcodePicker;
15 
23 
41 - (void)barcodePicker:(nonnull SBSBarcodePicker*)barcodePicker
42  didProcessFrame:(nonnull CMSampleBufferRef)frame
43  session:(nonnull SBSScanSession*)session;
44 @end
45 
55 @protocol SBSScanDelegate
56 
73 - (void)barcodePicker:(nonnull SBSBarcodePicker*)picker didScan:(nonnull SBSScanSession*)session;
74 
75 @end
76 
77 
119 
133 @property (nonatomic, assign) UIInterfaceOrientationMask allowedInterfaceOrientations;
134 
135 
152 - (nonnull instancetype)initWithSettings:(nullable SBSScanSettings *)settings;
153 
154 
157 
173 - (void)applyScanSettings:(nonnull SBSScanSettings*)settings
174  completionHandler:(nullable void (^)())handler;
175 
177 
178 @property (nullable, nonatomic, weak) id<SBSProcessFrameDelegate> processFrameDelegate;
179 
189 @property (nullable, nonatomic, weak) id<SBSScanDelegate> scanDelegate;
190 
201 - (void)addPropertyObserver:(nullable id<SBSPropertyObserver>)observer;
202 
212 - (void)removePropertyObserver:(nullable id<SBSPropertyObserver>)observer;
213 
222 @property (nonnull, nonatomic, strong) SBSOverlayController *overlayController;
223 
224 
227 
240 - (void)startScanning;
241 
257 - (void)startScanningInPausedState:(BOOL)paused;
258 
277 - (void)startScanningInPausedState:(BOOL)paused completionHandler:(nullable void (^)())handler;
278 
289 - (void)stopScanningWithCompletionHandler:(nullable void (^)())handler;
290 
300 - (void)stopScanning;
301 
315 - (void)resumeScanning;
316 
332 - (void)resumeScanningWithCompletionHandler:(nullable void (^)())handler;
333 
334 
335 
347 - (void)pauseScanning;
348 
349 
363 - (void)pauseScanningWithCompletionHandler:(nullable void (^)())handler;
364 
365 
367 
368 
371 
389 - (CGPoint)convertPointToPickerCoordinates:(CGPoint)point;
390 
392 
393 
394 
395 @end
void resumeScanning()
Resume scanning codes.
void pauseScanning()
Pause scanning but keep preview on.
Controls the camera and orchestrates the barcode scanning process.
Definition: SBSBarcodePicker.h:118
controls the scan screen user interface.
Definition: SBSOverlayController.h:92
id< SBSScanDelegate > scanDelegate
The scan delegate for this barcode picker.
Definition: SBSBarcodePicker.h:189
Holds settings that affect the recognition of barcodes, such as enabled barcode symbologies, scanning hot spot etc.
Definition: SBSScanSettings.h:29
Defines the Protocol for a scan event delegate.
Definition: SBSBarcodePicker.h:55
void startScanning()
Starts/restarts the camera and the scanning process.
Protocol for accessing the processed sample buffers.
Definition: SBSBarcodePicker.h:22
Holds all barcodes that were decoded in the current session.
Definition: SBSScanSession.h:37
id< SBSProcessFrameDelegate > processFrameDelegate
Definition: SBSBarcodePicker.h:178
SBSOverlayController * overlayController
The overlay controller controls the scan user interface.
Definition: SBSBarcodePicker.h:222
UIInterfaceOrientationMask allowedInterfaceOrientations
Orientations that the barcode picker is allowed to rotate to.
Definition: SBSBarcodePicker.h:133
void stopScanning()
Stop scanning and the video preview.
Implements the base functionality for the pre-4.7 and 4.7+ picker.
Definition: SBSBarcodePickerBase.h:22