Changelog for the iOS Barcode Scanner SDK

tip

For additional details about the API, please refer to our API reference documentation.

Version 8.0.0 (13 January 2026)

• 🎉 New:
  • General:
    • The SDK now supports a new license key format, which does not contain special characters or line breaks.
    • SBSDKImageRef constructor now supports HEIC images.
    • Added the possibility for providing custom encryption for individual images from path load / image save operations.
    • Added property cameraLiveScannerResolution to all the RTU-UI v2 screens to control the camera live scanning resolution.
    • Added property keepScreenOn to all RTU-UI v2 screens to prevent the system from going idle or entering the lockscreen while scanning.
    • Added property keepScreenOn to all Classic UI screens (see SBSDKBaseScannerEnergyConfiguration) to prevent the system from going idle or entering the lockscreen while scanning.
    • Added mandatory delegate functions ...scannerViewController(controller:didFailScanning:) to all Classic-UI components.
    • All scanner and generator classes now throw errors instead of returning nil or false in case of failures.
    • Added a read-only property colorString to SBSDKUI2Color to retrieve the color in HEX format or a reference to a palette color.
    • Added functions toRgba() and toArgb() to SBSDKUI2Color to retrieve the color in RGBA and ARGB hex formats.
  • Barcode Scanner:
    • New supported document parser for British Columbia driver licenses PDF417 codes.
    • Introduced a new algorithm for recognizing 1D symbologies, enhancing performance with blurred and distant barcodes. This feature is enabled by default but can be turned off using the enableOneDBlurScanner property in barcode format configurations on low-power devices if necessary.
    • Added a new SBSDKBarcodeScannerEngineMode: nextGenMaxDistance, which is optimized for scanning from far distances on very high-power devices with a 4K video stream.
    • All 1D barcode formats can be configured with a new oneDConfirmationMode which is thorough by default. Setting it to minimal or none could lead to higher recall in difficult scenarios, but could also cause more false positives. See SBSDKOneDConfirmationMode.
• 🚀 Improvements:
  • General:
    • The "Created TensorFlow Lite XNNPACK delegate for CPU." log is no longer an output in production builds.
    • If a global or custom encrypter is set when an image is created from a file, it will be automatically detected if the image is encrypted or not. Note that now encryptionMode is NOT ignored if a custom encrypter/decrypter is used.
    • When creating an SBSDKImageRef from UIImage or from a .png file containing an alpha channel, they are blended with a user specified canvas color instead of simply discarding the alpha channel. It is possible to select whether to use a WHITE or BLACK background in SBSDKRawImageLoadOptions, SBSDKPathImageLoadOptions, and SBSDKBufferImageLoadOptions.
    • Improved error handling and reporting in all scanners, this includes licensing errors, cancellation by user, file I/O errors, image conversion errors, and scanning errors. In case of an error, an SBSDKError is thrown with a descriptive error message and error code.
    • Camera sessions no longer show a black screen in case of license error. Instead, the camera runs but the detection fails with appropriate license error.
    • Classic UI components can now be configured directly by setting the properties of the configuration objects instead of creating new configuration objects.
  • Barcode Scanner:
    • Improved quiet zone checks for the barcode format PharmaCode to reduce the false positive rate.
    • Reduced the false positive rate of blurred barcodes in live mode when the barcode is only partially visible.
• 🐞 Bug fixes:
  • General:
    • SBSDKImageRef: If SBSDKImageRef was created in a lazy mode from an encrypted file and then saved to some location, a simple copy was performed. Because of this, the created file could become invalid if the decryption key depends on location.
    • SBSDKImageRef: If SBSDKImageRef was saved to an already existing location, in some cases it could return an error instead of overwriting the existing file.
    • SBSDKImageRef: Fixed possibility of SBSDKImageRef to be saved as an invalid JPEG (when only part of the image was actually saved).
  • Barcode Scanner:
    • Fixed a bug in Barcode RTU-UI v2 Multiple Scanning Mode where the count of the sheet button was not updated properly.
• ⚠️ Breaking changes:
  • General:
    • API Consistency Improvements: We went through our APIs and made several improvements to make them more consistent and easier to use. The SDK now throws errors instead of returning nil or false in many places. This also affects how you handle results from various operations in the SDK. Please review your error handling code when updating to this version.
    • For 'Scan from Image', SBSDKImageRef is now used as the input and output for all features, and the function is now named run(image:).
    • SBSDKImageRef is now immutable. The clone() method has been removed, and cloning now acquires a new strong reference.
    • SBSDKImageRef: encryptionMode default value has been replaced with AUTO.
    • Changed the completion handlers of all RTU-UI v2 screens to either return a result or an error. Cancellation by user is treated as an error. Check SBSDKError.isCanceled.
    • The default license error handler Scanbot.defaultLicenseFailureHandler no longer tries to display an alert, instead it logs the error to the console.
  • Barcode Scanner:
    • No longer returns crops by default. This can be re-enabled in the configuration.
    • The MicroQrCode barcode format has been removed from the list of common barcode formats.
    • Removed Barcode RTU-UI v1 completely, including SBSDKUIBarcodeScannerViewController, SBSDKUIBarcodesBatchScannerViewController and all related components.
    • Removed SBSDKUI2BarcodeScannerConfiguration and replaced it with SBSDKBarcodeScannerConfiguration in Barcode RTU-UI v2.
    • Removed properties isSelectable and isAutomaticSelectionEnabled from SBSDKBarcodeTrackingOverlayConfiguration.
    • Renamed parameter isSelected to isHighlighted in tracking overlay methods.
    • Changed delegate method signatures in SBSDKBarcodeTrackingOverlayControllerDelegate:
      • Removed didChangeSelectedBarcodes method.
      • Added shouldHighlight method to determine barcode highlighting state.
      • Added proposedStyle parameter to style-related delegate methods.
• 🚙 Under the hood:
  • Upgraded libzueci to 1.0.1.
  • Added snowflake-arctic-embed-xs eadfba3b.

Version 7.1.4 (28 October 2025)

• 🐞 Bug fixes:
  • Barcode Scanner:
    • Fixed truncated text on the back button in the RTU-UI v2 Barcode Scanner screen.

Version 7.1.3 (15 October 2025)

• 🎉 New:
  • Barcode Scanner:
    • Barcode configurations for 1D barcode types have a new field minimumNumberOfRequiredFramesWithEqualRecognitionResult that requires this number of frames on which the barcode has to be detected.
• ⚠️ Breaking changes:
  • Barcode Scanner:
    • The field minConfirmationsStandaloneEAN in SBSDKBarcodeAccumulationConfiguration was moved and renamed to the field minimumNumberOfRequiredFramesWithEqualRecognitionResultExtensionless in SBSDKBarcodeFormatUpcEanConfiguration.

Version 7.1.2 (1 September 2025)

• 🎉 New:
  • General:
    • Added property isInterrupted to SBSDKCameraSession to indicate if the camera session was interrupted by the system.

Version 7.1.0 (24 July 2025)

• 🎉 New:
  • Barcode Scanner:
    • Added new class SBSDKBarcodeItemSelection for managing collections of selected barcode items.
    • Added property identityString to SBSDKBarcodeItem to uniquely identify barcodes across detection frames.
    • SBSDKBarcodeItem has a new field rawBytesEncodings that contains the precise character encoding information of rawBytes.
    • Added property selectedZoomFactor to SBSDKUI2BarcodeScannerUIResult to retrieve the zoom factor used for the barcode scanning.
    • SBSDKBarcodeItem has a new field structuredAppendInfo. The Structured Append mode can be used to split a message across multiple barcodes. If present, the corresponding information is returned.
    • SBSDKBarcodeScannerConfiguration has a new field accumulationConfig which allows the accumulation of barcodes over multiple frames in live mode. SBSDKBarcodeItem has a new field globalIndex which allows identifying a barcode across multiple frames.
  • General:
    • Added property hardwareButtonsEnabled to SBSDKUI2CameraConfiguration. If enabled, it allows zooming using the camera control button (iPhone 16 series).
    • Added property fpsLimit to SBSDKUI2CameraConfiguration and SBSDKUI2DocumentScannerCameraConfiguration to limit the rate of detections per second in normal performance mode.
    • Added property didEndZoomHandler to SBSDKZoomingImageScrollView.
    • Added analytics support with new classes: SBSDKAnalyticsManager, SBSDKAnalyticsEvent, SBSDKAnalyticsFeature, SBSDKAnalyticsCategory, SBSDKAnalyticsEventName, SBSDKAnalyticsEventFactory, and SBSDKAnalyticsSubscriber for tracking and managing SDK usage analytics.
• 🚀 Improvements:
  • Barcode Scanner:
    • Added NSCopying support to SBSDKBarcodeTrackedViewPolygonStyle and SBSDKBarcodeTrackedViewTextStyle.
    • SBSDKBoardingPassBarcodeDocumentParser now supports up to version 8 of the IATA-BCBP standard.
    • vCard document parser was improved.
• 🐞 Bug fixes:
  • Barcode Scanner:
    • The carrier identifier for MaxiCode mode 3 might be encoded by using different codewords. Now all possible codewords are checked.
    • vCard document parser now correctly processes the "FN" key as FormattedName.
    • Fixed a bug in the Barcode Scanner RTU-UI v2 where the result callback was called multiple times.
  • PDF Image Extractor:
    • Fixes wrong orientation of extracted images when the PDF page has a transform applied.
  • Storage Crypting:
    • Fixed data corruption issues in AES encryption/decryption that could result in corrupted or partially corrupted files.
• ⚠️ Breaking changes:
  • Barcode Scanner:
    • Removed properties isSelectable and isAutomaticSelectionEnabled from SBSDKBarcodeTrackingOverlayConfiguration.
    • Renamed parameter isSelected to isHighlighted in tracking overlay methods.
    • Changed delegate method signatures in SBSDKBarcodeTrackingOverlayControllerDelegate:
      • Removed didChangeSelectedBarcodes method.
      • Added shouldHighlight method to determine barcode highlighting state.
      • Added proposedStyle parameter to style-related delegate methods.
  • PDF Image Extractor:
    • Removed parameter scaling from all methods and replaced it by member variable scaleFactor.
  • General:
    • Replaced all occurrences of the deprecated AVCaptureVideoOrientation enum by an equal enum named SBSDKVideoOrientation.
• 🚙 Under the hood:
  • Added flatbuffers 2.0.6.

Version 7.0.2 (27 May 2025)

• 🎉 New:
  • Added properties cameraSessionKeepAliveTimeout and animateCameraOverlay to SBSDKBaseScannerGeneralConfiguration.
  • Added properties sessionDidChangeHandler and isSessionRunning to SBSDKBaseScannerViewController.
  • Added functions pause and resume to SBSDKBaseScannerViewController.
• 🚀 Improvements:
  • GS1 Composite codes are now processed faster in Scan from Image mode.
• 🐞 Bug fixes:
  • Fixed an issue where quickly stopping and starting the camera session of any scanner screen could lead to a crash or unpredictable behavior.
• ⚠️ Breaking changes:
  • Removed property stopsCameraSessionWhenDisappeared from SBSDKBaseScannerGeneralConfiguration. To emulate this behavior, set cameraSessionKeepAliveTimeout to a high value, e.g. TimeInterval.greatestFiniteMagnitude.
• 🚙 Under the hood:
  • Upgraded xtensor to 0.26.0-scanbot.
  • Upgraded xtl to 0.8.
  • Upgraded xsmid to 13.2.
  • Upgraded CLI11 to 2.5.
  • Upgraded spdlog to 1.15.2.
  • Upgraded Boost to 1.88.

Version 7.0.1 (23 April 2025)

• 🎉 New:
  • Added property hardwareButtonsEnabled to SBSDKBaseScannerViewController (all Classic UI) which can be set to false to restore the original volume button behavior.
• 🚀 Improvements:
  • Improved the recognition of PDF417 barcodes in the barcode scanner.
  • Improved the barcode scanner to better recognize the QR codes if the top left finder pattern is corrupted (up to QR code version size 20).
• 🐞 Bug fixes:
  • Fixed an issue when scanning Code93 barcodes with stripCheckDigits = false (default) and the check digit is an extension character.
  • Fixed a crash in the RTU-UI v2 Barcode Scanner when using SBSDKUI2FindAndPickScanningMode.

Version 7.0.0 (26 March 2025):

• 🎉 New:
  • Advanced configuration of Barcode Scanner. See SBSDKBarcodeScannerConfiguration.
  • Added support for barcode types Pharma Code, Pharma Code Two Track, PZN (Pharmazentralnummer).
  • Added support for the HIBC barcode document format.
  • New predefined subsets (1D, 2D, Postal, Pharma, etc.) of barcode formats. See SBSDKBarcodeFormat.
  • Introduced new property optimizeOverlays to SBSDKBarcodeScanner that generates more accurate barcode polygons for usage in tracking overlays.
  • Introduced new barcode engine modes nextGenLowPower, nextGenFarDistance, and nextGenLowPowerFarDistance. See SBSDKBarcodeScannerEngineMode.
  • Ability to configure the Barcode Scanner, its Classic UI and the Scan-and-Count Classic UI using the new setConfiguration(_:) method. See SBSDKBarcodeScanner.setConfiguration(_:),SBSDKBarcodeScannerViewController.setConfiguration(_:),SBSDKBarcodeScanAndCountViewController.setConfiguration(_:).
  • Introduced a new barcode item object to better represent barcode results. See SBSDKBarcodeItem.
  • Ability to get the extractedDocumentFormats from the barcode document parser. See SBSDKBarcodeDocumentParser.init(extractedDocumentFormats:) and SBSDKBarcodeDocumentParser.extractedDocumentFormats.
  • Ability to scan barcodes from frames of type ofSBSDKBaseScannerFrame using the new method SBSDKBarcodeScanner.scan(from: SBSDKBaseScannerFrame, useLiveMode:).
  • Ability to initialize the Barcode Scanner using the new initializer SBSDKBarcodeScanner.init(formats:, live:, extractedDocumentFormats:).
  • Introduced a boolean strictMode for certain barcode configurators. If this mode is disabled, it should allow for a higher detection rate in difficult scenarios, but with the possibility that false positive results may occur. Currently, we support strictMode for QR Code, Micro QR Code, rMQR Code, PDF417, MicroPDF417 and gs1Composite.
  • Introduced SBSDKBarcodeFormats and SBSDKBarcodeFormat that represent the barcode format sets and the individual barcode types respectively.
  • Ability to configure the Barcode Scanner using the common barcode configuration, see SBSDKBarcodeFormatCommonConfiguration.
  • Ability to know when a barcode was last detected using the new property SBSDKBarcodeScannerAccumulatingResult.dateOfLastDetection.
  • Ability to return the barcode image in the result using the new property SBSDKUI2BarcodeScannerConfiguration.returnBarcodeImage.
  • Images returned in scanner results are now represented as image references. See SBSDKImageRef. They can be converted to UIImage objects using the method toUIImage().
  • Ability to process additional frames before they are passed to the main scanner using the new optional property SBSDKBaseScannerViewController.additionalFrameProcessor.
• 🚀 Improvements:
  • More robust QR code recognition, more tolerance for destroyed or missing timing patterns and alignment patterns and a better performance on artistic QR codes.
  • QR codes with non-square finder patterns and QR codes embedded in adversarial backgrounds (flow codes and more generally) can now be recognized.
  • Improved the false positive rate for ITF.
  • Improved quiet zone checks for the barcode formats ITF, Code 11, MSI Plessey, IATA 2 of 5, Industrial 2 of 5 and Code 25.
  • Improved barcode detection for various barcode types.
  • Improved the performance when scanning four state postal barcodes (i.e. Australia Post, Japanese Post, RM4SCC, Royal TNT Post and USPS Intelligent Mail).
  • Improved our Barcode Scanner with a significant speed-up in live mode on very large input resolutions.
  • By default, Code 93 now includes check digits in the result. To disable this and restore the previous behavior, set stripCheckDigits = true.
• 🐞 Bug fixes:
  • Fixed processing of still images of indexed color space model in Barcode Scanner.
  • Fixed a bug in the Barcode Scanner RTU-UI v2 where the flip camera button was not resetting the widest camera available if chosen.
  • Fixed a bug in SBSDKBarcodeScannerViewController that could have lead to a crash when embedded within a UIViewControllerRepresentable.
  • Fixed a bug in the AR Barcode Scan and Count where the scanner would be stuck if there was no barcode detected.
  • Fixed a UI bug in the Barcode Scanner RTU-UI v2 where the sheet button overlapped with the action bar.
  • Fixed the returned results for all types of SBSDKUpcEanExtensionBehavior.
  • Fixed the checksum of the Code 39 barcode format.
• ⚠️ Breaking changes:
  • Removed property code in SBSDKBarcodeScannerAccumulatingResult, use the property item instead.
  • Removed properties acceptedBarcodeTypes, acceptedDocumentTypes, extensionFilter, additionalDetectionParameters, acceptedDocumentTypes, useLiveMode, regularExpressionPattern and engineMode in SBSDKBarcodeScannerViewController, please use the new copyCurrentConfiguration() and setConfiguration(_:) methods, see SBSDKBarcodeScannerConfiguration.
  • Removed initializers init(types:), init(types:liveMode:) and methods detectBarCodes(on: UIImage, in: CGRect), detectBarCodes(on: UIImage, orientation: AVCaptureVideoOrientation, in: CGRect), detectBarCodes(on: CMSampleBuffer, orientation: AVCaptureVideoOrientation, in: CGRect) and detectBarCodes(on: CMSampleBuffer, orientation: AVCaptureVideoOrientation) in SBSDKBarcodeScanner, use the SBSDKBarcodeScannerConfiguration to initialize the scanner, the detect methods have been renamed to scan.
  • Removed enum SBSDKBarcodeImageGenerationType and property barcodeImageGenerationType from SBSDKBarcodeScannerViewController and SBSDKUIBarcodeScannerBehaviorConfiguration.
  • Replaced class SBSDKPolygonEdge with SBSDKLineSegment.
  • Replaced enum SBSDKPolygonEdgeOrientation with SBSDKLineSegmentOrientation.
  • Renamed class SBSDKBarcodeType to SBSDKBarcodeFormat.
  • Renamed class SBSDKBarcodeDocumentRootType to SBSDKBarcodeDocumentFormat.
  • Renamed initializer init(barcodeResult:) to init(barcodeItem:) in SBSDKBarcodeScannerAccumulatingResult.
  • Renamed method barcodeScannerController(_:filterResults:) to barcodeScannerController(_:filterBarcodes:) in SBSDKBarcodeScannerViewControllerDelegate.
  • Renamed class SBSDKUI2BarcodeRecognizerConfiguration to SBSDKBarcodeScannerConfiguration.
  • Renamed class SBSDKUI2BarcodeScannerResult to SBSDKUI2BarcodeScannerUIResult.
  • Changed the initializers init?(parentViewController:parentView:) and init?(parentViewController:parentView:delegate:) to init?(parentViewController:parentView:configuration:) and init?(parentViewController:parentView:configuration:delegate:) in SBSDKBarcodeScannerViewController.
  • Changed all methods of SBSDKBarcodeTrackingOverlayControllerDelegate to use the new SBSDKBarcodeItem object type.
  • Changed the method make(withBarcode:) to use the new SBSDKBarcodeItem in SBSDKTrackedBarcodeInfoViewable.
  • Changed all methods of SBSDKBarcodeScanAndCountViewController to use the new SBSDKBarcodeItem.
  • Changed the initializers init?(parentViewController:parentView:) and init?(parentViewController:parentView:delegate:) to init?(parentViewController:parentView:configuration:) and init?(parentViewController:parentView:configuration:delegate:) in SBSDKBarcodeScanAndCountViewController.
  • Renamed parameter name handler to completion in create and present functions of SBSDKUI2BarcodeScannerViewController.
  • Renamed async function presentAsync(on:configuration) to present(on:configuration) in SBSDKUI2BarcodeScannerViewController.
  • Replaced SBSDKUI2BarcodesExtensionFilter enum for RTU-UI v2 with SBSDKUpcEanExtensionBehavior enum from Barcode Scanner Classic component API.
  • Renamed property barcodesExtensionFilter in SBSDKUI2BarcodeScannerConfiguration to extensions.
  • Renamed class SBSDKBarcodesExtensionFilter to SBSDKUIBarcodesExtensionFilter.
  • Changed the display names of various barcode formats (SBSDKBarcodeFormat.name): Australia Post to Australian Post, CodaBar to Codabar, DataMatrix to Datamatrix, GS1 Databar Limited to Databar Limited, EAN_13 to EAN 13, EAN_8 to EAN 8, IATA 2of5 to IATA 2 of 5, INDUSTRIAL 2of5 to Industrial 2 of 5, MICRO PDF417 to Micro PDF 417, MicroQRCode to Micro QR, QRCode to QR, RMQR Code to RMQR, UPC-A to UPC A, and UPC-E to UPC E.
• 🚙 Under the hood:
  • The regex filters are applied for substrings instead of the entire output string.
  • Upgraded nlohmann::json to 3.11.3.
  • Upgraded xsimd to 13.0.
  • Upgraded xtl to 0.7.7.
  • Upgraded xtensor to 0.25.
  • Upgraded yaml-cpp to 0.8.

Version 6.2.0 (24 January 2025):

• 🎉 New:
  • Added support for encryption/decryption of images and PDFs using the AES-GCM algorithm with random 96-bit initialization vectors and variable length authentication tags, as required for ePA-FdV-certification by gematik and BSI. See SBSDKAESGCMEncrypter class.
  • Added support for encryption key derivation using PBKDF2, HKDF and Random key derivation on both the standard AES encrypter (SBSDKAESEncrypter) and the new AES-GCM encrypter (SBSDKAESGCMEncrypter) with variable key lengths (128 and 256 bits). See the new protocol SBSDKStorageCryptingKeyGenerator and the new classes SBSDKRandomKeyGenerator, SBSDKPBKDF2KeyGenerator and SBSDKHKDFKeyGenerator.
  • Added protocol-based support for encryption key management. See the new protocol SBSDKStorageCryptingKeyProvider and the new class SBSDKVolatileKeyProvider.
  • Added new class SBSDKVolatileKeyProvider that stores, restores and deletes keys in memory per context. For a persistent storage, e.g. in the keychain or in a file, you can implement your own key provider by conforming to the SBSDKStorageCryptingKeyProvider protocol.
  • Added support for encryption/decryption on a encryption-key-per-context base. See SBSDKStorageCryptingKeyProvider and SBSDKStorageCrypting.
  • Added new delegate method barcodeTrackingOverlay(_ controller:overrideTextFor:proposedString:) to SBSDKBarcodeTrackingOverlayControllerDelegate.
• 🐞 Bug fixes:
  • Fixed a bug in the barcode RTU-UI v2 action bar items where the accessibilityDescription was not being applied correctly.
• 🚙 Under the hood:
  • Removed third-party-library symbols from the binary to avoid linking conflicts.

Version 6.1.1 (28 November 2024):

• 🐞 Bug fixes:
  • Fixes a crash in scanners when setting the same minZoom and maxZoom in SBSDKZoomRange.

Version 6.1.0 (7 November 2024):

• 🎉 New:
  • Added a new property hardwareButtonsEnabled that enables snapping from the hardware volume buttons and the new hardware camera control button to SBSDKBarcodeScanAndCountViewController, available on iOS 17.2 and later.
  • Added new zoom control slider controlled by the new camera control button on all view controllers, available on all the new iPhone 16 models.
  • Added a new property allowEmptySubmission to SBSDKUI2MultipleScanningMode.
• 🐞 Bug fixes:
  • Fixed KANJI mode for QR codes.
  • Fixed a bug with wrong raw bytes returned for some 2D barcode types.
• ⚠️ Breaking Changes:
  • Replaced the buggy initializer init?(json: Data) in SBSDKUI2BarcodeScannerConfiguration by the static function SBSDKUI2BarcodeScannerConfiguration.fromJson(json: String)?.

Version 6.0.0 (22 October 2024):

• 🎉 New:
  • Added new property addAdditionalQuietZone to SBSDKBarcodeAdditionalParameters.
  • Added new property postalTypes to SBSDKBarcodeType.
• 🚀 Improvements:
  • The AR-overlay in SBSDKUI2FindAndPickScanningMode is now visible by default.
  • For CODE_128 and ITF, we improved the recognition of barcodes generated by defective thermal printers that do not print certain black bars correctly.
• 🐞 Bug fixes:
  • Fixed a bug in RTU-UI v2 Barcode Scanner where extended barcodes are displayed along with their non-extended versions.
  • Fixed a UI issue in the RTU-UI v2 Barcode Scanner where a title that was too long would cut off the cancel button.
  • Fixed a UI issue in the RTU-UI v2 Find & Pick scanner in button sheet mode where the counter badge was not visible.
  • Fixed a bug that did not mirror the front camera as expected.
  • Fixed a bug in SBSDKUI2SingleScanDialogModelProvider where the default displayed texts were not correct.

Version 5.2.1 (24 July 2024):

• 🚀 Improvements:
  • Made the SwiftUI Barcode Scanner more flexible. See SBSDKUI2BarcodeScannerView.
• 🐞 Bug fixes:
  • Fixed a UI issue on the RTU-UI V2 barcode sheet screen where the subtitle label was being vertically cut off.
  • Fixed a UI issue on the RTU-UI V2 barcode confirmation sheet in the single use case where the loading indicator was not centered when the loading message was hidden.
• ⚠️ Breaking Changes:
  • Changed SwiftUI Barcode Scanner initializer to accept blocks instead of binding vars. See SBSDKUI2BarcodeScannerView.

Version 5.2.0 (26 June 2024):

• 🎉 New:
  • Added support for new barcode types Maxicode, rMQR code, Code 11 and Code 32.
  • Added properties australiaPostCustomerFormat, useIATA2OF5Checksum and useCode11Checksum to SBSDKBarcodeAdditionalParameters and SBSDKUI2BarcodeRecognizerConfiguration.
• 🚀 Improvements:
  • Improved detection of UPC and EAN extensions.
  • Added support for Extended Channel Interpretation (ECI) for Datamatrix and Aztec.
  • Improved GS1 string handling with new modes for decoding and validation. See SBSDKGS1Handling.
  • Added the ability to display the scanned barcode's image in the FindAndPick usecase of SBSDKUI2BarcodeScannerViewController by specifying SBSDKUI2ExpectedBarcode.barcodeImageKey for the expected barcode's imageproperty.
• 🐞 Bug fixes:
  • Fixed a bug in the FindAndPick usecase of SBSDKUI2BarcodeScannerViewController that never showed the expected barcode's title, but always the barcode value.
• ⚠️ Breaking Changes:
  • Removed enum SBSDKBarcodeDensity.
  • Removed property codeDensity from SBSDKBarcodeAdditionalParameters.
  • Removed enum values validate and decode from SBSDKGS1Handling and replaced them by decodeStructure, decodeFull, validateStructure and validateFull.

Version 5.1.3 (26 June 2024):

• 🚀 Improvements:
  • Improved detection of UPC/EAN barcode extensions in live mode.
  • The barcode scanner now supports transposed (mirrored/flipped) Aztec barcodes.
• 🐞 Bug fixes:
  • Fixes a bug in SBSDKUI2Color where setting isArgb to true, resulted in a wrong color.

Version 5.1.1 (6 June 2024):

• 🐞 Bug fixes:
  • Fixes a crash with all Classic UI components when energy saving is disabled.
  • Fixes a bug in SBSDKUI2BarcodeScannerViewController in single scan mode that prevented the barcode scanner from pausing the recognition while the submit dialog is shown.

Version 5.1.0 (21 May 2024):

• 🎉 New:
  • Added new property regularExpressionPattern to SBSDKBarcodeScanner and SBSDKBarcodeScannerViewController to limit detection results.
  • Added support of the new 'Find and Pick' barcode scanning mode, see SBSDKUI2FindAndPickScanningMode.
  • Added support for continuous scanning in SBSDKUI2BarcodeScannerViewController.
  • Added Swift structured concurrency API (async/await) to SBSDKUI2BarcodeScannerViewController.
  • Added support for new barcode type SBSDKBarcodeTypeMicroPdf417.
  • Added a new class SBSDKBarcodeDocumentConstants which has all the constants related to the barcode document format.
  • Added new classes for all the barcode document formats. See the API documentation for more details.
  • Added a new class SBSDKBarcodeDocumentRootType which replaces the old SBSDKBarCodeScannerDocumentFormat.
  • Added a new struct SBSDKUI2BarcodeScannerView which is the SwifUI wrapper for SBSDKUI2BarcodeScannerViewController.
  • Added possibility to inject an image to simulate a video stream and a captured image to any scanner's camera session for UI testing. See Scanbot.testData, SBSDKTestData and SBSDKSimulatedCameraMockData.
  • Added isCameraFrozen property to SBSDKBaseScannerViewController.
  • Added new static properties allFormats, commonFormats, oneDFormats and twoDFormats to SBSDKUI2BarcodeFormat.
  • Added new class SBSDKUI2BarcodeTextLocalization and new property localization to SBSDKUI2BarcodeScannerConfiguration to support localized strings.
  • Added support for parsing of AAMVA Certificate of Title for motor vehicle barcodes.
• 🚀 Improvements:
  • IMPORTANT: Changed the default rear cameras on all scanners to the triple or dual camera. On some devices with triple camera this results in a different view port (more zoomed in). Please make sure to adapt your zoom ranges and factors.
  • Improved image quality and capture speed on most iOS devices slightly by capturing HEIF images.
  • Added support of haptic feedback on capable devices.
  • SBSDKPDFPagesExtractor functions now create the output directory if it doesn't exist yet.
  • Added support for structured logging (OSLog) to the SDK (iOS 14+).
• 🐞 Bug fixes:
  • Fixes a bug with the asynchronous functions of SBSDKPDFPagesExtractor which returned an empty array of image URLs.
  • Fixes a UI bug in the SBSDKUI2BarcodeScannerViewController.
  • Fixed JSON representation of SBSDKUI2BarcodeItem.
• ⚠️ Breaking Changes:
  • Important: The default rear camera in all scanners has been changed from the ultra-wide or wide camera to the triple or dual camera.
  • Renamed function captureJPEGStillImage to captureStillImage in SBSDKBaseScannerViewController (and all subclasses) and SBSDKCameraSession.
  • Renamed function captureOutput(_ output:, didOutput:, from:) to cameraSession(_ session:, didOutput:) in protocol SBSDKCameraSessionDelegate.
  • Replaced the class SBSDKBarcodeDocumentType by SBSDKBarcodeDocumentRootType.
  • Renamed supportedBarcodesTypes(for:) to supportedBarcodeTypes(for:) in the new class SBSDKBarcodeDocumentRootType.
  • Removed the protocol SBSDKBarCodeScannerDocumentFormat and all of its children classes.
  • Removed default properties of use cases in SBSDKUI2BarcodeUseCase, now use the proper initializer for every use case, e.g. SBSDKUI2SingleScanningMode().
  • Made the property type in SBSDKUI2BarcodeItem optional.
  • Changed type of property rawBytes from [UInt8] to Data.
• 🚙 Under the hood:
  • Added third-party library libzueci version 1.0.0

Version 5.0.4 (27 March 2024):

• 🐞 Bug fixes:
  • Fixes a bug where barcode results formattedResult returned nil instead of the correct barcode document.

Version 5.0.3 (21 March 2024):

• 🐞 Bug fixes:
  • Changed privacy manifest to comply with the latest Apple specs.

Version 5.0.2 (15 March 2024):

• 🐞 Bug fixes:
  • Fixes a problem that slowed down still image capturing on some older iOS devices.
• 🚀 Improvements:
  • Improved speed and image quality of still image capturing.

Version 5.0.1 (12 March 2024):

• 🐞 Bug fixes:
  • Fixed a critical bug in the camera session causing still images to be captured at a lower than expected resolution.

Version 5.0.0 (1 March 2024):

• 🎉 New:
  • Added new RTU-UI V2 component, see SBSDKUI2BarcodeScannerViewController.
  • Added the SBSDKFinderView.Style enum and the property style that defines the drawing styles of the finder view to SBSDKFinderView and SBSDKBaseScannerViewFinderConfiguration.
  • Added the viewFinderStyle property to SBSDKBaseScannerViewController.
  • Added streaming encryption support to SBSDKStorageCrypting.
  • Added Privacy manifest file (PrivacyInfo.xcprivacy) to the SDK.
  • Added new static property maximumRecommendedImageSize to SBSDKDeviceInformation.
  • Added new function resetAccumulation to SBSDKBarcodeScannerViewController.
• ⚠️ Breaking Changes
  • Deprecated SBSDKUIBarcodeScannerViewController and SBSDKUIBarcodesBatchScannerViewController along with their related classes. Please consider switching to the new SBSDKUI2BarcodeScannerViewController.
  • Changed isLicenseValid, licenseStatus from functions to variables in Scanbot class.
  • Changed defaultImageStoreEncrypter, defaultPDFEncrypter, shouldShowStatusBarOnScanningScreens, defaultStatusBarStyle from separated getters and setters to variables in ScanbotUI class.
  • Removed printInfo:, printError: and printWarning: from SBSDKLog.
  • Changed setLoggingEnabled: to property isLoggingEnabled in SBSDKLog.
  • Functions logInfo:, logError: and logWarning: in SBSDKLog now accept String as a parameter instead of va_list.
  • Changed all SBSDKBarcodeType global constants to static properties of SBSDKBarcodeType.
  • Refactored SBSDKBarcodeType, it introduces a style naming change for all barcode types, please see the documentation.
  • Moved the global constants SBSDKBarcodeMetadataEANUPCExtensionKey and SBSDKBarcodeMetadataIsGS1MessageKey to SBSDKBarcodeScannerResult as its static properties.
  • Changed all SBSDKBarcodeDocumentType global constants to static properties of SBSDKBarcodeDocumentType.
  • Replaced the default value of acceptedBarcodeTypes with SBSDKBarcodeType.commonTypes, this property will no longer accept nil anywhere, if it's set to an empty array, this will automatically be translated to SBSDKBarcodeType.commonTypes.
• 🚙 Under the hood:
  • Refactored all public SDK code to Swift.

Version 4.2.2 (21 March 2024):

• 🐞 Bug fixes:
  • Changed privacy manifest to comply with the latest Apple specs.

Version 4.2.1 (13 February 2024):

• 🎉 New:
  • Added Privacy manifest file (PrivacyInfo.xcprivacy) to the SDK.
  • Added new static property maximumRecommendedImageSize to SBSDKDeviceInformation.

Version 4.2.0 (7 December 2023):

• 🎉 New:
  • Added support for new barcode type SBSDKBarcodeTypeGS1Composite.
• 🚀 Improvements:
  • Added more control over how to handle GS1 messages in barcodes. See SBSDKGS1Handling.
• ⚠️ Breaking Changes:
  • The property enableGS1Decoding has been replaced by the enum SBSDKGS1Handling in SBSDKBarcodeAdditionalParameters.
  • GS1 codes are now handled differently for various barcode types. Using the default option PARSE will give the same result as before for all barcode types, except of RSS_EXPANDED. Previously, for RSS_EXPANDED, the result was inconsistently returned with parentheses. Now, to get results with parentheses for all barcode types, it is needed to choose the option DECODE.

Version 4.1.0 (27 November 2023):

• 🎉 New:
  • Added support for 6 new barcode types to the barcode scanner:
    • SBSDKBarcodeTypeUSPSIntelligentMail
    • SBSDKBarcodeTypeRoyalMail
    • SBSDKBarcodeTypeJapanPost
    • SBSDKBarcodeTypeRoyalTNTPost
    • SBSDKBarcodeTypeAustraliaPost
    • SBSDKBarcodeTypeDatabarLimited
• 🐞 Bug fixes:
  • Fixed a bug where the finder text hint was still showing when viewFinderEnabled was disabled in SBSDKUIBarcodeScannerViewController and SBSDKUIBarcodesBatchScannerViewController.
  • Fixed a wrong polygon color in RTU-UI barcode scanner tracking overlay.

Version 4.0.3 (30 October 2023):

• 🎉 New:
  • Added new method widestAvailableBackFacingCamera to SBSDKCameraDevice.
  • Added new method setupDefaultLicenseFailureHandlerWithCompletion: to the Scanbot class.
• ⚠️ Breaking Changes:
  • Renamed photoQualityPriorization to photoQualityPrioritization everywhere in the SDK.

Version 4.0.2 (28 September 2023):

• 🐞 Bug fixes:
  • Fixed a focusing issue with the new iPhone 15 Pro and 15 Pro Max.

Version 4.0.0 (23 August 2023):

• 🎉 New:
  • Added property extensionFilter to all barcode scanning APIs (SBSDKBarcodeScanner, SBSDKBarcodeScannerViewController, SBSDKBarcodeScanAndCountViewController, SBSDKUIBarcodeScannerBehaviorConfiguration and SBSDKUIBarcodesBatchScannerBehaviorConfiguration).
  • Added property extension to SBSDKBarcodeScannerResult.
  • Added new class SBSDKScanAndCountPolygonStyle.
  • Added new delegate function (nonnull SBSDKScanAndCountPolygonStyle *)barcodeScanAndCountController:(nonnull SBSDKBarcodeScanAndCountViewController *)controller polygonStyleForBarcode:(nonnull SBSDKBarcodeScannerResult *)code to SBSDKBarcodeScanAndCountViewControllerDelegate.
  • Added trackingOverlayController property to SBSDKBarcodeScannerViewController.
  • Introduced new classes and protocols to manage barcode tracking overlay:
    • SBSDKBarcodeTrackingOverlayController: Provides a customizable user interface for displaying barcodes and supports interaction with them.
    • SBSDKBarcodeTrackingOverlayConfiguration: Represents the configuration options for an SBSDKBarcodeTrackingOverlayController.
    • SBSDKBarcodeTrackedViewTextStyle: Represents the style and kind of text rendered below a barcode.
    • SBSDKBarcodeTrackedViewPolygonStyle: Represents the style of the polygon rendered around a barcode.
    • SBSDKTrackedBarcodeInfoView: A protocol that defines the methods and properties required for a custom tracking view.
    • Added functions to SBSDKDeviceInformation to get the total, used and unused disk space on the device.
• 🚀 Improvements:
  • RTU-UI configurations can now be initialized with partial/incomplete JSON data by internally merging the partial data into the configurations default values.
  • Improved the speed of barcode recognition for most barcode symbologies.
• 🐞 Bug fixes:
  • Fixed a crash when denying camera permission.
• ⚠️ Breaking Changes:
  • Due to a Swift compiler naming collision, the class ScanbotSDK has been renamed to Scanbot.
  • Renamed the class ScanbotSDKUI to ScanbotUI for consistency.
  • Removed barcode type SBSDKBarcodeTypeUnknown.
  • Removed qrBarcodeDetectionViewController:selectionOverlayTextFor: from SBSDKUIBarcodeScannerViewController.
  • Renamed selectionOverlayEnabled to isTrackingOverlayEnabled in SBSDKBarcodeScannerViewController.
  • Renamed SBSDKUIBarcodeSelectionOverlayConfiguration to SBSDKUIBarcodeTrackingOverlayConfiguration
  • Renamed selectionOverlayConfiguration to trackingOverlayConfiguration in SBSDKUIBarcodeScannerConfiguration and SBSDKUIBarcodesBatchScannerConfiguration.
  • Replaced the properties polygonEnabled, polygonColor, polygonFillColor and polygonLineWidth by the property polygonStyle in SBSDKBarcodeScanAndCountViewController.

Version 3.7.0 (22 June 2023):

• 🎉 New:
  • Added support for the Micro QR barcode type.
  • Added new property viewFinderEnabled to SBSDKUIBarcodeScannerBehaviorConfiguration and SBSDKUIBarcodesBatchScannerBehaviorConfiguration.
  • Added new properties confirmationDialogTitle and confirmationDialogMessage to SBSDKUIBarcodeScannerTextConfiguration.
  • Added new class SBSDKPDFPagesExtractor.
  • Added new Classic UI component SBSDKBarcodeScanAndCountViewController which enables you to scan barcodes multiple times using the shutter button.
• 🚀 Improvements:
  • Changed the default zoom range from (0.0 - 3.0) to (0.0 - 12.0) in all Classic UI and RTU-UI components and in SBSDKZoomRange.
  • Better per-frame accuracy for QR code detection.
  • Support for inverted PDF-417 barcodes.
  • The barcode types Code 39 and Code 93 decode slightly faster.
• 🐞 Bug fixes:
  • Fixed the detection of a few false positive RSS Expanded codes in live mode.
  • Fixed an unexpected behavior of the barcode scanner when passing SBSDKBarcodeTypeUnknown as accepted barcode type.
  • Fixed a bug in all Classic UI and RTU-UI components where the recognitionEnabled property might not have worked as intended.
  • Fixed a bug where automaticSelectionEnabled was not working properly in SBSDKUIBarcodesBatchScannerViewController.
• ⚠️ Breaking Changes:
  • Removed support for iOS 11.x and 12.x. The minimum deployment target to use ScanbotSDK in your app is iOS 13.0!
  • Removed class SBSDKUIMachineCodesCollection.
  • Renamed the property acceptedMachineCodeTypes to acceptedBarcodeTypes in SBSDKUIBarcodeScannerBehaviorConfiguration and SBSDKUIBarcodesBatchScannerBehaviorConfiguration.
  • The RTU-UI configuration JSON formats have been changed, mostly the enum values have been capitalized.
• 🚙 Under the hood:
  • Released versions of ScanbotBarcodeScannerSDK.framework and ScanbotBarcodeScannerSDK.xcframework are code-signed now using an iOS Distribution Certificate on behalf of "Scanbot SDK GmbH", so you can easily verify our SDKs.

Version 3.6.1 (25 May 2023):

• 🐞 Bug fixes:
  • Fixed a crash within the barcode detector.

Version 3.6.0 (25 April 2023):

• 🎉 New:
  • Added optional delegate methods barcodeScannerController:didUpdateDetectedBarcodes:, barcodeScannerController:configureCustomCell:forBarcode:withBarcodePolygonPath:, and barcodeScannerController:customCellFrameForProposedFrame: to SBSDKBarcodeScannerViewControllerDelegate.
  • Added new property automaticSelectionEnabled to SBSDKBarcodeScannerViewController.
  • Added new properties oneDTypes and twoDTypes to SBSDKBarcodeType.
  • Added properties dateOfDetection and age to SBSDKBarcodeScannerResult.
  • Added new methods init and attach:parentViewController:containerView to SBSDKBarcodeScannerViewController.
  • Added support for the barcode type SBSDKBarcodeTypeCode25, which is a variant of the Industrial-2of5 type without the checksum.
  • Added new methods init and attach:parentViewController:containerView for all Classic-UI components.
  • Added new property minimumTimeWithoutDeviceMotionBeforeDetection to SBSDKBaseScannerGeneralConfiguration.
• 🚀 Improvements:
  • Improved barcode scanning with new ML models.
  • Substantial improvements to stacked RSS barcode scanning.
  • All Classic-UI view controllers can now be instantiated from storyboards.
• ⚠️ Breaking Changes:
  • Changed the method initWithParentViewController:parentViewController:parentView:delegate of SBSDKBarcodeScannerViewController so that the parentViewController and the parentView must not be nil.
  • Removed property decodeStacks1D from SBSDKBarcodeAdditionalParameters. The barcode scanner now handles this automatically.
• 🐞 Bug fixes:
  • Fixed a crash while logging URLs with spaces.
  • Fixed a rare crash with the application state observer.

Version 3.5.0 (3 February 2023):

• 🎉 New:
  • Added new properties resultWithConfirmationEnabled and dialogTextFormat in SBSDKUIBarcodeScannerBehaviorConfiguration to display a confirmation dialog before returning the results.
  • Added new properties confirmationDialogRetryButtonTitle and confirmationDialogConfirmButtonTitle in SBSDKUIBarcodeScannerTextConfiguration to configure the text confirmation dialog buttons.
  • Added new properties confirmationDialogStyle, confirmationDialogConfirmButtonStyle and confirmationDialogRetryButtonStyle in SBSDKUIBarcodeScannerUIConfiguration to configure the style of the confirmation dialog buttons.
  • Added new property automaticSelectionEnabled to SBSDKUIBarcodeSelectionOverlayConfiguration.
  • Added new property sourceImage to SBSDKBarcodeScannerResult.
  • Added new property videoFrameResolution of the new type SBSDKVideoFrameResolution to SBSDKBaseScannerGeneralConfiguration.
• 🚀 Improvements:
  • Improved general speed and accuracy when detecting barcodes.
  • Improved recognition of stacked RSS Expanded barcodes.
• ⚠️ Breaking Changes:
  • Refactored SBSDKBarcodeScannerViewControllerDelegate. Please check all your classes that conform to SBSDKBarcodeScannerViewControllerDelegate.
• 🚙 Under the hood:
  • Updated third-party library TFlite to version 2.10.

Version 3.4.0 (15 December 2022):

• 🎉 New:
  • Added support for more camera device types in SBSDKCameraDevice. The new device types are SBSDKCameraDeviceTypeUltraWide, SBSDKCameraDeviceTypeDualWide, SBSDKCameraDeviceTypeDual and SBSDKCameraDeviceTypeTriple.
  • Added new barcode scanner parameter decodeStacks1D to SBSDKBarcodeAdditionalParameters. For stacked RSS barcodes, this should be set to the number of stacks with which the barcode was printed.
  • Added a new text format property configuration in barcodes overlay SBSDKBarcodeOverlayFormat for RTU-UI, see overlayTextFormat in SBSDKUIBarcodeSelectionOverlayConfiguration and for classical component, see overlayTextFormat in SBSDKBarcodeScannerViewController.
• 🚀 Improvements:
  • Improved recognition of inverted barcodes.
  • Improved performance and reduced false positive rate for stacked RSS barcodes.
  • Improved performance of DataMatrix and QR-codes.
• 🐞 Bug fixes:
  • Fixed a crash when navigating from and to scanner view controllers.
  • Fixed a potential crash when the app using ScanbotSDK is suspended by the operating system.
• ⚠️ Breaking Changes:
  • Changed the default back-facing camera to the ultra-wide lens on iPhone 14 Pro (including Max) devices, due to close-focusing issues with these devices.
• 🚙 Under the hood:
  • Added third-party libraries (backward-cpp v1.6 and magic-enum v0.8.1).

Version 3.3.0 (19 October 2022):

• ⚠️ Breaking Changes:
  • Xcode 14.0 and higher is now required to build and submit apps using ScanbotSDK!
  • Removed bitcode from ScanbotSDK. Bitcode is no longer needed and Apple deprecated it with Xcode 14. Please turn bitcode off for your apps using ScanbotSDK!
  • The SBSDKCameraSession's method startSession is now asynchronous and has a completion handler.
• 🎉 New:
  • Added support for IATA and Industrial barcode types.
  • Added property initialScanDelay to SBSDKBaseScannerViewController, SBSDKUIBarcodesBatchScannerBehaviourConfiguration and SBSDKUIBarcodeScannerBehaviourConfiguration, which allows you to define how long the view controller waits (after its appearance) before scanning/recognizing.
  • Added a new function - (nonnull NSArray<SBSDKBarcodeScannerResult *> *)barcodeScanner:(nonnull SBSDKBarcodeScannerViewController *)controller filterResults:(nonnull NSArray<SBSDKBarcodeScannerResult *> *)codes to SBSDKBarcodeScannerViewControllerDelegate which allows you to filter detected barcodes before post-processing them in the final delegate call.
  • Added properties displayResultsOverlay, resultsOverlayColor and resultsOverlayTextColor to SBSDKBarcodeScannerViewController to display an AR-style overlay highlighting the found recognition result in real-time
  • Added properties selectionOverlayEnabled as well as selectionPolygonColor, selectionTextColor, selectionTextContainerColor and their highlighted counterparts to SBSDKBarcodeScannerViewController to display and configure an overlay for selecting and highlighting recognized barcodes.
  • Added property selectionOverlayConfiguration of the new class SBSDKUIBarcodeSelectionOverlayConfiguration to SBSDKUIBarcodeScannerConfiguration and SBSDKUIBarcodesBatchScannerConfiguration.
  • Added property applicationStateDidChangeHandler to SBSDKBaseScannerViewController to notify you when the application moved to foreground or background state.
  • Added property zoomFactorDidChangeHandler to SBSDKBaseScannerViewController to notify you when the camera zoom factor has changed.
  • Added property cameraZoomFactorAbsolute to SBSDKBaseScannerViewController which returns the absolute camera's video zoom factor.
  • Added functions freezeCamera and unfreezeCamera to SBSDKBaseScannerViewController, SBSDKUIBarcodeScannerViewController and SBSDKUIBarcodesBatchScannerViewController.
• 🐞 Bug fixes:
  • Fixed a bug where UPC/EAN extensions were not recognized.
  • Fixed a warning with Xcode 14/iOS 16 about the camera session's synchronous start.

Version 3.2.4 (26 September 2022):

• ⚠️ Breaking Changes:
  • Removed bitcode from ScanbotBarcodeScannerSDK, Bitcode is no longer needed and Apple deprecated it with Xcode 14. Please turn Bitcode off for your apps using ScanbotBarcodeScannerSDK!
• 🎉 New:
  • Added new class SBSDKSoundController to play a default or custom sound on different actions, e.g. successful code detection.
  • Added new method playBleepSound to SBSDKBaseScannerViewController to play a default bleep sound.

Version 3.2.3 (18 August 2022):

• 🎉 New:
  • Added support for JSON in all RTU-UI configurations. All SBSDKUI...Configuration classes now have an initWithJSON: initializer
  • Added new parameter codeDensity to SBSDKBarcodeAdditionalParameters.
  • Added new parameter flashButtonHidden to RTU-UI screen.
• ⚠️ Breaking Changes:
  • Moved the parameters acceptedMachineCodeTypes and acceptedDocumentTypes from the initializers of SBSDKUIBarcodeScannerViewController to SBSDKUIBarcodeScannerBehaviorConfiguration and from SBSDKUIBarcodesBatchScannerViewController to SBSDKUIBarcodesBatchScannerBehaviorConfiguration.
  • Removed the parameter accumulatedFramesCount and the corresponding initializers from SBSDKBarcodeScanner.
  • Removed the parameter barcodeAccumulatedFramesCount from SBSDKBarcodeScannerViewController and SBSDKScannerViewController.
  • Removed parameters imageOrientationLock and allowedInterfaceOrientations from all RTU-UI configurations. This has been replaced by the combined property orientationLockMode.
• 🚙 Under the hood:
  • Updated third-party library Boost to version 1.79.0

Version 3.2.2 (13 June 2022):

• 🎉 New:
  • Classic UI components:
    • Added a new base scanner view controller SBSDKBaseScannerViewController which provides a lot of base functionality like zooming, view finder, energy management, focus locking, flash light, flash animation, automatic interruption of detection on disappearance or when presenting view controllers and more.
  • RTU-UI components:
    • Refactored all RTU-UI components to make use of the new Classic UI components under the hood.
• 🚀 Improvements:
  • Improved 1D barcode recognition
• ⚠️ Breaking Changes:
  • SBSDKBarcodeScannerViewController
    • replaced designated initializer with - (nullable instancetype)initWithParentViewController:(nonnull UIViewController *)parentViewController parentView:(nullable UIView *)containerView delegate:(nullable id<SBSDKBarcodeScannerViewControllerDelegate>)delegate.
    • In SBSDKBarcodeScannerViewControllerDelegate the function - (void)barcodeScannerController:(nonnull SBSDKBarcodeScannerViewController *)controller didDetectBarcodes:(nonnull NSArray<SBSDKBarcodeScannerResult *> *)codes; is renamed to - (void)barcodeScannerController:(nonnull SBSDKBarcodeScannerViewController *)controller didDetectBarcodes:(nonnull NSArray<SBSDKBarcodeScannerResult *> *)codes onImage:(nonnull UIImage *)image;.
    • removed property HUDView, please use overlayView.
    • removed property cameraZoomRange, please use zoomConfiguration.zoomRange.
    • removed property cameraZoomFactor, please use zoomConfiguration.initialZoomFactor.
    • removed property doubleTapToZoomEnabled, please use zoomConfiguration.doubleTapToZoomEnabled.
    • removed property pinchToZoomEnabled, please use zoomConfiguration.pinchToZoomEnabled.
    • removed property shouldUseFinderFrame.
    • removed property finderAspectRatio, please use viewFinderConfiguration.aspectRatio.
    • removed property finderMinimumInset, please use viewFinderConfiguration.minimumInset.
    • removed property previewBackgroundColor.
    • removed property viewFinderBackgroundColor, please use viewFinderConfiguration.backgroundColor.
    • removed property viewFinderLineColor, please use viewFinderConfiguration.lineColor.
    • removed property viewFinderLineWidth, please use viewFinderConfiguration.lineWidth.
  • Replaced SBSDKFinderLayer by SBSDKFinderView.
  • Renamed SBSDKUIVideoContentMode to SBSDKVideoContentMode.

Version 3.2.1 (20 April 2022):

• 🐞 Bug fixes:
  • Fixed a crash on specific PDF-417 codes with boarding passes

Version 3.2.0 (7 April 2022):

• 🚀 Improvements:
  • Major improvements on barcode detection.
  • Improved barcode image cropping.
• 🚙 Under the hood:
  • Updated third-party library Boost to version 1.75.0
  • Updated third-party library BoringSSL to commit 8f5eb80b
  • Updated third-party library JSON for Modern C++ to version 3.10.2
  • Updated third-party library Leptonica to version 1.82.0
  • Updated third-party library libjpeg-turbo to version 2.1.2
  • Updated third-party library libpng to version 1.6.36
  • Updated third-party library libtiff to version 4.2.0
  • Updated third-party library Nameof C++ to version 0.10.1
  • Updated third-party library OpenCV to version 4.5.3
  • Updated third-party library OpenSSL to version 1.1.1i
  • Updated third-party library Skia to commit 47b4b19
  • Updated third-party library spdlog to version 1.9.2
  • Updated third-party library Tensorflow to version 2.6.1
  • Updated third-party library Tesseract to version 4.1.3
  • Updated third-party library XNNPACK to commit fb8d1f1b2
  • Updated third-party library xsimd to commit 3d17850e
  • Updated third-party library xtensor to commit be35a267
  • Updated third-party library xtl to commit e0f00666
  • Updated third-party library ZXing-C++ to version 1.1.0
  • Updated third-party library G8Tesseract to commit bfc86ac

Version 3.1.3 (1 March 2022):

• 🐞 Bug fixes:
  • Fixed a bug with wrong camera preview orientation when starting SBSDKBarcodeScannerViewControllerand SBSDKUIBarcodeScannerViewController in landscape orientation.

Version 3.1.2 (18 February 2022):

• 🎉 New:
  • Added support for the GS1 barcode document format, see SBSDKGS1DocumentFormat.
  • Added the SBSDKBarcodeDocumentParser class which parses any given string for supported barcode document types.
• ⚠️ Breaking Changes:
  • Renamed SBSDKDisabilityCertificateDocumentFormat to SBSDKMedicalCertificateDocumentFormat

Version 3.1.1 (26 January 2022):

• 🐞 Bug fixes:
  • Fixes an issue with view finder colors and line width not being applied in RTU-UI components.
  • Fixes an issue with the flashlight not turning on automatically if configured in SBSDKUIBarcodeScannerViewController and SBSDKUIBarcodesBatchScannerViewController.

Version 3.1.0 (14 January 2022):

• 🎉 New:
  • Added ability to disable auto-focus by locking the lens at the specified lens position.
    • Added property isFocusLockEnabled and functions - (BOOL)beginFocusLockAtLensPosition:(CGFloat)lensPosition, - (void)endFocusLock to SBSDKBarcodeScannerViewController and SBSDKCameraSession.
    • Added properties focusLockEnabled and focusLockPosition to SBSDKUIBarcodeScannerBehaviorConfiguration and SBSDKUIBarcodesBatchScannerBehaviorConfiguration.
  • Support for front-facing, telephoto and wide angle cameras in RTU-UI and classic components:
    • New classes for camera support: SBSDKCameraDevice, SBSDKUIConfiguration and SBSDKUICameraConfiguration.
    • New function for camera support: [SBSDKCameraSession initForFeature:withDevice:].
    • New property for camera support: cameraDevice in SBSDKBaseCameraViewController which is the base class for all classic components.
    • All SBSDKUIConfiguration objects now derive from SBSDKUIConfiguration which adds the new subconfigration cameraConfiguration of type SBSDKUICameraConfiguration.
  • Added properties rawTextStringWithExtension and metadata to SBSDKBarcodeScannerResult to support barcode extensions of UPC and EAN barcodes.
  • The results screen of the SBSDKUIBarcodesBatchScannerViewController now displays rawTextStringWithExtension instead of rawTextString.
  • Support for barcode scanner results filtering in RTU-UI barcode scanning components:
    • New subclassable objects SBSDKUIBarcodeFilter and SBSDKUIBarcodeExtensionsFilter.
    • New property barcodeFilter in SBSDKUIBarcodeScannerBehaviorConfiguration and SBSDKUIBarcodesBatchScannerBehaviorConfiguration.
• 🚀 Improvements:
  • Improved Aztec barcode recognition.
  • Improved PDF417 recognition performance on single photos.
  • Improved barcode detection on large documents.
  • Updated flash buttons' icons.
  • Improved GS-1 databar recognition in the next-gen barcode scanner.
• 🐞 Bug fixes:
  • Fixed crash when scanning barcodes on certain images.
  • Fixed a very rare problem in all scanner screens where the camera layer lost track of the device orientation.

Version 3.0.3 (3 November 2021):

• 🐞 Bug fixes
  • Fixed some rare crashes
• 🚙 Under the hood:
  • Updated some third party libraries. (see Third-party Libraries)

Version 3.0.2 (26 August 2021):

• 🎉 New:
  • Added support for zooming in SBSDKUIBarcodesBatchScannerViewController
  • Added stripCheckDigits parameter in SBSDKBarcodeAdditionalParameters class.
• ⚠️ Breaking Changes:
  • Added SBSDKSEPADocumentFieldTypePurpose, SBSDKSEPADocumentFieldTypeRemittance and SBSDKSEPADocumentFieldTypeInformation fields to SBSDKSEPADocumentFieldType. Removed SBSDKSEPADocumentFieldTypeReference and SBSDKSEPADocumentFieldTypeHint fields from it.
• 🚀 Improvements:
  • Improved recognition of UPC/EAN barcodes due to ink spread

Version 3.0.1 (6 July 2021):

• 🎉 New:
  • Added support for Apple Silicon M1 simulators. Your app build with the ScanbotBarcodeScannerSDK.xcframework or via CocoaPods now will run natively on M1 Mac simulators without having to start Xcode in Rosetta 2 mode
• ⚠️ Breaking Changes:
  • The ScanbotBarcodeScannerSDK CocoaPod now contains an XCFramework instead of a standard framework, you may need to update CocoaPods and/or Xcode

Version 3.0.0 (1 July 2021):

• 🎉 New:
  • Brand new "Next Generation" machine-learning-based barcode scanning engine with improved reliability and much faster performance
  • API changes for the new barcode engine: added engineMode property of type SBSDKBarcodeEngineMode on barcode scanning APIs like SBSDKBarcodeScanner, SBSDKBarcodeScannerViewController, and SBSDKUIBarcodesBatchScannerBehaviorConfiguration to switch between the legacy barcode engine and the new Next Generation barcode engine. By default, the new engine is used.
• ⚠️ Breaking Changes:
  • Removed enableHighSensitivityMode property on SBSDKBarcodeScanner, because it is no longer needed
• 🚀 Improvements:
  • Improved logging for license failures. The app bundle identifier from the license and from the app will be displayed in the log in case you accidentally set up a wrong license. Also now the expiration date of expired licenses is being logged to the console.
• 🚙 Under the hood:
  • New third-party libraries: xsimd, xtl und xtensor (see Third-party Libraries)

Version 1.12.0 (9 June 2021):

• 🎉 New:
  • Added support for MSI-Plessey barcodes again: see SBSDKBarcodeTypeMSIPlessey, MSI checksum algorithm is selectable via SBSDKBarcodeAdditionalParameters property named msiPlesseyChecksumAlgorithm, by default MSI-Plessey is disabled, you must explicitly pass SBSDKBarcodeAdditionalParameters as accepted type to any barcode scanning class
• 🚀 Improvements:
  • Better logging of licensing system errors, e.g. display the apps and the licenses bundle identifier
• 🐞 Bug fixes
  • Fixes a problem with UPC-A barcodes being recognized as EAN13 barcodes.

Version 1.11.0 (21 April 2021):

• 🎉 New:
  • Added support for zooming in SBSDKBarcodeScannerViewController and SBSDKUIBarcodeScannerViewController. Use the new properties cameraZoomRange, cameraZoomFactor, shouldAnimateZooming, doubleTapToZoomEnabled and pinchToZoomEnabled on SBSDKBarcodeScannerViewController and SBSDKUIBarcodeScannerBehaviorConfiguration to configure zooming the camera to scan small barcodes.
  • Added support for document type filtering to SBSDKUIBarcodesBatchScannerViewController
• ⚠️ Breaking Changes:
  • SBSDKBarcodeScannerViewController: capturingFrameAspectRatio was renamed to finderAspectRatio, and capturingFrameMinimumInsetwas renamed to finderMinimumInset.
  • Removed SBSDKUIMachineCodeScannerConfiguration and related configurations. SBSDKUIBarcodeScannerViewController now uses SBSDKUIBarcodeScannerConfiguration as configuration.

Version 1.10.1 (9 April 2021):

• 🎉 New:
  • Added enableGS1Decoding parameter to SBSDKBarcodeAdditionalParameters.
• 🐞 Bug fixes
  • Fixed a bug in SBSDKUIBarcodesBatchScannerViewController where additionalDetectionParameters have not been applied.
  • Fixed a rare bug with calculation the finder rectangle in SBSDKBarcodeScannerViewController.
• 🚙 Under the hood:
  • Updated OpenSSL to version 1.1.1j.

Version 1.10.0 (25 March 2021):

• 🎉 New:
  • Added additionalParameters property to SBSDKBarcodeScanner and SBSDKUIMachineCodeScannerBehaviorConfiguration, additionalDetectionParameters to SBSDKBarcodeScannerViewController and SBSDKUIBarcodesBatchScannerBehaviorConfiguration and additionalBarcodeDetectionParameters to SBSDKScannerViewController which lets you setup a minimum and maximum text length as well as a quiet zone. Currently works for ITF barcodes only.
• 🐞 Bug fixes
  • Fixed a rare out-of-memory crash in barcode (datamatrix) scanning on older devices
• 🚀 Improvements:
  • Added download links for ScanbotBarcodeScannerSDK.framework and XCFramework in the Installation Guide of the documentation.

Version 1.9.1 (11 March 2021):

• 🐞 Bug fixes
  • Fixed a rare crash in barcode scanner with wrong finder coordinates
• ⚠️ Breaking Changes:
  • Removed support of the MSI Plessey barcode detection

Version 1.9.0 (24 Feb 2021):

• 🎉 New:
  • Added support for Swiss QR codes, see SBSDKSwissQRCodeDocumentFormat
  • Added support for document type filtering to barcode and QR code scanners, acceptedDocumentTypes properties in SBSDKBarcodeScanner, SBSDKBarcodeScannerViewController and SBSDKUIBarcodeScannerViewController
  • Added global control of status bar visibility and style in SBSDKUI components, see functions + (void)setShouldShowStatusBarOnScanningScreens:(BOOL)shouldShow and + (void)setDefaultStatusBarStyle:(UIStatusBarStyle)style in the class ScanbotSDKUI
• 🐞 Bug fixes
  • Fixed a UI problem in SBSDKUIBarcodesBatchScannerViewController

Version 1.8.5 (2 Feb 2021):

• ⚠️ Breaking Changes:
  • - (nullable instancetype)initWithKey:(NSString *)key mode:(SBSDKAESEncrypterMode)mode was replaced by - (nullable instancetype)initWithPassword:(NSString *)password mode:(SBSDKAESEncrypterMode)mode
• 🐞 Bug fixes
  • Fixed a potential crash in SBSDKUIBarcodesBatchScannerViewController

Version 1.8.4 (21 Dec 2020):

• 🐞 Bug fixes
  • Fixed included strip script

Version 1.8.3 (17 Dec 2020):

• 🚀 Improvements:
  • Improved detection of ITF barcodes

Version 1.8.2 (7 Dec 2020):

• 🚀 Improvements:
  • Improved DataMatrix detection

Version 1.8.1 (3 Dec 2020)

• 🎉 New:
  • Added new property autoCancelTimeout to SBSDKUIMachineCodeScannerBehaviorConfiguration
  • Added new optional delegate function - (void)qrBarcodeDetectionViewControllerDidTimeout:(nonnull SBSDKUIBarcodeScannerViewController *)viewController; to SBSDKUIBarcodeScannerViewController
• 🚀 Improvements:
  • Improved some PDF417 detection edge cases
• 🐞 Bug fixes
  • Fixed a problem where distribution of an app containing ScanbotSDK would fail

Version 1.8.0 (1 Dec 2020)

• 🎉 New:
  • Added (customizable) encryption/decryption to image stores; new classes: SBSDKAESEncrypter, SBSDKStorageCrypting, ScanbotSDKUI
  • For SBSDKUI components you can enable encryption for stored images globally using the function + (void)setDefaultImageStoreEncrypter:(nullable id<SBSDKStorageCrypting>)encrypter of ScanbotSDKUI class, this will encrypt all stored images in these components
  • SBSDKAESEncrypter provides built-in support for AES128 and AES256 encryption, but you can create your own encrypter by implementing a class conforming to the protocol SBSDKStorageCrypting
• 🚀 Improvements:
  • Better recognition of rotated PDF417 codes

Version 1.7.3 (24 Nov 2020)

• 🚀 Improvements:
  • Improved barcode and PDF417 detection
• 🐞 Bug fixes
  • Fixed a rare crash in SBSDKUIBarcodesBatchScannerViewController, that occurred after fetching updated data.

Version 1.7.2 (16 Nov 2020)

• 🐞 Bug fixes
  • Fixed a deadlock in SBSDKUIBarcodesBatchScannerViewController
  • Fixed a potential memory leak with SBSDKUIBarcodesBatchScannerViewController
  • The delegate function of SBSDKUIBarcodeBatchStorageDelegate - (void)barcodeBatchStorage:(SBSDKUIBarcodeBatchStorage *)storage didUpdateBarcode:(SBSDKUIBarcodeMappedResult *)barcode atIndex:(NSInteger)index; is now called on the main queue

Version 1.7.1 (29 Oct 2020)

• 🚀 Improvements:
  • Updated barcode recognition model to improve recognition of certain QR and data matrix codes

Version 1.7.0 (23 Sept 2020)

• 🚀 Improvements:
  • Improved recognition of damaged DataMatrix barcodes
  • Improved recognition of Aztec barcodes
  • Modernized camera API usage and removed deprecated API usage, multiple new functions added to process a CVPixelBufferRef
• ⚠️ Breaking Changes:
  • Removed support for iOS 9 and iOS 10
  • SBSDKCameraSession: - (void)captureStillImageWithCompletionHandler:(nullable void (^)(CMSampleBufferRef _Nullable, NSError* _Nullable))completion; changed to - (void)captureStillImageWithCompletionHandler:(nullable void (^)(CVPixelBufferRef _Nullable, NSError* _Nullable))completion;
• 🚙 Under the hood:
  • Updated OpenCV to version 4.4.0

Version 1.6.0 (18 Aug 2020)

• 🎉 New:
  • Added Barcode batch detector RTU UI component SBSDKUIBarcodesBatchScannerViewController.
  • Barcode scanner: SBSDKBarcodeScannerResult class now contains rawBytes parameter.
• 🐞 Bug fixes:
  • Barcode scanner format parser fixes
• ⚠️ Breaking Changes:
  • SBSDKBarcodeScannerResult initializer is now - (instancetype)initWithPolygon:(SBSDKPolygon *)poly type:(SBSDKBarcodeType *)type barcodeImage:(UIImage *)image rawTextString:(NSString *)string rawBytes:(NSData *)rawBytes;

Version 1.5.2 (6 Aug 2020)

• 🐞 Bug fixes:
  • Fixed SDK size issue from the past release.

Version 1.5.1 (13 Jul 2020)

• 🎉 New:
  • Beta: Added support for MSI Plessey barcode format. Disabled by default, must explicitly be allowed.
  • commonTypes array of barcodes in SBSDKBarcodeType now contain all commonly-used types of barcodes. Is recommended for most cases.
• 🚀 Improvements:
  • Improved barcode and QR code live detection especially for very dense codes.
  • Added debug symbols for simulator architectures.
  • Improved handling of ink spread issues with Code128 barcodes.
  • Improved barcode detection model.
• 🚙 Under the hood:
  • Updated OpenSSL to version 1.1.1g
  • Updated TensorFlow to version 2.2.0

Version 1.5.0 (28 May 2020)

• 🚀 Improvements:
  • Improved recognition of inverted barcodes.
• 🐞 Bug fixes:
  • Fixed an issue with uploading apps containing the Scanbot Barcode SDK (related Apple error codes ITMS-90166, ITMS-90535 and ITMS-90171).
• ⚠️ Breaking Changes:
  • SBSDKMedicalPlanPatientFieldTypeAllergysAndIntolerances is renamed to SBSDKMedicalPlanPatientFieldTypeAllergiesAndIntolerances
  • SBSDKMedicalPlanSubheadingReceipeFieldType enum is renamed to SBSDKMedicalPlanSubheadingPrescriptionFieldType . Its cases SBSDKMedicalPlanSubheadingReceipeFieldTypeGeneralInformation and SBSDKMedicalPlanSubheadingReceipeFieldTypeReceipeFreeText has been renamed to SBSDKMedicalPlanSubheadingPrescriptionFieldTypeGeneralInformation and SBSDKMedicalPlanSubheadingPrescriptionFieldTypePrescriptionFreeText respectively.
  • SBSDKMedicalPlanSubheadingReceipeField class name is changed to SBSDKMedicalPlanSubheadingPrescriptionField .
  • SBSDKMedicalPlanSubheadingReceipe class name is changed to SBSDKMedicalPlanSubheadingPrescription .
  • Cases of SBSDKVCardDocumentFieldType - SBSDKVCardDocumentFieldTypeCallendarURIForRequests and SBSDKVCardDocumentFieldTypeCallendarURI has been renamed to SBSDKVCardDocumentFieldTypeCalendarURIForRequests and SBSDKVCardDocumentFieldTypeCalendarURI respectively.
  • Case of SBSDKBoardingPassDocumentFieldType - SBSDKBoardingPassDocumentFieldTypeSecongNonConsecutiveBaggageTagLicensePlateNumber has been renamed to SBSDKBoardingPassDocumentFieldTypeSecondNonConsecutiveBaggageTagLicensePlateNumber
  • In SBSDKBarcodeScannerViewControllerDelegate the function - (void)barcodeScannerController:(nonnull SBSDKBarcodeScannerViewController *)controller didDetecBarcodes:(nonnull NSArray<SBSDKBarcodeScannerResult *> *)codes; is renamed to - (void)barcodeScannerController:(nonnull SBSDKBarcodeScannerViewController *)controller didDetectBarcodes:(nonnull NSArray<SBSDKBarcodeScannerResult *> *)codes;.
  • In SBSDKUIEnableCameraUIConfiguration.h parameter enableCameraDesctiptionColor is renamed to enableCameraDescriptionColor.

Version 1.4.0 (8 May 2020):

• 🚀 Improvements:
  • Improved barcode detection on still images.
  • In SBSDKUIBarcodeScannerViewController flash button was moved to navigation bar to save more space for finder layer.
• ⚠️ Breaking Changes:
  • Renamed SBSDKPageAspectRatio class to SBSDKAspectRatio
  • In SBSDKUIMachineCodeScannerUIConfiguration removed bottomButtonsInactiveColor and bottomButtonsActiveColor. Parameter topBarButtonsColor now affects flash button active state. Added flashButtonInactiveColor.
  • In SBSDKBarcodeScannerViewController type of the parameter capturingFrameMinimumInset was changed from CGSize to UIEdgeInsets.
  • In SBSDKBarcodeScannerViewController parameter CGSize capturingFrameSize is changed to SBSDKAspectRatio *capturingFrameAspectRatio.
  • In SBSDKUIMachineCodeScannerUIConfiguration parameters CGFloat finderWidth and CGFloat finderHeight are replaced by SBSDKAspectRatio *finderAspectRatio.

Version 1.3.1 (3 Mar 2020):

• 🎉 New:
  • Added property SBSDKBarcodeScannerViewController.flashLightEnabled.

Version 1.3.0 (6 Feb 2020):

• 🎉 New:
  • Added SBSDKUIBarcodeImageStorage class for handling barcode images storage.

Version 1.2.0 (3 Feb 2020):

• 🎉 New:
  • Added property SBSDKBarcodeScanner.enableHighSensitivityMode.
  • Added functionality for getting the expiration date of a license key with +[ScanbotSDK licenseExpirationDate].
• 🐞 Bug fixes:
  • Fixed a crash for the "no camera access" case on RTU UI component.
  • Various minor bug fixes and improvements.

Version 1.1.0 (17 Dec 2019):

• 🎉 New:
  • Added parameter SBSDKBarcodeScannerViewController.barcodeAccumulatedFramesCount. It allows to set amount of frames that barcode detector processes before running the detection on the best frame.
• 🚀 Improvements:
  • Properties SBSDKBarcodeScanner.acceptedBarcodeTypes and SBSDKBarcodeScanner.accumulatedFramesCount can now be set after the initialization.
• 🐞 Bug fixes:
  • Fixed a bug, that caused detecting of all barcodes, if dataMatrix barcode type was selected as accepted.

Version 1.0.0 (5 Dec 2019):

🎉 First release of the standalone Scanbot Barcode Scanner SDK.

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get free trial license

Was this helpful?