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 Class Reference

Inherits NSObject.

Instance Methods

(instancetype) - initWithPicker:
 
(instancetype) - NS_UNAVAILABLE
 
(void) - addOverlay:
 
(void) - removeOverlay:
 
(void) - removeAllAugmentations
 
(void) - beep
 

Class Methods

(instancetype) + NS_UNAVAILABLE
 

Properties

id< SBSMatrixScanDelegatedelegate
 
BOOL recognizedOnly
 
BOOL enabled
 
BOOL beepOnNewCode
 

Detailed Description

An high-level abstraction of the Scandit Matrix Scan.

This class can be used to track multiple barcodes simultaneously and to draw multiple augmentations on top of the detected barcodes.

Since
5.9.0

Method Documentation

+ (instancetype) NS_UNAVAILABLE
- (instancetype) initWithPicker: (nullable SBSBarcodePicker *)  picker

SBSMatrixScanHandler desginated initializer.

Parameters
pickerUnderlying SBSBarcodePicker to be used by SBSMatrixScanHandler.
Since
5.9.0
- (instancetype) NS_UNAVAILABLE
- (void) addOverlay: (UIView< SBSMatrixScanOverlay > *)  overlay

Add a SBSMatrixScanOverlay on top of the picker.

Parameters
overlayThe overlay that needs to be added on top of the picker.
Since
5.9.0
- (void) removeOverlay: (UIView< SBSMatrixScanOverlay > *)  overlay

Remove the given overlay.

Parameters
overlayThe overlay that needs to be removed.
Since
5.9.0
- (void) removeAllAugmentations

Remove all augmentations of every overlay.

This method will call the SBSMatrixScanOverlay.removeAllAugmentations method on every overlay.

Since
5.9.0
- (void) beep

Programmatically trigger a beep sound.

Since
5.9.0

Property Documentation

- (id<SBSMatrixScanDelegate>) delegate
readwritenonatomicweak

The delegate invoked when a new frame is proccessed.

Since
5.9.0
- (BOOL) recognizedOnly
readwritenonatomicassign

Set to YES if only recognized barcodes will be tracked by the matrix scan. Default is YES.

Since
5.9.0
- (BOOL) enabled
readwritenonatomicassign

Set to NO if you want to stop moving/updating the augmentations. Default is YES.

Since
5.9.0
- (BOOL) beepOnNewCode
readwritenonatomicassign

Set to YES to beep whenever a new code is recognized. Default is NO.

Since
5.9.0

The documentation for this class was generated from the following file: