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

SBSMatrixScanHandler.h
Go to the documentation of this file.
1 //
2 // SBSMatrixScanHandler.h
3 // ScanditBarcodeScanner
4 //
5 // Created by Luca Torella on 01.03.18.
6 // Copyright © 2018 Scandit. All rights reserved.
7 //
8 
9 #import <UIKit/UIKit.h>
10 #import "SBSCommon.h"
11 
12 @protocol SBSMatrixScanDelegate;
13 @protocol SBSMatrixScanOverlay;
14 @class SBSBarcodePicker;
15 
16 NS_ASSUME_NONNULL_BEGIN
17 
25 @interface SBSMatrixScanHandler : NSObject
26 
31 @property (nonatomic, weak, nullable) id<SBSMatrixScanDelegate> delegate;
32 
37 @property (nonatomic, assign) BOOL recognizedOnly;
38 
43 @property (nonatomic, assign) BOOL enabled;
44 
49 @property (nonatomic, assign) BOOL beepOnNewCode;
50 
51 + (instancetype)new NS_UNAVAILABLE;
52 
58 - (instancetype)initWithPicker:(nullable SBSBarcodePicker *)picker SBS_DESIGNATED_INITIALIZER;
59 
60 - (instancetype)init NS_UNAVAILABLE;
61 
67 - (void)addOverlay:(UIView<SBSMatrixScanOverlay> *)overlay;
68 
74 - (void)removeOverlay:(UIView<SBSMatrixScanOverlay> *)overlay;
75 
83 - (void)removeAllAugmentations;
84 
89 - (void)beep;
90 
91 @end
92 
93 NS_ASSUME_NONNULL_END
SBSBarcodePicker
Controls the camera and orchestrates the barcode scanning process.
Definition: SBSBarcodePicker.h:144
SBSCommon.h
-[SBSMatrixScanHandler beep]
void beep()
Programmatically trigger a beep sound.
SBSMatrixScanHandler::beepOnNewCode
BOOL beepOnNewCode
Set to YES to beep whenever a new code is recognized. Default is NO.
Definition: SBSMatrixScanHandler.h:49
SBSMatrixScanHandler
An high-level abstraction of the Scandit Matrix Scan.
Definition: SBSMatrixScanHandler.h:25
SBSMatrixScanDelegate-p
The protocol used by SBSMatrixScanHandler instance.
Definition: SBSMatrixScanDelegate.h:21
-[SBSMatrixScanHandler removeAllAugmentations]
void removeAllAugmentations()
Remove all augmentations of every overlay.
SBSMatrixScanHandler::recognizedOnly
BOOL recognizedOnly
Set to YES if only recognized barcodes will be tracked by the matrix scan. Default is YES...
Definition: SBSMatrixScanHandler.h:37
SBSMatrixScanHandler::enabled
BOOL enabled
Set to NO if you want to stop moving/updating the augmentations. Default is YES.
Definition: SBSMatrixScanHandler.h:43
SBSMatrixScanHandler::delegate
id< SBSMatrixScanDelegate > delegate
The delegate invoked when a new frame is proccessed.
Definition: SBSMatrixScanHandler.h:31
SBSMatrixScanOverlay-p
The protocol overlays need to conform to.
Definition: SBSMatrixScanOverlay.h:26
+[SBSMatrixScanHandler NS_UNAVAILABLE]
instancetype NS_UNAVAILABLE()
Copyright (C) 2019 Scandit AG