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
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
CSBSBarcodeGenerator | A barcode generator |
CSBSBarcodePicker | Controls the camera and orchestrates the barcode scanning process |
CSBSBarcodePicker(TextRecognition) | |
CSBSBarcodePickerManager | Manages a barcode picker instance, allocating and releasing it dependent on need |
CSBSBarcodePickerView | Wraps an SBSBarcodePicker instance, exposing simple settings through the Interface Builder |
CSBSCharacterSet | |
CSBSCode | Represents a recognized/localized barcode/2D code |
CSBSEncodingRange | An encoding range for the barcode generator. Specifies the encoding and the start and end index of the data to be encoded to specify which range the encoding should be used |
CSBSFrame | An extended abstraction of a frame that is being processed by the SBSMatrixScanHandler |
CSBSLicense | Holds settings that are needed to verify a Scandit Barcode Scanner license |
C<SBSLicenseValidationDelegate> | |
C<SBSMatrixScanDelegate> | The protocol used by SBSMatrixScanHandler instance |
CSBSMatrixScanHandler | An high-level abstraction of the Scandit Matrix Scan |
C<SBSMatrixScanOverlay> | The protocol overlays need to conform to |
CSBSOverlayController | Controls the scan screen user interface |
C<SBSOverlayControllerDidCancelDelegate> | Protocol cancel events |
CSBSParser | Defines the interface for a data string parser. Parsers are capable of parsing one particular data format, which is passed to them during construction |
CSBSParserField | A particular parsed field |
CSBSParserResult | Holds the result of a successfully parsed data string |
C<SBSProcessFrameDelegate> | Protocol for accessing the processed sample buffers |
CSBSQuadrilateral | Quadrilateral represented by 4 corners |
CSBSScanAreaSettings | Scanning area settings control where codes are to be searched in images/frames |
CSBSScanCase | Start a scanner for the Scandit case |
C<SBSScanCaseDelegate> | Calls the Protocol for events fired by SBSScanCase, e.g. when new codes are scanned |
CSBSScanCaseSession | Holds all barcodes that were decoded in the current session |
CSBSScanCaseSettings | Holds settings that affect the recognition of barcodes (e.g. enabled barcode symbologies) |
C<SBSScanDelegate> | Defines the Protocol for a scan event delegate |
CSBSScanSession | Holds all barcodes that were decoded in the current session |
CSBSScanSettings | Holds settings that affect the recognition of barcodes, such as enabled barcode symbologies, scanning hot spot etc |
CSBSScanSettings(TextRecognition) | |
CSBSSimpleMatrixScanOverlay | A simple implementation of the abstract SBSMatrixScanOverlay class, that draws colorful, rectangle overlays on top of tracked barcodes |
C<SBSSimpleMatrixScanOverlayDelegate> | Protocol used to set the color of an augmentation or to react when an augmentation is touched |
CSBSSymbologySettings | Holds settings specific to a single symbology such as checksums and active symbol count |
C<SBSTextRecognitionDelegate> | |
CSBSTextRecognitionSettings | |
CSBSTrackedCode | Represents a recognized/localized barcode/2D code that is being tracked over multiple frames |
CSBSViewBasedMatrixScanOverlay | An implementation of MatrixScanOverlay, that uses UIView class instances as augmentations for all of the tracked barcodes |
C<SBSViewBasedMatrixScanOverlayDelegate> | Protocol used to change the view corresponding to |