How to Upgrade

From Version 9.x to 10.x

Dynamsoft Barcode Reader SDK has been refactored to integrate with DynamsoftCaptureVision (DCV) architecture. To upgrade from version 9.x or earlier to 10.x, we recommend you to follow the User Guide and re-write your codes.

Update the Libraries

The Dynamsoft Barcode Reader SDK has been split into multiple libraries from the previous single library, and the dependency of the xcframeworks need to be updated.

Option 1: Add the xcframeworks via Swift Package Manager

1. In your Xcode project, go to File –> AddPackages.

2. In the top-right section of the window, search “https://github.com/Dynamsoft/barcode-reader-spm”

3. Select barcode-reader-spm, choose Up to Next Major Version, then click Add Package.

4. Check all the xcframeworks and add.

Option 2: Add the Frameworks via CocoaPods

1. Add the frameworks in your Podfile, replace TargetName with your real target name.

   target 'ScanSingleBarcode' do
      use_frameworks!
   
   pod 'DynamsoftBarcodeReaderBundle','{version-number}'
   
   end
   

   Note: Please view user guide for the correct version number.

2. Execute the pod command to install the frameworks and generate workspace([TargetName].xcworkspace):

   pod install
   

Option 3: Add Local xcframeworks files

1. Download the SDK package from the Dynamsoft Website. After unzipping, you will find a collection of xcframework files under the Dynamsoft\Frameworks directory.

   • 📄 DynamsoftBarcodeReaderBundle.xcframework
   • 📄 DynamsoftCaptureVisionRouter.xcframework
   • 📄 DynamsoftCameraEnhancer.xcframework
   • 📄 DynamsoftBarcodeReader.xcframework
   • 📄 DynamsoftCore.xcframework
   • 📄 DynamsoftLicense.xcframework
   • 📄 DynamsoftImageProcessing.xcframework
   • 📄 DynamsoftUtility.xcframework

2. Drag and drop the xcframework files into your Xcode project. Make sure to check Copy items if needed and Create groups to copy the framework into your project’s folder.

3. Click on the project settings then go to General –> Frameworks, Libraries, and Embedded Content. Set the Embed field to Embed & Sign for all above xcframeworks.

Update the Template File

The template system is upgraded. The template you used for the previous version can’t be directly recognized by the new version. Please download the TemplateConverter tool or contact us to upgrade your template.

Update your code

You have 2 Options when updating your code.

• Update to New APIs with the foundational SDK
• Quick start a new project with BarcodeScanner Component

Option 1. Update to New APIs with the foundational SDK

Update the License Activation Code

Starting from 10.0, we have unified the API for setting licenses across different Dynamsoft products.

• Code in 9.x:

• Objective-C
• Swift

[DynamsoftBarcodeReader initLicense:@"YOUR-LICENSE-KEY" verificationDelegate:self];
- (void)DBRLicenseVerificationCallback:(bool)isSuccess error:(NSError *)error
{
  // Add your code for license verification.
}

DynamsoftBarcodeReader.initLicense("YOUR-LICENSE-KEY", verificationDelegate: self)
func dbrLicenseVerificationCallback(_ isSuccess: Bool, error: Error?)
{
  // Add your code for license verification.
}

• Code in 10.x:

• Objective-C
• Swift

[DSLicenseManager initLicense:@"DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" verificationDelegate:self];
- (void)onLicenseVerified:(BOOL)isSuccess error:(nullable NSError *)error {
    if (!isSuccess && error != nil) {
        NSLog(@"error: %@", error);
    }
}

LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", verificationDelegate: self)
func onLicenseVerified(_ isSuccess: Bool, error: Error?) {
   if !isSuccess {
          if let error = error {
             print("\(error.localizedDescription)")
          }
   }
}

Update Single Image Decoding APIs

The APIs for decoding single image has been adjusted as follows:

Update Video Streaming Decoding APIs

The APIs for decoding video frames has been adjusted as follows:

Migrate Your Templates

The template-based APIs have been updated as follows:

Migrate Your PublicRuntimeSettings

The class PublicRuntimeSettings has been refactored. It retains commonly used properties while removing the previously complex property settings, which are now exclusively supported through templates.

The APIs for accessing and updating PublicRuntimeSettings has been adjusted as follows:

Migrate to SimplifiedCaptureVisionSettings

The following properties are replaced by similar properties under DSSimplifiedCaptureVisionSettings. They can also be set via a template file(String).

Migrate to SimplifiedBarcodeReaderSettings

The following properties are replaced by similar properties under DSSimplifiedBarcodeReaderSettings. The majority of them can also be set via a template file(String).

Remarks:

• The 2 groups of barcode formats are merged.
• DeblurLevel is deprecated. You can use DeblurModes instead.

Remarks: The mode IPM_MORPHOLOGY of imagePreprocessingModes is migrated to BinarizationModes. The mode arguments MorphOperation, MorphOperationKernelSizeX, MorphOperationKernelSizeY, MorphShape are now available for all modes of BinarizationModes.

Migrate to Template File

The following properties can only be set via a template file. Please contact us so that we can help you to transform your current settings to a new template file.

Migrate to Other APIs

The Intermediate Result system is redesigned and the following properties are deprecated.

Removed

The following properties are removed.

Option 2. Quick start a new project with BarcodeScanner Component

BarcodeScanner is a ready-to-use component that allows developers to quickly set up a barcode scanning app. With the built-in BarcodeScannerViewController, it streamlines the integration of barcode scanning functionality into any application.

• View how to build your app with BarcodeScanner.