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

<ScanditSDKOverlayControllerDelegate> Protocol Reference

Instance Methods

(void) - scanditSDKOverlayController:didScanBarcode:
 
(void) - scanditSDKOverlayController:didCancelWithStatus:
 
(void) - scanditSDKOverlayController:didManualSearch:
 

Detailed Description

protocol to handle barcode scan, cancel and manual search events.

Since
1.0.0

Method Documentation

- (void) scanditSDKOverlayController: (ScanditSDKOverlayController *)  overlayController
didScanBarcode: (NSDictionary *)  barcode 

Is called when a barcode is successfully decoded.

The dictionary contains two key-value pairs.

key: "barcode" value: barcode data decoded (as UTF8 encoded NSString)

key: "symbology" value: the symbology of the barcode decoded. The following barcode symbology identifiers are returned:

"EAN8", "EAN13", "UPC12", "UPCE", "CODE128", "GS1-128", "CODE39", "CODE93", "ITF", "MSI", "CODABAR", "GS1-DATABAR", "GS1-DATABAR-EXPANDED", "QR", "GS1-QR", "DATAMATRIX", "GS1-DATAMATRIX", "PDF417"

Since
1.0.0
Parameters
overlayControllerScanditSDKOverlayController that is delegating
barcodedictionary with two key value pairs ("barcode","symbology")
- (void) scanditSDKOverlayController: (ScanditSDKOverlayController *)  overlayController
didCancelWithStatus: (NSDictionary *)  status 

Is called when the user clicks the cancel button in the scan user interface.

Since
1.0.0
Parameters
overlayControllerScanditSDKOverlayController that is delegating
statusdictionary (currently empty)
- (void) scanditSDKOverlayController: (ScanditSDKOverlayController *)  overlayController
didManualSearch: (NSString *)  text 

Is called when the search bar is shown and the user enters a search term manually.

Since
1.0.0
Parameters
overlayControllerScanditSDKOverlayController that is delegating
textmanual search input encoded as an NSString

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