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 
190 @property (nullable, nonatomic, weak) id<SBSScanDelegate> scanDelegate;
191 
202 @property (nullable, nonatomic, weak) id<SBSProcessFrameDelegate> processFrameDelegate;
203 
214 - (void)addPropertyObserver:(nullable id<SBSPropertyObserver>)observer;
215 
225 - (void)removePropertyObserver:(nullable id<SBSPropertyObserver>)observer;
226 
235 @property (nonnull, nonatomic, strong) SBSOverlayController *overlayController;
236 
237 
240 
253 - (void)startScanning;
254 
270 - (void)startScanningInPausedState:(BOOL)paused;
271 
290 - (void)startScanningInPausedState:(BOOL)paused completionHandler:(nullable void (^)())handler;
291 
302 - (void)stopScanningWithCompletionHandler:(nullable void (^)())handler;
303 
313 - (void)stopScanning;
314 
328 - (void)resumeScanning;
329 
345 - (void)resumeScanningWithCompletionHandler:(nullable void (^)())handler;
346 
347 
348 
360 - (void)pauseScanning;
361 
362 
376 - (void)pauseScanningWithCompletionHandler:(nullable void (^)())handler;
377 
378 
380 
381 
384 
402 - (CGPoint)convertPointToPickerCoordinates:(CGPoint)point;
403 
405 
406 
407 
408 @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:103
id< SBSScanDelegate > scanDelegate
The scan delegate for this barcode picker.
Definition: SBSBarcodePicker.h:190
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:39
id< SBSProcessFrameDelegate > processFrameDelegate
The process frame delegate for this barcode picker.
Definition: SBSBarcodePicker.h:202
SBSOverlayController * overlayController
The overlay controller controls the scan user interface.
Definition: SBSBarcodePicker.h:235
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