Resource Base
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

RuntimeSettings

interface RuntimeSettings

  • barcodeFormatIds: number | EnumBarcodeFormat

    Sets the formats of the barcode in BarcodeFormat group 1 to be read. Barcode formats in BarcodeFormat group 1 can be combined.

    let runtimeSettings = await reader.getRuntimeSettings();
    runtimeSettings.barcodeFormatIds = Dynamsoft.DBR.EnumBarcodeFormat.BF_ONED | Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE;
    await reader.updateRuntimeSettings(runtimeSettings);
    


  • barcodeFormatIds_2: number | EnumBarcodeFormat_2

    Sets the formats of the barcode in BarcodeFormat group 2 to be read. Barcode formats in BarcodeFormat group 1 can be combined.


  • deblurLevel: number

    Sets the degree of blurriness of the barcode.


  • expectedBarcodesCount: number

    Sets the number of barcodes expected to be detected for each image.


  • localizationModes: number[] | EnumLocalizationMode[]

    Sets the mode and priority for localization algorithms.


  • minResultConfidence: number


  • region: RegionDefinition | RegionDefinition[]

    Sets the region definition including the regionTop, regionLeft, regionRight, regionBottom and regionMeasuredByPercentage.

    // Use a region of center 50% width and 50% height
    let runtimeSettings = await reader.getRuntimeSettings();
    runtimeSettings.region.regionLeft = 25;
    runtimeSettings.region.regionTop = 25;
    runtimeSettings.region.regionRight = 75;
    runtimeSettings.region.regionBottom = 75;
    runtimeSettings.region.regionMeasuredByPercentage = true;
    await reader.updateRuntimeSettings(runtimeSettings);
    

    Experimental feature:

    In BarcodeScanner, region can be an array. For example region = [r0, r1, r2], 0th frame use r0, 1st use r1, 2nd use r2, 3rd use r0, and then loop like this.

    let runtimeSettings = await reader.getRuntimeSettings();
    runtimeSettings.region = [
      null, // full image
      {regionLeft:25,regionTop:25,regionRight:75,regionBottom:75,regionMeasuredByPercentage:true}, // center 50% 
      {regionLeft:5,regionTop:45,regionRight:95,regionBottom:55,regionMeasuredByPercentage:true}, // width 90%, height 10% 
    ];
    await reader.updateRuntimeSettings(runtimeSettings);
    


  • resultCoordinateType: number | EnumResultCoordinateType


  • timeout: number

    Sets the maximum amount of time (in milliseconds) that should be spent searching for a barcode per page. It does not include the time taken to load/decode an image (Tiff, PNG, etc) from disk into memory.


Some advanced parameters are not listed. See C++ PublicRuntimeSettings for more info.

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

latest version

    • Latest version
    • Version 8.9.0
    • Version 8.8.0
    • Version 8.6.3
    • Version 8.6.1
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.5
    • Version 8.2.3
    • Version 8.2.1
    • Version 8.2.0
    • Version 8.1.3
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
    • Version 7.6.0
    • Version 7.5.0
    Change +
    © 2003–2022 Dynamsoft. All rights reserved.
    Privacy Statement / Site Map / Home / Purchase / Support