Get Pricing Download 30-Day Trial
Dev Center
Table of contents

Dynamsoft Barcode Reader SDK - JavaScript API Reference

BarcodeReader – Decode barcodes from images

BarcodeScanner – Decode barcodes from videos

Global Interfaces

Enumerations

  • BarcodeReader

The BarcodeReader class is used for image decoding.

BarcodeReader Class Methods

Initialize

The following methods are related to the initialization of BarcodeReader instances.

Method Description
createInstance Create a BarcodeReader instance.
detectEnvironment Detect the current environment.
isLoaded Check if the decoding module is loaded.
loadWasm Manually load and compile the decoding WASM module.

BarcodeReader Instance Methods

Destroy

Method Description
destroy Destroy the BarcodeReader instance.

Decode

The following methods are related to decoding barcodes.

Method Description
decode Decode barcodes from images, binary data, URLs, and more.
decodeBase64String Decode barcodes from a base64 encoded string.
decodeBuffer Decode barcodes from raw buffer.
decodeUrl Decode barcodes from a URL.

Parameter and Runtime Settings

The following methods are related to customizing mode and runtime settings.

Method Description
getRuntimeSettings Get current runtime settings.
resetRuntimeSettings Reset runtime settings to default.
updateRuntimeSettings Modify and update the current runtime settings.
getModeArgument Get argument value for the specified mode parameter.
setModeArgument Set argument value for the specified mode parameter.

BarcodeReader Class Properties

Property Description
_bUseFullFeature If set to true, use the full-featured WASM module.
engineResourcePath Get or set the engine (WASM) location.
productKeys Get or set the Dynamsoft Barcode Reader SDK product keys.
version Get the current version.
licenseServer Specify by URL the license server from where authorization is acquired at runtime.
handshakeCode Specify the Handshake Code which determines what authorization is acquired.
sessionPassword Specify a password which protects the Handshake Code from abuse.

BarcodeReader Instance Properties

Property Description
bDestroyed Indicates whether a BarcodeReader instance has been destroyed.
bSaveOriCanvas If set to true, save the original image in oriCanvas.
oriCanvas An OffscreenCanvas object that holds the original image.
_bUseWebgl Whether to enable image preprocessing with WebGL APIs, this API may change in the future.
  • BarcodeScanner

The BarcodeScanner class is used for video decoding.

BarcodeScanner Class Methods

Initialize

The following methods are related to the initialization of BarcodeScanner instances.

Method Description
createInstance Create a BarcodeScanner instance.
detectEnvironment Detect the current environment. Inherited from the BarcodeReader class.
isLoaded Check if the decoding module is loaded. Inherited from the BarcodeReader class.
loadWasm Manually load and compile the decoding WASM module. Inherited from the BarcodeReader class.

BarcodeScanner Instance Methods

The BarcodeScanner class is used for video decoding.

Destroy

Method Description
destroy Destroy the BarcodeScanner instance.

UI Element

Method Description
getUIElement Get HTML element containing the BarcodeScanner instance.
setUIElement Set html element containing the BarcodeScanner instance.

Camera Control

The following methods are related to controlling the camera and its settings.

Method Description
getAllCameras Get information of all available cameras on the device.
getCurrentCamera Get information about the currently used camera.
setCurrentCamera Set camera by its information or device ID.
show Show the camera UI element, open the camera, and start decoding.
showVideo Show the camera UI element, open the camera but do not start decoding.
hide Stop the camera and hide the camera UI element.
open Open the camera.
close Close and release the camera.
isOpen Check if the camera is open.
play Continue the video stream.
pause Pause the video stream.
stop Stop the video and release the camera.
pauseScan Pause the video decoding process.
resumeScan Resume the video decoding process.

Capture Settings

The following methods are related to the camera’s capture settings.

Method Description
getCapabilities Get the camera capabilities.
getResolution Get current video resolution.
setResolution Set current video resolution.
getScanSettings Get current scan settings.
updateScanSettings Modify and update scan settings.
getVideoSettings Get current video settings.
updateVideoSettings Modify and update video settings.
setColorTemperature Adjust the video colour temperature.
setExposureCompensation Adjust the video exposure level.
setFrameRate Adjust the video frame rate.
setZoom Adjust the video zoom ratio.
turnOnTorch Turn on the torch/flashlight.
turnOffTorch Turn off the torch/flashlight.

Runtime Settings

The following methods are related to customizing runtime settings.

Method Description
getRuntimeSettings Get current runtime settings. Inherited from the BarcodeReader class.
resetRuntimeSettings Reset runtime settings to default.Inherited from the BarcodeReader class.
updateRuntimeSettings Modify and update the current runtime settings.
getModeArgument Get argument value for the specified mode parameter. Inherited from the BarcodeReader class.
setModeArgument Set argument value for the specified mode parameter. Inherited from the BarcodeReader class.

BarcodeScanner Class Properties

Property Description
defaultUIElementURL Get or set the default scanner UI.
bUseFullFeature If set to true, use the full-featured WASM module. Inherited from the BarcodeReader class.
engineResourcePath Get or set the engine (WASM) location. Inherited from the BarcodeReader class.
productKeys Get or set the Dynamsoft Barcode Reader SDK product keys. Inherited from the BarcodeReader class.
version Get the current version. Inherited from the BarcodeReader class.
licenseServer Specify by URL the license server from where authorization is acquired at runtime. Inherited from the BarcodeReader class.
handshakeCode Specify the Handshake Code which determines what authorization is acquired. Inherited from the BarcodeReader class.
sessionPassword Specify a password which protects the Handshake Code from abuse. Inherited from the BarcodeReader class.

BarcodeScanner Instance Properties

Property Description
bDestroyed Indicates whether a BarcodeScanner instance has been destroyed. Inherited from the BarcodeReader class.
bSaveOriCanvas If set to true, save the original image in oriCanvas. Inherited from the BarcodeReader class.
oriCanvas An OffscreenCanvas object that holds the original image. Inherited from the BarcodeReader class.
_bUseWebgl Whether to enable image preprocessing with WebGL APIs, this API may change in the future. Inherited from the BarcodeReader class.
bPlaySoundOnSuccessfulRead If set to true, a sound will be played when a barcode is read successfully. You can change the sound using soundOnSuccessfulRead
bVibrateOnSuccessfulRead Whether to vibrate when the scanner reads a barcode successfully.
barcodeFillStyle Set the style used when filling in located barcode.
barcodeLineWidth Set the width of the located barcode border.
barcodeStrokeStyle Set the style of the located barcode border.
regionMaskFillStyle Set the style used when filling the mask beyond the region.
regionMaskLineWidth Set the width of the region border.
regionMaskStrokeStyle Set the style of the region border.
onFrameRead Triggered a frame has been scanned.
onPlayed Triggered when the camera video stream is played.
onUnduplicatedRead Triggered when a new, unduplicated barcode is found.
singleFrameMode If set to true, single video frames will be used instead of a continuous video stream.
soundOnSuccessfulRead Get or set the sound to play when a barcode is read successfully.
vibrateDuration Get or set how long the vibration lasts.

BarcodeScanner Interfaces

Interface Description
FrameFilter Filter and discard video frames while focusing.
ScanSettings Configures the video stream settings.
ScannerPlayCallbackInfo Stores the height and width constraints of the video stream.
VideoDeviceInfo Stores the video device information.

Global Interfaces

Interface Description
BarcodeReaderException Exceptions raised for Barcode Reader errors.
FurtherModes Stores additional modes.
LocalizationResult Stores the localization result of the detected barcode.
Region Stores the barcode region information.
RuntimeSettings Stores the barcode reading runtime settings.
TextResult Stores the decoded barcode text results.

Enumerations

This page is compatible for:

Is this page helpful?

YesYes NoNo