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
Inherits UIView, and <SBSMatrixScanOverlay>.
Instance Methods | |
(void) | - setColor:forCodeWithIdentifier: |
(void) | - setAllAugmentationColors: |
(void) | - removeAllAugmentations |
(void) | - addCode:withIdentifier: |
(void) | - updateCode:withIdentifier: |
(void) | - removeCodeWithIdentifier: |
Properties | |
id< SBSSimpleMatrixScanOverlayDelegate > | delegate |
BOOL | userTapEnabled |
SBSBarcodePicker * | picker |
Detailed Description
A simple implementation of the abstract SBSMatrixScanOverlay class, that draws colorful, rectangle overlays on top of tracked barcodes.
- Since
- 5.9.0
Method Documentation
- (void) setColor: | (UIColor *) | color | |
forCodeWithIdentifier: | (NSNumber *) | identifier | |
Change the color of the augmentation corresponding to the given identifier.
- Parameters
-
color The color for the augmentation. identifier The barcode identifier.
- Since
- 5.9.0
- (void) setAllAugmentationColors: | (UIColor *) | color |
Change the color of all augmentations.
- Parameters
-
color Color for the augmentations.
- Since
- 5.9.0
- (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
-
code SBSTrackedCode to be used to generate the new augmentation. identifier Identifier 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
-
code SBSTrackedCode to be used to recreate the augmentation. identifier Identifier 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
-
identifier Identifier of an augmentation that should be removed.
- Since
- 5.9.0
Property Documentation
|
readwritenonatomicweak |
The delegate invoked to set the color of an augmentation and when an augmentation is tapped.
- Since
- 5.9.0
|
readwritenonatomicassign |
Set to YES to make augmentations tappable. Default is NO.
- Since
- 5.9.0
|
readwritenonatomicweakinherited |
The SBSBarcodePicker instance.
- Since
- 5.9.0
The documentation for this class was generated from the following file: