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

ScanditSDKBarcodePicker.h
Go to the documentation of this file.
1 
9 #import "SBSScanSession.h"
10 #import "SBSCommon.h"
11 #import "SBSBarcodePickerBase.h"
13 
14 @class SBSScanSettings;
16 
17 
18 
34 - (void)scanditSDKBarcodePicker:(ScanditSDKBarcodePicker*)scanditSDKBarcodePicker
35  didCaptureImage:(NSData*) image
36  withHeight:(int)height
37  withWidth:(int)width;
38 @end
39 
40 
41 
42 
82 
91 @property (nonatomic, strong) ScanditSDKOverlayController *overlayController;
92 
103 @property (nonatomic, assign) CGSize size SBS_DEPRECATED;
104 
105 
106 
110 
123 - (instancetype)initWithAppKey:(NSString *)appKey;
124 
137 - (instancetype)initWithAppKey:(NSString *)appKey
138  cameraFacingPreference:(SBSCameraFacingDirection)facing;
139 
154 - (instancetype)initWithAppKey:(NSString *)appKey
155  cameraFacingPreference:(SBSCameraFacingDirection)facing
156  workingRange:(SBSWorkingRange)workingRange;
157 
159 
162 
171 - (BOOL)isScanning;
172 
173 
182 - (void)startScanning;
183 
191 - (void)stopScanning;
192 
204 
211 - (void)stopScanningAndFreeze;
212 
214 
223 - (void)reset SBS_DEPRECATED;
225 
226 
230 
238 - (void)setDeviceName:(NSString *)deviceName;
240 
241 
245 
272 - (void)setActiveScanningArea:(CGRect)rect forOrientation:(SBSOrientation)orientation;
273 
287 - (CGRect)activeScanningAreaForOrientation:(SBSOrientation)orientation;
288 
305 - (void)restrictActiveScanningArea:(BOOL)enabled;
306 
333 - (void)setScanningHotSpotToX:(float)x andY:(float)y;
334 
353 - (void)setScanningHotSpotHeight:(float)height;
354 
370 - (void)setMicroDataMatrixEnabled:(BOOL)enabled;
371 
382 - (void)setInverseDetectionEnabled:(BOOL)enabled;
383 
396 - (void)setMotionCompensationEnabled:(BOOL)enabled;
397 
401 - (void)setHighDensityModeEnabled:(BOOL)enabled;
402 
416 - (void)force2dRecognition:(BOOL)force;
418 
419 
423 
438 - (void)set1DScanningEnabled:(BOOL)enabled SBS_DEPRECATED;
439 
453 - (void)set2DScanningEnabled:(BOOL)enabled SBS_DEPRECATED;
454 
464 - (void)setEan13AndUpc12Enabled:(BOOL)enabled;
465 
475 - (void)setEan8Enabled:(BOOL)enabled;
476 
486 - (void)setUpceEnabled:(BOOL)enabled;
487 
499 - (void)setCode39Enabled:(BOOL)enabled;
500 
512 - (void)setCode93Enabled:(BOOL)enabled;
513 
525 - (void)setCode128Enabled:(BOOL)enabled;
526 
538 - (void)setItfEnabled:(BOOL)enabled;
539 
551 - (void)setMsiPlesseyEnabled:(BOOL)enabled;
552 
565 - (void)setMsiPlesseyChecksumType:(SBSMsiPlesseyChecksumType)type;
566 
578 - (void)setGS1DataBarEnabled:(BOOL)enabled;
579 
591 - (void)setGS1DataBarExpandedEnabled:(BOOL)enabled;
592 
603 - (void)setCodabarEnabled:(BOOL)enabled;
604 
615 - (void)setCode11Enabled:(BOOL)enabled;
616 
626 - (void)setQrEnabled:(BOOL)enabled;
627 
640 - (void)setDataMatrixEnabled:(BOOL)enabled;
641 
654 - (void)setPdf417Enabled:(BOOL)enabled;
655 
668 - (void)setAztecEnabled:(BOOL)enabled;
669 
680 - (void)setMaxiCodeEnabled:(BOOL)enabled;
681 
694 - (void)setTwoDigitAddOnEnabled:(BOOL)enabled;
695 
708 - (void)setFiveDigitAddOnEnabled:(BOOL)enabled;
709 
720 - (void)setGS1DatabarLimitedEnabled:(BOOL)enabled;
721 
722 
734 - (void)setMaxNumCodesPerFrame:(int)num;
735 
737 
738 
739 
743 
756 - (void)sendNextFrameToDelegate:(id<ScanditSDKNextFrameDelegate>)delegate;
757 
759 
760 
761 
762 
763 
767 
788 + (void)prepareWithAppKey:(NSString *)scanditSDKAppKey SBS_DEPRECATED;
789 
809 + (void)prepareWithAppKey:(NSString *)scanditSDKAppKey
810  cameraFacingPreference:(CameraFacingDirection)facing SBS_DEPRECATED;
811 
828 + (void)prepareWithAppKey:(NSString *)scanditSDKAppKey
829  cameraFacingPreference:(CameraFacingDirection)facing
830  workingRange:(WorkingRange)range SBS_DEPRECATED;
831 
847 
860 
861 
862 
863 
865 
866 @end
867 
868 
ScanditSDKOverlayController * overlayController
The overlay controller controls the scan user interface.
Definition: ScanditSDKBarcodePicker.h:91
SBSOrientation
Definition: SBSCommon.h:48
SBSCameraFacingDirection
Definition: SBSCommon.h:38
void reset()
Resets the state of the barcode picker.
void stopScanningAndKeepTorchState()
Stops the scanning process but keeps the torch on if it is already turned on.
Holds settings that affect the recognition of barcodes, such as enabled barcode symbologies, scanning hot spot etc.
Definition: SBSScanSettings.h:29
void forceRelease()
Forces the release of the barcode picker and all attached objects.
void stopScanningAndFreeze()
Stops the scanning process and stops the camera feed, freezing it. This will result in a reset of the...
controls the scan screen user interface.
Definition: ScanditSDKOverlayController.h:95
#define SBS_DEPRECATED
Definition: SBSCommon.h:9
SBSMsiPlesseyChecksumType
Enumeration of different MSI Checksums.
Definition: SBSCommon.h:92
void stopScanning()
Stops the scanning process.
protocol to receive individual frame from barcode picker
Definition: ScanditSDKBarcodePicker.h:24
void startScanning()
Starts/restarts the scanning process.
Acquires camera frames, decodes barcodes in those camera frames and updates the ScanditSDKOverlayCont...
Definition: ScanditSDKBarcodePicker.h:81
BOOL isScanning()
Returns YES if scanning is in progress.
SBSWorkingRange
Definition: SBSCommon.h:63
Implements the base functionality for the pre-4.7 and 4.7+ picker.
Definition: SBSBarcodePickerBase.h:22
void disableStandbyState()
Prevents the camera from entering a standby state after the barcode picker object is deallocated...
CGSize size
The size of the scan user interface.
Definition: ScanditSDKBarcodePicker.h:103