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

Go to the documentation of this file.
1 //
2 // SBSScanSession.h
3 // BarcodeScanner
4 //
5 // Created by Marco Biasini on 20/05/15.
6 // Copyright (c) 2015 Scandit AG. All rights reserved.
7 //
9 #import <Foundation/Foundation.h>
11 @class SBSCode;
12 @class SBSTrackedCode;
39 @interface SBSScanSession : NSObject
44 @property (nonnull, readonly, nonatomic, copy) NSArray<SBSCode *> *newlyRecognizedCodes;
50 @property (nonnull, readonly, nonatomic, copy) NSArray<SBSCode *> *newlyLocalizedCodes;
65 @property (nonnull, readonly, nonatomic, copy) NSArray<SBSCode *> *allRecognizedCodes;
81 @property (nullable, readonly, nonatomic, copy) NSDictionary<NSNumber *, SBSTrackedCode *> *trackedCodes;
90 - (void)clear;
105 - (void)pauseScanning;
113 - (void)stopScanning;
136 - (void)rejectCode:(nonnull SBSCode *)code;
153 - (void)rejectTrackedCode:(nonnull SBSTrackedCode *)trackedCode;
155 @end
NSArray< SBSCode * > * allRecognizedCodes
Returns the list of barcodes (data, symbology) that have been decoded (recognized) in this session...
Definition: SBSScanSession.h:65
Represents a recognized/localized barcode/2D code.
Definition: SBSCode.h:259
void clear()
Remove all codes from the scan session.
NSArray< SBSCode * > * newlyLocalizedCodes
A new copy of the list of barcodes that have been localized but not recognized in the last frame...
Definition: SBSScanSession.h:50
Holds all barcodes that were decoded in the current session.
Definition: SBSScanSession.h:39
void stopScanning()
Immediately stop barcode recognition and close camera.
void pauseScanning()
Immediately pauses barcode recognition, but keeps camera preview open.
NSArray< SBSCode * > * newlyRecognizedCodes
A new copy of the list of barcodes that have been successfully decoded in the last frame...
Definition: SBSScanSession.h:44
NSDictionary< NSNumber *, SBSTrackedCode * > * trackedCodes
Returns a dictionary representing a map between tracked object identifiers and tracked objects...
Definition: SBSScanSession.h:81
Represents a recognized/localized barcode/2D code that is being tracked over multiple frames...
Definition: SBSTrackedCode.h:18