Dev Center
Table of contents

Thanks for Downloading Dynamic Web TWAIN 30-Day Trial!

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

{WebTwainObject}.Addon.BarcodeReader

{WebTwainObject} denotes the WebTwain instance.

Methods

     
decode() getRuntimeSettings() updateRuntimeSettings()
resetRuntimeSettings() initRuntimeSettingsWithString()  

decode()

Read an image in the buffer and try to locate and decode barcode(s) on it. Please refer to TextResult.

Syntax

decode(index: number): Promise<TextResult[]> ;

Parameters

index: Specify the image to decode.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux)
v14.3.1+ v14.1+ not supported not supported not supported

getRuntimeSettings()

Return the current runtime settings or the settings of the specified built-in template. Please refer to RuntimeSettings.

The template can only be “speed”, “balance”, or “coverage”.

Syntax

getRuntimeSettings(template?: string): Promise<RuntimeSettings> ;

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux)
v14.3.1+ v14.1+ not supported not supported not supported

updateRuntimeSettings()

Update the runtime settings with a given object or use the string “speed”, “balance”, or “coverage” to use our preset settings. The default setting is “coverage”.

Syntax

updateRuntimeSettings(settings: RuntimeSettings): Promise<RuntimeSettings> ;

Parameters

settings: Specify the runtime settings. Please refer to RuntimeSettings.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux)
v14.3.1+ v14.1+ not supported not supported not supported

Example

DWObject.Addon.BarcodeReader.getRuntimeSettings("balance")
  .then(function (settings) {
    settings.barcodeFormatIds = Dynamsoft.DBR.EnumBarcodeFormat.BF_ONED;
    return DWObject.Addon.BarcodeReader.updateRuntimeSettings(settings);
  })
  .then(function () {
    DWObject.Addon.BarcodeReader.decode(0).then(
      function (textResult) {
        console.log(textResult);
      },
      function (ex) {
        console.log(ex.message || ex);
      }
    );
  });

resetRuntimeSettings()

Reset all runtime settings to default values. Please refer to RuntimeSettings.

Syntax

resetRuntimeSettings(): Promise<RuntimeSettings> ;

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux)
v14.3.1+ v14.1+ not supported not supported not supported

initRuntimeSettingsWithString()

Set up the barcode reader with advanced settings.

Syntax

initRuntimeSettingsWithString(
    settings: string
): Promise<RuntimeSettings> ;

Parameters

settings: The runtime setting in the form of a string.

Return value

Please refer to RuntimeSettings.

Availability

ActiveX H5(Windows) H5(macOS/TWAIN) H5(macOS/ICA) H5(Linux)
v16.0+ v16.0+ not supported not supported not supported

Is this page helpful?

YesYes NoNo

In this article:

latest version

    • Latest Version (18.4)
    • Version 18.3
    • Version 18.1
    • Version 18.0
    • Version 17.3
    • Version 17.2.1
    • Version 17.1.1
    • Version 17.0
    • Version 16.2
    • Version 16.1.1
    Change +