|
| 1 | +--- |
| 2 | +layout: default-layout |
| 3 | +title: Migrate from v10 to v11 - Dynamsoft Barcode Reader for Android |
| 4 | +description: Follow this page to learn to upgrade Barcode Reader SDK Android edition from v10 to v11. |
| 5 | +keywords: updates guide, android |
| 6 | +needAutoGenerateSidebar: true |
| 7 | +needGenerateH3Content: true |
| 8 | +noTitleIndex: true |
| 9 | +--- |
| 10 | + |
| 11 | +# Migrate from v10 to v11 |
| 12 | + |
| 13 | +> [!IMPORTANT] |
| 14 | +> **We strongly recommend upgrading to v11.x.** All future algorithm improvements, performance optimizations, and new features will be developed exclusively for v11 and later versions. Version 10.x and earlier will only receive critical bug fixes and will not benefit from ongoing innovation. |
| 15 | +
|
| 16 | +## Why Upgrade to v11? |
| 17 | + |
| 18 | +- **Latest Barcode Recognition Algorithms**: Access to cutting-edge decoding algorithms and accuracy improvements |
| 19 | +- **Ongoing Performance Enhancements**: Faster processing speeds and better resource optimization |
| 20 | +- **New Features & Capabilities**: Future functionality will only be available in v11+ |
| 21 | +- **Active Development**: Version 11 is the actively maintained branch receiving continuous updates |
| 22 | +- **Long-term Support**: Ensure your application stays current with industry standards |
| 23 | + |
| 24 | +**⚠️ Version 10.x is in maintenance mode only** - no new features or algorithm updates will be backported. |
| 25 | + |
| 26 | +## Migrate from v10.x to v11.x |
| 27 | + |
| 28 | +### Update the Libraries |
| 29 | + |
| 30 | +#### Option 1: Add the Library via Maven |
| 31 | + |
| 32 | +1. Open the file `[App Project Root Path]\settings.gradle` and add the Maven repository: |
| 33 | + |
| 34 | + <div class="sample-code-prefix"></div> |
| 35 | + >- groovy |
| 36 | + >- kts |
| 37 | + > |
| 38 | + >1. |
| 39 | + ```groovy |
| 40 | + dependencyResolutionManagement { |
| 41 | + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) |
| 42 | + repositories { |
| 43 | + google() |
| 44 | + mavenCentral() |
| 45 | + maven { |
| 46 | + url "https://download2.dynamsoft.com/maven/aar" |
| 47 | + } |
| 48 | + } |
| 49 | + } |
| 50 | + ``` |
| 51 | + 2. |
| 52 | + ```kotlin |
| 53 | + dependencyResolutionManagement { |
| 54 | + repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) |
| 55 | + repositories { |
| 56 | + google() |
| 57 | + mavenCentral() |
| 58 | + maven { |
| 59 | + url = uri("https://download2.dynamsoft.com/maven/aar") |
| 60 | + } |
| 61 | + } |
| 62 | + } |
| 63 | + ``` |
| 64 | + |
| 65 | +2. Open the file `[App Project Root Path]\app\build.gradle` and add the dependencies: |
| 66 | + |
| 67 | + <div class="sample-code-prefix"></div> |
| 68 | + >- groovy |
| 69 | + >- kts |
| 70 | + > |
| 71 | + >1. |
| 72 | + ```groovy |
| 73 | + dependencies { |
| 74 | + implementation 'com.dynamsoft:barcodereaderbundle:{version-number}' |
| 75 | + } |
| 76 | + ``` |
| 77 | + 2. |
| 78 | + ```kotlin |
| 79 | + dependencies { |
| 80 | + implementation("com.dynamsoft:barcodereaderbundle:{version-number}") |
| 81 | + } |
| 82 | + ``` |
| 83 | + |
| 84 | + <div class="blockquote-note"></div> |
| 85 | + > Please view [user guide](user-guide.md#option-1-add-the-library-via-maven) for the correct version number. |
| 86 | +
|
| 87 | +3. Click **Sync Now**. After the synchronization is complete, the SDK is added to the project. |
| 88 | + |
| 89 | +#### Option 2: Add the Libraries via Local .aar Files |
| 90 | + |
| 91 | +1. Download the SDK package from the <a href="https://www.dynamsoft.com/barcode-reader/downloads/?utm_source=docs#mobile" target="_blank">Dynamsoft Website</a>. After unzipping, several **aar** files can be found in the **Dynamsoft\Libs** directory: |
| 92 | + |
| 93 | + - 📄 **DynamsoftBarcodeReaderBundle.aar** |
| 94 | + - 📄 **DynamsoftCaptureVisionBundle.aar** |
| 95 | + |
| 96 | +2. Copy the above **.aar** files to the target directory such as *[App Project Root Path]\app\libs* |
| 97 | + |
| 98 | +3. Open the file `[App Project Root Path]\app\build.gradle` and add the reference in the dependencies: |
| 99 | + |
| 100 | + <div class="sample-code-prefix"></div> |
| 101 | + >- groovy |
| 102 | + >- kts |
| 103 | + > |
| 104 | + >1. |
| 105 | + ```groovy |
| 106 | + dependencies { |
| 107 | + implementation fileTree(dir: 'libs', include: ['*.aar']) |
| 108 | + def camerax_version = '1.4.2' |
| 109 | + implementation "androidx.camera:camera-core:$camerax_version" |
| 110 | + implementation "androidx.camera:camera-camera2:$camerax_version" |
| 111 | + implementation "androidx.camera:camera-lifecycle:$camerax_version" |
| 112 | + implementation "androidx.camera:camera-view:$camerax_version" |
| 113 | + } |
| 114 | + ``` |
| 115 | + 2. |
| 116 | + ```kotlin |
| 117 | + val camerax_version = "1.4.2" |
| 118 | + dependencies { |
| 119 | + implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.aar")))) |
| 120 | + implementation("androidx.camera:camera-core:$camerax_version") |
| 121 | + implementation("androidx.camera:camera-camera2:$camerax_version") |
| 122 | + implementation("androidx.camera:camera-lifecycle:$camerax_version") |
| 123 | + implementation("androidx.camera:camera-view:$camerax_version") |
| 124 | + } |
| 125 | + ``` |
| 126 | + |
| 127 | + <div class="blockquote-note"></div> |
| 128 | + > The camera features require the camerax dependencies. |
| 129 | +
|
| 130 | +4. Click **Sync Now**. After the synchronization is complete, the SDK is added to the project. |
| 131 | + |
| 132 | +### Update the Template File |
| 133 | + |
| 134 | +You can use the template converter to upgrade your template. View the [online template converter](https://www.dynamsoft.com/tools/template-upgrade/) |
| 135 | + |
| 136 | +## Migrate from v9.x or earlier |
| 137 | + |
| 138 | +> [!IMPORTANT] |
| 139 | +> **Critical: Version 9.x and earlier are on a legacy architecture.** All new algorithm development, performance improvements, and features are built exclusively on the DynamsoftCaptureVision (DCV) architecture introduced in v10+. |
| 140 | +> |
| 141 | +> **Staying on v9.x or earlier means:** |
| 142 | +> - ❌ No access to new barcode recognition algorithms |
| 143 | +> - ❌ No future performance optimizations |
| 144 | +> - ❌ Missing out on new symbology support |
| 145 | +> - ❌ Limited to critical security patches only |
| 146 | +> |
| 147 | +> **Upgrading to v11 provides:** |
| 148 | +> - ✅ Access to all future algorithm enhancements |
| 149 | +> - ✅ Continuous performance improvements |
| 150 | +> - ✅ New features and capabilities as they're released |
| 151 | +> - ✅ Full technical support and active maintenance |
| 152 | +
|
| 153 | +Dynamsoft Barcode Reader SDK has been refactored to integrate with DynamsoftCaptureVision (DCV) architecture since version 10. To upgrade from version 9.x or earlier to 11.x, we recommend you to follow the [User Guide](user-guide.md) and re-write your codes. This section highlights only the key changes and necessary actions for upgrading the SDK. |
| 154 | + |
| 155 | +### Update the Template File |
| 156 | + |
| 157 | +You can use the template converter to upgrade your template. View the [online template converter](https://www.dynamsoft.com/tools/template-upgrade/) |
| 158 | + |
| 159 | +### API Change Reference List |
| 160 | + |
| 161 | +License activation: |
| 162 | + |
| 163 | +| Old APIs | New APIs | |
| 164 | +| :------- | :------- | |
| 165 | +| `BarcodeReader.initLicense` | `LicenseManager.initLicense` | |
| 166 | + |
| 167 | +Process Single Image: |
| 168 | + |
| 169 | +| Old APIs | New APIs | |
| 170 | +| :------- | :------- | |
| 171 | +| `BarcodeReader.decodeFile` | `CaptureVisionRouter.capture(String filePath, String templateName)` | |
| 172 | +| `BarcodeReader.decodeFileInMemory` | `CaptureVisionRouter.capture(byte[] fileBytes, String templateName)` | |
| 173 | +| `BarcodeReader.decodeBuffer` | `CaptureVisionRouter.capture(ImageData imageData, String templateName)` | |
| 174 | +| `BarcodeReader.decodeBufferedImage` | `CaptureVisionRouter.capture(Bitmap bitmap, String templateName)` | |
| 175 | +| `class TextResult` | `class BarcodeResultItem` | |
| 176 | +| `BarcodeReader.decodeBase64String` | **Currently not available**. | |
| 177 | + |
| 178 | +Process the video streaming: |
| 179 | + |
| 180 | +| Old APIs | New APIs | |
| 181 | +| :------- | :------- | |
| 182 | +| `BarcodeReader.setImageSource` | `CaptureVisionRouter.setInput` | |
| 183 | +| `BarcodeReader.startScanning` | `CaptureVisionRouter.startCapturing` | |
| 184 | +| `BarcodeReader.stopScanning` | `CaptureVisionRouter.stopCapturing` | |
| 185 | +| `BarcodeReader.setTextResultListener` | `CaptureVisionRouter.addResultReceiver` | |
| 186 | +| `BarcodeReader.setIntermediateResultListener` | `CaptureVisionRouter.IntermediateResultManager.addResultReceiver` | |
| 187 | +| `BarcodeReader.set/getMinImageReadingInterval` | `SimplifiedCaptureVisionSettings.minImageCaptureInterval` | |
| 188 | +| `BarcodeReader.enableResultVerification` | `MultiFrameResultCrossFilter.enableResultCrossVerification` | |
| 189 | +| `BarcodeReader.enableDuplicateFilter` | `MultiFrameResultCrossFilter.enableResultDeduplication` | |
| 190 | +| `interface ImageSource` | `interface ImageSourceAdapter` | |
| 191 | +| `interface TextResultListener` | `interface CapturedResultReceiver` | |
| 192 | +| `interface IntermediateResultListener` | `interface IntermediateResultReceiver` | |
| 193 | +| `class TextResult` | `class BarcodeResultItem` | |
| 194 | + |
| 195 | +Template and Settings Management: |
| 196 | + |
| 197 | +| Old APIs | New APIs | |
| 198 | +| :------- | :------- | |
| 199 | +| `BarcodeReader.initRuntimeSettingsWithFile` | `CaptureVisionRouter.initSettingsFromFile` | |
| 200 | +| `BarcodeReader.initRuntimeSettingsWithString` | `CaptureVisionRouter.initSettings` | |
| 201 | +| `BarcodeReader.outputSettingsToFile` | `CaptureVisionRouter.outputSettingsToFile` | |
| 202 | +| `BarcodeReader.outputSettingsToString` | `CaptureVisionRouter.outputSettings` | |
| 203 | +| `BarcodeReader.resetRuntimeSettings` | `CaptureVisionRouter.resetSettings` | |
| 204 | +| `BarcodeReader.appendTplFileToRuntimeSettings` | **Not available**. | |
| 205 | +| `BarcodeReader.appendTplStringToRuntimeSettings` | **Not available**. | |
| 206 | +| `BarcodeReader.getRuntimeSettings` | `CaptureVisionRouter.getSimplifiedSettings` | |
| 207 | +| `BarcodeReader.updateRuntimeSettings` | `CaptureVisionRouter.updateSettings` | |
| 208 | +| `PublicRuntimeSettings.region` | `SimplifiedCaptureVisionSettings.roi` & `SimplifiedCaptureVisionSettings.roiMeasuredInPercentage` | |
| 209 | +| `PublicRuntimeSettings.timeout` | `SimplifiedCaptureVisionSettings.timeout` | |
| 210 | +| `PublicRuntimeSettings.minBarcodeTextLength` | `SimplifiedBarcodeReaderSettings.minBarcodeTextLength` | |
| 211 | +| `PublicRuntimeSettings.minResultConfidence` | `SimplifiedBarcodeReaderSettings.minResultConfidence` | |
| 212 | +| `PublicRuntimeSettings.localizationModes` | `SimplifiedBarcodeReaderSettings.localizationModes` | |
| 213 | +| `PublicRuntimeSettings.expectedBarcodesCount` | `SimplifiedBarcodeReaderSettings.expectedBarcodesCount` | |
| 214 | +| `PublicRuntimeSettings.barcodeFormatIds` | `SimplifiedBarcodeReaderSettings.barcodeFormatIds` | |
| 215 | +| `PublicRuntimeSettings.barcodeFormatIds_2` | `SimplifiedBarcodeReaderSettings.barcodeFormatIds` | |
| 216 | +| `PublicRuntimeSettings.deblurModes` | `SimplifiedBarcodeReaderSettings.deblurModes` | |
| 217 | +| `PublicRuntimeSettings.deblurLevel` | **Not available**, use `SimplifiedBarcodeReaderSettings.deblurLevel`. | |
| 218 | +| `PublicRuntimeSettings.maxAlgorithmThreadCount` | `SimplifiedBarcodeReaderSettings.maxThreadsInOneTask` | |
| 219 | +| `FurtherModes.grayscaleTransformationModes` | `SimplifiedBarcodeReaderSettings.grayscaleTransformationModes` | |
| 220 | +| `FurtherModes.imagePreprocessingModes` | `SimplifiedBarcodeReaderSettings.grayscaleEnhancementModes` | |
| 221 | +| `FurtherModes.scaleDownThreshold` | `SimplifiedBarcodeReaderSettings.scaleDownThreshold` | |
| 222 | + |
| 223 | +Please use the [online template converter](https://www.dynamsoft.com/tools/template-upgrade/) to upgrade your template if you are using `initRuntimeSettingsWithFile` or `initRuntimeSettingsWithString`. |
| 224 | + |
| 225 | +**Useful links** |
| 226 | + |
| 227 | +- [`CaptureVisionRouter`]({{ site.dcvb_android_api }}capture-vision-router/capture-vision-router.html) |
| 228 | +- [`SimplifiedCaptureVisionSettings`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html) |
| 229 | +- [`SimplifiedBarcodeReaderSettings`]({{ site.dbr_android_api }}simplified-barcode-reader-settings.html) |
0 commit comments