Dynamsoft Barcode Reader

https://www.dynamsoft.com/barcode-reader/docs/
Admin
A comprehensive SDK for integrating barcode scanning and reading capabilities into web, mobile, and...
Tokens:457,103
Snippets:7,671
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Project Dependencies

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/react-native/foundational-user-guide.html

Commands to finalize the installation of all project dependencies.

```bash
# using npm
npm install

# OR using Yarn
yarn install__
```

--------------------------------

### Initialize Expo Project and Install Dependencies

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/react-native/expo-guide.html

Commands to prebuild the Expo project and install the necessary Dynamsoft packages for barcode scanning.

```bash
npx expo prebuild
npx expo install dynamsoft-capture-vision-react-native dynamsoft-barcode-reader-bundle-react-native
npx expo run:android / ios
```

--------------------------------

### Get QR Code Details across platforms

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/get-detailed-info.html?lang=cpp

Examples demonstrating how to extract version and model information from detected QR codes in various programming languages.

```javascript
const result = await cvRouter.capture(file, "ReadSingleBarcode");
for (let item of result.items) {
  if (item.type === Dynamsoft.Core.EnumCapturedResultItemType.CRIT_BARCODE) {
    console.log("QR_version: " + item.details.version);
    console.log("QR_model: " + item.details.model);
  }
}
```

```cpp
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
CCapturedResult* result = cvRouter->Capture("IMAGE-FILE-PATH", CPresetTemplate::PT_READ_BARCODES);
if (result->GetErrorCode() != 0) {
    cout << "Error: " << result->GetErrorCode() << "," << result->GetErrorString() << endl;
}
int capturedResultItemCount = result->GetItemsCount();
for (int j = 0; j < capturedResultItemCount; j++)
{
    const CCapturedResultItem* capturedResultItem = result->GetItem(j);
    CapturedResultItemType type = capturedResultItem->GetType();
    if (type == CapturedResultItemType::CRIT_BARCODE)
    {
        const CBarcodeResultItem* barcodeResultItem = dynamic_cast<const CBarcodeResultItem*> (capturedResultItem);
        if (barcodeResultItem->GetFormat() == BarcodeFormat::BF_QR_CODE)
        {
            const CQRCodeDetails* detail = dynamic_cast<const CQRCodeDetails*>(barcodeResultItem->GetDetails());
            cout << "Version: " << detail->version;
            cout << "Model: " << detail->model;
        }
    }
}
// more process here
```

```android
public void onDecodedBarcodesReceived(DecodedBarcodesResult result) {
    if (result != null){
        BarcodeResultItem[] items = result.getItems();
        for (int i=0; i < items.length; i++){
            BarcodeResultItem item = items[i];
            Log.i("DecodedBarcodes", "onDecodedBarcodesReceived: This is the number "+i+" barcode");
            QRCodeDetails qrDetails = (QRCodeDetails) item.getDetails();
            int version = qrDetails.getVersion();
            Log.i("DecodedBarcodes", "The version of the QR barcode is: "+version);
            int model = qrDetails.getModel();
            Log.i("DecodedBarcodes", "The model of the QR barcode is: "+model);
        }
    }
}
```

```objective-c
- (void)onDecodedBarcodesReceived:(DSDecodedBarcodesResult *)result {
    if (result.items.count > 0) {
        for (DSBarcodeResultItem *item in result.items) {
            DSQRCodeDetails *qrDetails = (DSQRCodeDetails *) item.details;
            NSInteger version = qrDetails.version;
            NSInteger model = qrDetails.model;
        }
    }
}
```

```swift
func onDecodedBarcodesReceived(_ result: DecodedBarcodesResult) {
    if let items = result.items, items.count > 0 {
        for item in items {
            let qrCodeDetails = item.details as! QRCodeDetails
            let version = qrCodeDetails.version
            let model = qrCodeDetails.model
        }
    }
}
```

```python
cvr_instance = CaptureVisionRouter()
result = cvr_instance.capture("IMAGE-FILE-PATH", EnumPresetTemplate.PT_READ_BARCODES.value)
if result.get_error_code() != EnumErrorCode.EC_OK:
    print("Error:", result.get_error_code(), result.get_error_string())
barcode_result = result.get_decoded_barcodes_result()
if barcode_result is None or barcode_result.get_items() == 0:
    print("No barcode detected.")
else:
    items = barcode_result.get_items()
    print("Decoded", len(items), "barcodes.")
    for index,item in enumerate(items):
        if item.get_format() == EnumBarcodeFormat.BF_QR_CODE.value:
            qrDetail = item.get_details()
            print("Version:", qrDetail.version)
            print("Model:", qrDetail.model)
```

--------------------------------

### Install Dependencies

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/react-native/expo-guide.html

Install the required Dynamsoft packages in the project root.

```bash
npx expo install dynamsoft-capture-vision-react-native dynamsoft-barcode-reader-bundle-react-native
```

--------------------------------

### Install the new SDK package

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/python/migrate-from-v9

Use this command to install the renamed bundle package required for version 10.0 and later.

```bash
pip install dynamsoft-barcode-reader-bundle__
```

--------------------------------

### Install CocoaPods

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/react-native/expo-guide.html

Install iOS dependencies after generating the native project.

```bash
cd ios
pod install
cd ..
```

--------------------------------

### Hello World Implementation

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide?ver=latest

A complete HTML example demonstrating the minimum code required to initialize the SDK and read barcodes from a live camera feed.

```html
<!DOCTYPE html>
<html>
<body>
<div id="camera-view-container" style="width: 100%; height: 60vh"></div>
<textarea id="results" style="width: 100%; min-height: 10vh; font-size: 3vmin; overflow: auto" disabled></textarea>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.3000/dist/dbr.bundle.js"></script>
<script>
  Dynamsoft.License.LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
  Dynamsoft.Core.CoreModule.loadWasm();
  (async () => {
    let cvRouter = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();

    let cameraView = await Dynamsoft.DCE.CameraView.createInstance();
    let cameraEnhancer = await Dynamsoft.DCE.CameraEnhancer.createInstance(cameraView);
    document.querySelector("#camera-view-container").append(cameraView.getUIElement());
    cvRouter.setInput(cameraEnhancer);

    const resultsContainer = document.querySelector("#results");
    await cvRouter.addResultReceiver({ onDecodedBarcodesReceived: (result) => {
      if (result.barcodeResultItems?.length) {
        resultsContainer.textContent = '';
        for (let item of result.barcodeResultItems) {
          resultsContainer.textContent += `${item.formatString}: ${item.text}\n\n`;
        }
      }
    }});

    let filter = new Dynamsoft.Utility.MultiFrameResultCrossFilter();
    filter.enableResultCrossVerification("barcode", true);
    filter.enableResultDeduplication("barcode", true);
    await cvRouter.addResultFilter(filter);

    await cameraEnhancer.open();
    await cvRouter.startCapturing("ReadSingleBarcode");
  })();
</script>
</body>
</html>
```

--------------------------------

### Install CocoaPods dependencies

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/objectivec-swift/migrate-from-v10

Run this command in your terminal to install the specified frameworks and generate the workspace file.

```bash
pod install__
```

--------------------------------

### Install Dynamsoft Barcode Reader SDK

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/python/user-guide.html

Use pip to install the required bundle in your terminal or command prompt.

```bash
pip install dynamsoft-barcode-reader-bundle
```

--------------------------------

### Install iOS Native Frameworks

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/react-native/foundational-user-guide.html

Command to install necessary native frameworks via CocoaPods for iOS development.

```bash
cd ios
pod install__
```

--------------------------------

### Install DBR-JS SDK via NPM

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/use-in-framework.html

Command to install the specific version of the Dynamsoft Barcode Reader bundle.

```bash
npm install dynamsoft-barcode-reader-bundle@11.4.3000 -E
```

--------------------------------

### Install SDK via Package Manager

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide?ver=latest

Commands to add the SDK as a dependency in modern web frameworks.

```bash
npm i dynamsoft-barcode-reader-bundle@11.4.3000 -E
# or
yarn add dynamsoft-barcode-reader-bundle@11.4.3000 -E__
```

```bash
npm i dynamsoft-barcode-reader-bundle@11.4.3000 -E__
```

--------------------------------

### Verify package.json dependencies

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/use-in-framework.html

Example of the expected dependency entry in package.json, ensuring an exact version is used.

```json
{
  ...
  "dependencies": {
    ...
    "dynamsoft-barcode-reader-bundle": "11.4.3000"
  }
}
```

--------------------------------

### Get Confidence and Angle across Platforms

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/get-confidence-rotation.html?lang=cpp

Examples demonstrating how to extract confidence and rotation angle from barcode result items in multiple programming languages.

```JavaScript
const result = await cvRouter.capture(file, "ReadSingleBarcode");
for (let item of result.items) {
  if (item.type === Dynamsoft.Core.EnumCapturedResultItemType.CRIT_BARCODE) {
    console.log("confidence: " + item.confidence);
    console.log("angle: " + item.angle);
  }
}
```

```C++
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
CCapturedResult* result = cvRouter->Capture("IMAGE-FILE-PATH", CPresetTemplate::PT_READ_BARCODES);
if (result->GetErrorCode() != 0) {
    cout << "Error: " << result->GetErrorCode() << "," << result->GetErrorString() << endl;
}
int capturedResultItemCount = result->GetItemsCount();
for (int j = 0; j < capturedResultItemCount; j++)
{
    const CCapturedResultItem* capturedResultItem = result->GetItem(j);
    CapturedResultItemType type = capturedResultItem->GetType();
    if (type == CapturedResultItemType::CRIT_BARCODE)
    {
        const CBarcodeResultItem* barcodeResultItem = dynamic_cast<const CBarcodeResultItem*> (capturedResultItem);
        cout << "Result " << j + 1 << endl;
        cout << "Confidence: " << barcodeResultItem->GetConfidence() << endl;
        cout << "Angle: " << barcodeResultItem->GetAngle() << endl;
    }
}
// more process here
```

```Android
public void onDecodedBarcodesReceived(DecodedBarcodesResult result) {
    if (result != null){
        BarcodeResultItem[] items = result.getItems();
        for (int i=0; i < items.length; i++){
            BarcodeResultItem item = items[i];
            Log.i("DecodedBarcodes", "onDecodedBarcodesReceived: This is the number "+i+" barcode");
            int confidence = item.getConfidence();
            Log.i("DecodedBarcodes", "The confidence of the barcode is: "+confidence);
            int angle = item.getAngle();
            Log.i("DecodedBarcodes", "The rotation angle of the barcode is: "+angle);
        }
    }
}
```

```Objective-C
- (void)onDecodedBarcodesReceived:(DSDecodedBarcodesResult *)result {
    if (result.items.count > 0) {
        for (DSBarcodeResultItem *item in result.items) {
            NSInteger confidence = item.confidence;
            NSInteger angle = item.angle;
        }
    }
}
```

```Swift
func onDecodedBarcodesReceived(_ result: DecodedBarcodesResult) {
    if let items = result.items, items.count > 0 {
        for item in items {
            let confidence = item.confidence
            let angle = item.angle
        }
    }
}
```

```Python
cvr_instance = CaptureVisionRouter()
result = cvr_instance.capture("IMAGE-FILE-PATH", EnumPresetTemplate.PT_READ_BARCODES.value)
if result.get_error_code() != EnumErrorCode.EC_OK:
    print("Error:", result.get_error_code(), result.get_error_string())
barcode_result = result.get_decoded_barcodes_result()
if barcode_result is None or barcode_result.get_items() == 0:
    print("No barcode detected.")
else:
    items = barcode_result.get_items()
    print("Decoded", len(items), "barcodes.")
    for index,item in enumerate(items):
        quad = item.get_location()
        print("Result", index+1)
        print("Confidence: {0}".format(item.get_confidence()))
        print("Angle: {0}".format(item.get_angle()))
```

--------------------------------

### Initialize Settings in C++

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/use-runtimesettings-or-templates.html

Use InitSettingsFromFile or InitSettings to load configurations.

```cpp
char szErrorMsg[256] = {0};
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
cvRouter->InitSettingsFromFile("PATH-TO-SETTING-FILE", szErrorMsg, 256);
//cvRouter->InitSettings("{\"CaptureVisionTemplates\":[{\"Name\":\"CV_0\",\"ImageROIProcessingNameArray\":[\"TA_0\"]}],\"TargetROIDefOptions\":[{\"Name\":\"TA_0\",\"TaskSettingNameArray\":[\"BR_0\"]}],\"BarcodeReaderTaskSettingOptions\":[{\"Name\":\"BR_0\",\"BarcodeFormatIds\":[\"BF_ONED\",\"BF_QR_CODE\"]}]}", szErrorMsg, 256);
// more process here
```

--------------------------------

### Initialize React Native Project

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/react-native/foundational-user-guide.html

Use the React Native CLI to scaffold a new project.

```bash
npx @react-native-community/cli init BarcodeScanner
```

--------------------------------

### Install Dynamsoft Barcode Reader

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript

Methods for including the library via CDN or npm.

```html
<!-- CDN -->
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.4.3000/dist/dbr.bundle.js"></script>__
```

```bash
# Or via npm
npm install dynamsoft-barcode-reader-bundle@11.4.3000__
```

--------------------------------

### Start barcode capturing

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/index.html

Initiates the scanning process using a predefined template.

```javascript
cvRouter.startCapturing("ReadSingleBarcode");
```

--------------------------------

### Initialize .NET MAUI Project via CLI

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/maui/user-guide.html

Commands to create a new MAUI project and open it in VS Code.

```bash
dotnet new maui -n ScanBarcodes
cd ScanBarcodes
```

```bash
code .
```

--------------------------------

### Configure Barcode Format and Image Output

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide

Examples for updating template settings to filter barcode formats, retrieve original images, or combine both requirements.

```javascript
let settings = await cvRouter.getSimplifiedSettings("ReadSingleBarcode");
settings.barcodeSettings.barcodeFormatIds = Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE;
await cvRouter.updateSettings("ReadSingleBarcode", settings);
await cvRouter.startCapturing("ReadSingleBarcode");__
```

```javascript
let settings = await cvRouter.getSimplifiedSettings("ReadSingleBarcode");
settings.outputOriginalImage = true;
await cvRouter.updateSettings("ReadSingleBarcode", settings);
await cvRouter.startCapturing("ReadSingleBarcode");__
```

```javascript
let settings = await cvRouter.getSimplifiedSettings("ReadSingleBarcode");
settings.outputOriginalImage = true;
settings.barcodeSettings.barcodeFormatIds = Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE;
await cvRouter.updateSettings("ReadSingleBarcode", settings);
await cvRouter.startCapturing("ReadSingleBarcode");__
```

--------------------------------

### Start video streaming and barcode processing

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide?ver=latest

Initiates the camera source and begins capturing frames using a specified preset template.

```javascript
await cameraEnhancer.open();
await cvRouter.startCapturing("ReadSingleBarcode");__
```

--------------------------------

### Initialize Settings in Swift

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/use-runtimesettings-or-templates.html

Apply settings from a file using a do-try-catch block.

```swift
do{
   //`cvr` is an instance of `CaptureVisionRouter`.
   try cvr.initSettingsFromFile("PATH-TO-YOUR-SETTING-FILE")
}catch{
   // Add code to do when error occurs.
}
```

--------------------------------

### Initialize License and Handle Callback

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/objectivec-swift/foundational-guide.html

Initialize the license manager with a trial key and implement the verification callback to handle potential errors.

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

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

--------------------------------

### Accessing startPatternRange

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/interfaces/oned-code-details.html

Defines the start and end X coordinates for the start pattern.

```typescript
startPatternRange: [number, number];
```

--------------------------------

### Initialize Expo Project

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/react-native/expo-guide.html

Commands to create a new Expo project and navigate into the directory.

```bash
npx create-expo-app ScanBarcodes
cd ScanBarcodes
```

--------------------------------

### Retrieve Start Characters

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/api-reference/auxiliary-OneDCodeDetails.html

Retrieves the start characters of the 1D barcode as a byte array.

```java
byte[] getStartCharsBytes();__
```

--------------------------------

### Build and Run on Linux

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/cplusplus/user-guide.html

Commands to compile the application and prepare necessary runtime files on Linux.

```bash
g++ -o DBRCPPSample DBRCPPSample.cpp -lDynamsoftCaptureVisionRouter -lDynamsoftLicense -lDynamsoftCore -lDynamsoftUtility -L ../Dist/Lib/Linux/x64 -Wl,-rpath=../Dist/Lib/Linux/x64 -std=c++11__
```

```bash
cp -r ../Dist/Templates ../Dist/Lib/Linux/x64/
cp -r ../Dist/Models ../Dist/Lib/Linux/x64/__
```

```bash
./DBRCPPSample__
```

--------------------------------

### Initializing the License Key

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/dotnet/user-guide.html

Initialize the SDK license within the Main method. A network connection is required for the provided trial license.

```csharp
int errorCode = 1;
string errorMsg;
errorCode = LicenseManager.InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", out errorMsg);
if (errorCode != (int)EnumErrorCode.EC_OK && errorCode != (int)EnumErrorCode.EC_LICENSE_CACHE_USED)
    Console.WriteLine("License initialization error: " + errorMsg);
```

--------------------------------

### Retrieve Start Pattern Range

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/api-reference/auxiliary-OneDCodeDetails.html

Retrieves the position range of the start pattern relative to the barcode location.

```java
Range<Float> getStartPatternRange();__
```

--------------------------------

### Initialize Camera Module

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/read-video-streaming-mobile.html?lang=android

Setup the camera view and enhancer to capture and display video streams.

```java
private CameraEnhancer mCamera;
private CaptureVisionRouter mRouter;
@Override
protected void onCreate(Bundle savedInstanceState) {
   super.onCreate(savedInstanceState);
   setContentView(R.layout.activity_main)
   PermissionUtil.requestCameraPermission(this);
   CameraView cameraView = findViewById(R.id.camera_view);
   mCamera = new CameraEnhancer(cameraView, this);
}
```

```objective-c
@property (nonatomic, strong) DSCameraView *cameraView;
@property (nonatomic, strong) DSCameraEnhancer *dce;
...
- (void)setUpCamera {
   self.cameraView = [[DSCameraView alloc] initWithFrame:self.view.bounds];
   self.cameraView.autoresizingMask = UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight;
   [self.view insertSubview:self.cameraView atIndex:0];
   self.dce = [[DSCameraEnhancer alloc] init];
   self.dce.cameraView = self.cameraView;
}
```

```swift
class ViewController: UIViewController {
   var cameraView:CameraView!
   let dce = CameraEnhancer()
   func setUpCamera() {
      cameraView = .init(frame: view.bounds)
      cameraView.autoresizingMask = [.flexibleWidth, .flexibleHeight]
      view.insertSubview(cameraView, at: 0)
      dce.cameraView = cameraView
   }
}
```

--------------------------------

### Initialize License in C++

Source: https://www.dynamsoft.com/barcode-reader/docs/core/license-activation/index.html

Use CLicenseManager::InitLicense to verify the license key before initializing the CaptureVisionRouter.

```cpp
int errorCode = 1;
char errorMsg[512];
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", errorMsg, 512);
if (errorCode != EC_OK)
    cout << "License initialization error: " << errorMsg << endl;
CCaptureVisionRouter *cvRouter = new CCaptureVisionRouter;
// add further process__
```

--------------------------------

### Initialize Settings in Python

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/use-runtimesettings-or-templates.html

Load settings from a file or string and check for errors.

```python
cvr_instance = CaptureVisionRouter()
template_file = 'PATH-TO-YOUR-SETTING-FILE'
errorCode, errorMsg = cvr_instance.init_settings_from_file(template_file)
# template_string = 'TEMPLATE-JSON-STRING'
# errorCode, errorMsg = cvr_instance.init_settings(template_string)
if errorCode != EnumErrorCode.EC_OK:
    raise Exception("Init template failed: " + errorMsg)
# more process here
```

--------------------------------

### Implementing Barcode Scanning in MainPage

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/maui/api-reference/barcode-scanner/barcode-scanner.html

Example showing how to initialize the scanner with a license key and handle the scan results within a ContentPage.

```csharp
using Dynamsoft.BarcodeReaderBundle.Maui;

namespace ScanBarcodes_ReadyToUseComponent;
public partial class MainPage : ContentPage
{
	public MainPage()
	{
		InitializeComponent();
	}

	private async void OnScanBarcode(object sender, EventArgs e)
    {
		// Initialize the license.
        // The license string here is a trial license. Note that network connection is required for this license to work.
        // You can request an extension via the following link: https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&utm_source=samples&package=mobile
        var config = new BarcodeScannerConfig("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
        var result = await BarcodeScanner.Start(config);
        var message = result.ResultStatus switch
        {
            EnumResultStatus.Finished => string.Join("\n",
                result.Barcodes!.Select(item => item.FormatString + "\n" + item.Text)),
            EnumResultStatus.Canceled => "Scanning canceled",
            EnumResultStatus.Exception => result.ErrorString,
            _ => throw new ArgumentOutOfRangeException()
        };
		label.Text = message;
    }
}__
```

--------------------------------

### Install the new NuGet package

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/dotnet/migrate-from-v9

Use this command to install the renamed bundle package required for version 10.0 and later.

```powershell
NuGet\Install-Package Dynamsoft.DotNet.BarcodeReader.Bundle__
```

--------------------------------

### Initialize Settings in Java

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/use-runtimesettings-or-templates.html

Load settings from a file or string with exception handling.

```java
CaptureVisionRouter cvRouter = new CaptureVisionRouter();
try {
    String templateFile = "PATH-TO-YOUR-SETTING-FILE";
    cvRouter.initSettingsFromFile(templateFile);
    // String templateString = "";
    // cvRouter.initSettings(templateString);
} catch (CaptureVisionRouterException e) {
    System.out.println("Init template failed: ErrorCode: " + e.getErrorCode() + ", ErrorString: " + e.getErrorString());
    return;
}
// more process here
```

--------------------------------

### Apply JSON Settings in C++

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/use-runtimesettings-or-templates.html?lang=java

Use InitSettingsFromFile or InitSettings to load configuration, providing a buffer for error messages.

```cpp
char szErrorMsg[256] = {0};
CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter;
cvRouter->InitSettingsFromFile("PATH-TO-SETTING-FILE", szErrorMsg, 256);
//cvRouter->InitSettings("{\"CaptureVisionTemplates\":[{\"Name\":\"CV_0\",\"ImageROIProcessingNameArray\":[\"TA_0\"]}],\"TargetROIDefOptions\":[{\"Name\":\"TA_0\",\"TaskSettingNameArray\":[\"BR_0\"]}],\"BarcodeReaderTaskSettingOptions\":[{\"Name\":\"BR_0\",\"BarcodeFormatIds\":[\"BF_ONED\",\"BF_QR_CODE\"]}]", szErrorMsg, 256);
// more process here
```

--------------------------------

### Initialize Settings in JavaScript

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/use-runtimesettings-or-templates.html

Apply settings via file path or JSON object string.

```javascript
// `router` is an instance of `CaptureVisionRouter`.
//  Specify the path to the settings file or provide a JSON object.
router.initSettings("PATH-TO-YOUR-SETTINGS-FILE-OR-OBJECT");
// Later in the code, specify the name of the template to use (e.g., "CV_0" in the sample template).
router.startCapturing("NAME-OF-TEMPLATE-TO-USE");
```

--------------------------------

### getPossibleFormats()

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/java/api-reference/localized-barcode-element.html

Gets the format of the barcode.

```APIDOC
## public long getPossibleFormats()

### Description
Gets the format of the barcode.

### Return Value
Returns the format of the barcode.
```

--------------------------------

### get_eci_segments

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/python/api-reference/decoded-barcode-element.html

Gets all the ECI segments in the barcode.

```APIDOC
## get_eci_segments

### Description
Gets all the ECI segments in the barcode.

### Signature
`def get_eci_segments(self) -> List[ECISegment]`

### Return Value
- **List[ECISegment]** - Returns a list of ECISegment objects. Returns an empty list if no ECI information is present.

### Remarks
Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.
```

--------------------------------

### CandidateBarcodeZone.get_location

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/python/api-reference/candidate-barcode-zone.html

Gets the location of the candidate barcode.

```APIDOC
## get_location(self) -> Quadrilateral

### Description
Gets the location of the candidate barcode.

### Return value
- **Quadrilateral** - The location of the candidate barcode.
```

--------------------------------

### getModuleSize()

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/java/api-reference/localized-barcode-element.html

Gets the module size of the barcode.

```APIDOC
## public int getModuleSize()

### Description
Gets the module size of the barcode.

### Return Value
Returns the module size of the barcode.
```

--------------------------------

### Initialize CameraView with a Custom Container

Source: https://www.dynamsoft.com/barcode-reader/docs/core/programming/features/ui-customization-js.html?lang=js

Demonstrates how to initialize the CameraView by passing a specific HTML container element to the instance creator.

```html
<div id="enhancerUIContainer" style="width:1280px;height:720px;background:#ddd;" >
  <div class="dce-video-container" style="width:100%;height:100%;"></div>
</div>
<script>
    (async () => {
      // Initializes the license for using the SDK in the application.
      Dynamsoft.License.LicenseManager.initLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9");
      // Create 'CameraView' instance and pass the element "enhancerUIContainer" as its UI.
      let cameraView = await Dynamsoft.DCE.CameraView.createInstance(document.getElementById("enhancerUIContainer"));
      let cameraEnhancer = await Dynamsoft.DCE.CameraEnhancer.createInstance(cameraView);
      await cameraEnhancer.open();
    })();
</script>__
```

--------------------------------

### getAngle()

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/java/api-reference/localized-barcode-element.html

Gets the orientation angle of the barcode.

```APIDOC
## public int getAngle()

### Description
Gets the orientation angle of the barcode.

### Return Value
Returns the orientation angle of the barcode.
```

--------------------------------

### Initialize SDK License

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/python/user-guide.html

Initialize the license key within the main method. A network connection is required for the provided public trial license.

```python
errorCode, errorMsg = LicenseManager.init_license("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9")
if errorCode != EnumErrorCode.EC_OK and errorCode != EnumErrorCode.EC_LICENSE_CACHE_USED:
    print("License initialization failed: ErrorCode:", errorCode, ", ErrorString:", errorMsg)
else:
    # codes from following steps
```

--------------------------------

### Start Capturing Process

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/java/user-guide.html

Initiate the processing of images using the configured router.

```java
try {
    cvRouter.startCapturing("", true);
} catch (CaptureVisionException e) {
    if (e.getErrorCode() != EnumErrorCode.EC_OK) {
        System.out.println("Error: " + e.getErrorCode());
    }
}
```

--------------------------------

### getECISegments

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/java/api-reference/barcode-result-item.html

Gets all the ECI segments in the barcode.

```APIDOC
## public ECISegment[] getECISegments()

### Description
Gets all the ECI segments in the barcode.

### Return Value
Returns an array of ECISegment objects. Returns an empty array if no ECI information is present.
```

--------------------------------

### GetLocalizedBarcodes

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/dotnet/api-reference/localized-barcodes-unit.html

Gets all localized barcode elements.

```APIDOC
## LocalizedBarcodeElement[] GetLocalizedBarcodes()

### Description
Gets all localized barcode elements.

### Return Value
Returns all the localized barcode elements.
```

--------------------------------

### Initialize SDK with Custom Template

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide/index.html

Load a custom configuration template from a file path to customize barcode detection settings.

```javascript
await cvRouter.initSettings("PATH-TO-THE-FILE"); // E.g. "https://your-website/ReadSingleBarcode.json")
await cvRouter.startCapturing("ReadSingleBarcode"); // Make sure the name matches one of the CaptureVisionTemplates in the template JSON file.
```

--------------------------------

### GetAngle

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/dotnet/api-reference/localized-barcode-element.html

Gets the orientation angle of the barcode.

```APIDOC
### int GetAngle()

Returns the orientation angle of the barcode.
```

--------------------------------

### GetCandidateBarcodeZones

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/dotnet/api-reference/candidate-barcode-zones-unit.html

Gets all candidate barcode zones.

```APIDOC
### int GetCandidateBarcodeZones(out CandidateBarcodeZone[] barcodeZones)

Gets all candidate barcode zones.

#### Parameters
- **barcodeZones** (out CandidateBarcodeZone[]) - The all candidate barcode zones.

#### Return Value
- **int** - Returns 0 if successful, otherwise returns a negative value.
```

--------------------------------

### Initialize CameraView and Modify UI Elements

Source: https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/user-guide?ver=latest

Demonstrates creating CameraView instances with default settings, custom XML paths, or specific DOM elements, and removing UI elements via query selectors.

```javascript
// Create a CameraView instance with default settings
let cameraView = await Dynamsoft.DCE.CameraView.createInstance();
// Create a CameraView instance with a specified XML file path, typically a local or remote URL
let cameraView1 = await Dynamsoft.DCE.CameraView.createInstance('@engineResourcePath/dce.ui.v5.xml');
// Create a CameraView instance within a specified DOM element
let cameraView2 = await Dynamsoft.DCE.CameraView.createInstance(document.getElementById('my-ui'));
// Create a CameraView instance using a custom UI file path
let cameraView3 = await Dynamsoft.DCE.CameraView.createInstance('url/to/my/ui.xml');

// Get the UI element associated with the cameraView instance
let uiElement = cameraView.getUIElement();
// Remove the camera selection dropdown from the CameraView's UI element
uiElement.querySelector('.dce-sel-camera').remove();
// Remove the resolution selection dropdown from the CameraView's UI element
uiElement.querySelector('.dce-sel-resolution').remove();__
```

--------------------------------

### getStartPatternRange

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/android/api-reference/auxiliary-OneDCodeDetails.html

Retrieves the position range of the start pattern.

```APIDOC
## Range<Float> getStartPatternRange()

### Description
Returns the position range of the start pattern relative to the barcode’s location.

### Return Value
A Range of numbers representing the position range of the start pattern.
```

--------------------------------

### Configure View Lifecycle Methods

Source: https://www.dynamsoft.com/barcode-reader/docs/mobile/programming/objectivec-swift/foundational-guide.html

Implement viewDidLoad, viewWillAppear, and viewWillDisappear to manage camera capture and resource initialization.

```objective-c
- (void)viewDidLoad {
   [super viewDidLoad];
   /**Do any additional setup after loading the view.*/
   [self setLicense];
   [self setUpCamera];
   [self setUpDCV];
}
- (void)viewWillAppear:(BOOL)animated {
   [self.dce open];
   [self.cvr startCapturing:DSPresetTemplateReadBarcodes completionHandler:^(BOOL isSuccess, NSError * _Nullable error) {
      if (!isSuccess && error != nil) {
         [self showResult:@"Error" message:error.localizedDescription completion:nil];
      }
   }];
   [super viewWillAppear:animated];
}
- (void)viewWillDisappear:(BOOL)animated {
   [self.dce close];
   [self.cvr stopCapturing];
   [super viewWillDisappear:animated];
}
```

```swift
override func viewDidLoad() {
   super.viewDidLoad()
   /**Do any additional setup after loading the view.*/
   setLicense()
   setUpCamera()
   setUpDCV()
}
override func viewWillAppear(_ animated: Bool) {
   dce.open()
   // Start capturing when the view will appear. If success, you will receive results in the CapturedResultReceiver. Otherwise you will receive the error message in a dialog.
   cvr.startCapturing(PresetTemplate.readBarcodes.rawValue) { isSuccess, error in
      if (!isSuccess) {
         if let error = error {
            self.showResult("Error", error.localizedDescription)
         }
      }
   }
   super.viewWillAppear(animated)
}
override func viewWillDisappear(_ animated: Bool) {
   dce.close()
   cvr.stopCapturing()
   super.viewWillDisappear(animated)
}
```

--------------------------------

### get_count

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/python/api-reference/localized-barcodes-unit.html

Gets the number of localized barcodes in the unit.

```APIDOC
### get_count() -> int

Gets the number of localized barcodes in the unit.

#### Return Value
- **int** - Returns the number of localized barcodes in the unit.
```

--------------------------------

### Initialize License Key

Source: https://www.dynamsoft.com/barcode-reader/docs/server/programming/cplusplus/user-guide.html

Initialize the license manager with a valid key. Network connectivity is required for public trial licenses.

```cpp
char errorMsg[512];
CLicenseManager::InitLicense("DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9", errorMsg, 512);__
```
Tokens:
Raw