Skip to content

use-runtimesettings-or-templates.md

Latest commit

 

History

History
300 lines (270 loc) · 12.9 KB

use-runtimesettings-or-templates.md

File metadata and controls

300 lines (270 loc) · 12.9 KB
layout default-layout
description This article introduces two ways to configure DBR parameters, SimplifiedCaptureVisionSettings and JSON Template, and their syntax rules.
title Use SimplifiedCaptureVisionSettings or JSON Template
keywords DBR SimplifiedCaptureVisionSettings Json Template ImageParameter FormatSpecification
needAutoGenerateSidebar true
needGenerateH3Content true
noTitleIndex true

Use SimplifiedCaptureVisionSettings or JSON Template

Dynamsoft Barcode Reader (DBR) provides two ways for configuring the parameters: via SimplifiedCaptureVisionSettings or via a JSON Template.

  • SimplifiedCaptureVisionSettings

    SimplifiedCaptureVisionSettings is an object that manages various parameters during runtime. If you need to dynamically configure the reading process, use SimplifiedCaptureVisionSettings.

    However, bear in mind that SimplifiedCaptureVisionSettings doesn't provide all the available configuration options of the SDK.

  • JSON Template

    With a JSON template, you can make use of all the configuration options that DBR offers.

    However, compared with SimplifiedCaptureVisionSettings, a template is static and can't be changed. If you need to use different settings for different scenarios, you can define a few templates and specify the proper one to use at runtime.

SimplifiedCaptureVisionSettings

SimplifiedCaptureVisionSettings is an object that manages various runtime settings of the DBR SDK which dictate the performance of the barcode reader.

Basic steps:

  1. Get the current value of the SimplifiedCaptureVisionSettings object
  2. Change one or more settings
  3. Update the SimplifiedCaptureVisionSettings object with the changed copy for the changes to take effect

The following code snippet demonstrates how to specify barcode formats via SimplifiedCaptureVisionSettings.

>- JavaScript >- C++ >- Android >- Objective-C >- Swift >- Python >- C# >- Java > > ```javascript // Obtain current runtime settings of `router` instance. Here we use `ReadSingleBarcode` as an example. You can change it to your own template name or the name of other preset template. let settings = await router.getSimplifiedSettings("ReadSingleBarcode"); // Specify the barcode formats by enumeration values. // Use "|" to enable multiple barcode formats at one time. settings.barcodeSettings.barcodeFormatIds = Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE | Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE; // Update the settings to a specific template. await router.updateSettings("ReadSingleBarcode", settings); ``` > ```c++ char szErrorMsg[256] = {0}; // Obtain current runtime settings of `CCaptureVisionRouter` instance. CCaptureVisionRouter* cvRouter = new CCaptureVisionRouter; SimplifiedCaptureVisionSettings settings; cvRouter->GetSimplifiedSettings(CPresetTemplate::PT_READ_BARCODES, &settings); // Specify the barcode formats by enumeration values. // Use "|" to enable multiple barcode formats at one time. settings.barcodeSettings.barcodeFormatIds = BF_QR_CODE | BF_ONED; // Update the settings. cvRouter->UpdateSettings(CPresetTemplate::PT_READ_BARCODES, &settings, szErrorMsg, 256); ``` > ```java try { // `cvr` is an instance of `CaptureVisionRouter`. SimplifiedCaptureVisionSettings captureVisionSettings = cvr.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES); captureVisionSettings.barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_ONED; cvr.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, captureVisionSettings); } catch (CaptureVisionRouterException e) { e.printStackTrace(); } ``` > ```objc NSError *error; // `cvr` is an instance of `DSCaptureVisionRouter`. DSSimplifiedCaptureVisionSettings *cvrRuntimeSettings = [cvr getSimplifiedSettings:DSPresetTemplateReadBarcodes error:&error]; cvrRuntimeSettings.barcodeSettings.barcodeFormatIds = DSBarcodeFormatQRCode | DSBarcodeFormatOned; [cvr updateSettings:DSPresetTemplate.PT_READ_BARCODES settings:cvrRuntimeSettings error:&error]; ``` > ```swift guard let cvrRuntimeSettings = try? cvr.getSimplifiedSettings(template.rawValue) else { return } cvrRuntimeSettings.barcodeSettings?.barcodeFormatIds = .qrCode | .oneD do { try cvr.updateSettings(template.rawValue, settings:cvrRuntimeSettings) } catch { print("update runtimeSettings error:\(error.localizedDescription)") } ``` > ```python cvr_instance = CaptureVisionRouter() # Obtain current runtime settings of `CCaptureVisionRouter` instance. err_code, err_str, settings = cvr_instance.get_simplified_settings(EnumPresetTemplate.PT_READ_BARCODES.value) # Specify the barcode formats by enumeration values. # Use "|" to enable multiple barcode formats at one time. settings.barcode_settings.barcode_format_ids = EnumBarcodeFormat.BF_QR_CODE.value | EnumBarcodeFormat.BF_ONED.value # Update the settings. err_code, err_str = cvr_instance.update_settings(EnumPresetTemplate.PT_READ_BARCODES.value, settings) ``` > ```csharp using (CaptureVisionRouter cvRouter = new CaptureVisionRouter()) { SimplifiedCaptureVisionSettings settings; string errorMsg; // Obtain current runtime settings of `CCaptureVisionRouter` instance. cvRouter.GetSimplifiedSettings(PresetTemplate.PT_READ_BARCODES, out settings); // Specify the barcode formats by enumeration values. // Use "|" to enable multiple barcode formats at one time. settings.barcodeSettings.barcodeFormatIds = (ulong)(EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_ONED); // Update the settings. cvRouter.UpdateSettings(PresetTemplate.PT_READ_BARCODES, settings, out errorMsg); } ``` > ```java CaptureVisionRouter cvRouter = new CaptureVisionRouter(); SimplifiedCaptureVisionSettings settings = null; try { // Obtain current runtime settings of `CaptureVisionRouter` instance settings = cvRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES); } catch (CaptureVisionException e) { settings = new SimplifiedCaptureVisionSettings(); } // Specify the barcode formats by enumeration values. // Use "|" to enable multiple barcode formats at one time. settings.barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_ONED; try { // Update the settings. cvRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, settings); } catch (CaptureVisionException e) { System.out.println("Update settings failed: ErrorCode: " + e.getErrorCode() + ", ErrorString: " + e.getErrorString()); return; } //call capture or other tasks ```

See Also

  • SimplifiedCaptureVisionSettings: [C++]({{ site.dcvb_cpp_api }}capture-vision-router/structs/simplified-capture-vision-settings.html) / JavaScript / [Python]({{ site.dcvb_python_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html) / [.NET]({{ site.dcvb_dotnet_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html)
  • SimplifiedBarcodeReaderSettings: [C++]({{ site.cpp_api }}simplified-barcode-reader-settings.html) / JavaScript / [Python]({{ site.python_api }}simplified-barcode-reader-settings.html) / [.NET]({{ site.dotnet_api }}simplified-barcode-reader-settings.html)

JSON Template

With a JSON template, you can make use of all the configuration options that DBR offers.

Basic steps:

  1. Build a JSON template and configure the required parameters
  2. Save the template to a file or convert it to string
  3. Call method InitSettingsFromFile or InitSettings to apply the settings

Read [Parameter Template Structure]({{ site.dcvb_parameters }}file/index.html) to learn more about the structure of templates.

JavaScript edition only supports importing a JSON string and not a file.

The following steps demonstrates how to specify barcode formats via JSON Template.

  • Build a most basic JSON template and configure parameter BarcodeFormatIds
 {
     "CaptureVisionTemplates": [
         {
             "Name" : "CV_0",
             "ImageROIProcessingNameArray": ["TA_0" ]
         }
     ],
     "TargetROIDefOptions" : [
         {
             "Name" : "TA_0",
             "TaskSettingNameArray": [ "BR_0" ]
         }
     ],
     "BarcodeReaderTaskSettingOptions": [
         {
             "Name" : "BR_0",
             "BarcodeFormatIds" : ["BF_ONED", "BF_QR_CODE"]
         }
     ]
 }

  • Save the above template to file setting.json or Convert the above content into a string format for the respective programming language.

  • Call method InitSettingsFromFile or InitSettings to apply the settings

    >- JavaScript >- C++ >- Android >- Objective-C >- Swift >- Python >- C# >- Java > > ```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"); ``` > ```c++ 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 ``` > ```java try { // `cvr` is an instance of `CaptureVisionRouter`. cvr.initSettingsFromFile("PATH-TO-YOUR-SETTING-FILE"); } catch (CaptureVisionRouterException e) { e.printStackTrace(); } ``` > ```objc NSError *error; // `cvr` is an instance of `DSCaptureVisionRouter`. [self.cvr initSettingsFromFile:@"PATH-TO-YOUR-SETTING-FILE" error:&error]; ``` > ```swift do{ //`cvr` is an instance of `CaptureVisionRouter`. try cvr.initSettingsFromFile("PATH-TO-YOUR-SETTING-FILE") }catch{ // Add code to do when error occurs. } ``` > ```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 ``` > ```csharp int errorCode = 1; string errorMsg; using (CaptureVisionRouter cvRouter = new CaptureVisionRouter()) { string templateFile = "PATH-TO-YOUR-SETTING-FILE"; errorCode = cvRouter.InitSettingsFromFile(templateFile, out errorMsg); //string templateString = ""; //errorCode = cvRouter.InitSettings(templateString, out errorMsg); if (errorCode != (int)EnumErrorCode.EC_OK) { Console.WriteLine("Init template failed: " + errorMsg); } // more process here } ``` > ```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 ```

Mixed Usage

It's also possible to use a JSON Template along with SimplifiedCaptureVisionSettings. Typically, you initialize the SDK with a JSON Template, the settings in which will be reflected in SimplifiedCaptureVisionSettings, then you can further fine-tune SimplifiedCaptureVisionSettings to apply to the actual reading process.

NOTE: If your JSON template contains complex configurations that cannot be represented in SimplifiedCaptureVisionSettings, you may encounter an error message like "complex template can't be converted to simplified settings" when calling getSimplifiedSettings(). In such cases, you should either:

  • Simplify your JSON template so that it can be converted to SimplifiedCaptureVisionSettings, or
  • Continue using the JSON template exclusively without attempting to retrieve or update simplified settings.