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

<SBSMatrixScanOverlay> Protocol Reference

Inherited by SBSSimpleMatrixScanOverlay, and SBSViewBasedMatrixScanOverlay.

Instance Methods

(void) - removeAllAugmentations
 
(void) - addCode:withIdentifier:
 
(void) - updateCode:withIdentifier:
 
(void) - removeCodeWithIdentifier:
 

Properties

SBSBarcodePickerpicker
 

Detailed Description

The protocol overlays need to conform to.

MatrixScan's overlays should conform to this protocol in order to be added via the SBSMatrixScanHandler#addOverlay: method. SBSSimpleMatrixScanOverlay and SBSViewBasedMatrixScanOverlay both conform to this protocol. In general, it should not be necessary to create a custom overlay.

Since
5.9.0

Method Documentation

- (void) removeAllAugmentations

Remove augmentations that are part of the MatrixScanOverlay.

Since
5.9.0
- (void) addCode: (SBSTrackedCode *)  code
withIdentifier: (NSNumber *)  identifier 

Add a new augmentation for the given code.

The new augmentation should have an identifier equal to the given id.

Parameters
codeSBSTrackedCode to be used to generate the new augmentation.
identifierIdentifier for the new augmentation.
Since
5.9.0
- (void) updateCode: (SBSTrackedCode *)  code
withIdentifier: (NSNumber *)  identifier 

Update (recreate) an existing augmentation with given id for the given code.

Parameters
codeSBSTrackedCode to be used to recreate the augmentation.
identifierIdentifier of an augmentation that should be updated.
Since
5.9.0
- (void) removeCodeWithIdentifier: (NSNumber *)  identifier

Remove an existing augmentation with the given identifier from the MatrixScanOverlay.

Parameters
identifierIdentifier of an augmentation that should be removed.
Since
5.9.0

Property Documentation

- (SBSBarcodePicker*) picker
readwritenonatomicweak

The SBSBarcodePicker instance.

Since
5.9.0

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