Web Demos

BARCODE READER SDK DEMO

Explore the flexibe barcode reading settings to optimize for your specific usage scenario.

WEB TWAIN SDK DEMO

Try the most popular web scanner features: scan images, import local images and PDF files, edit, save to local, upload to database, and etc.

BARCODE READER JAVASCRIPT DEMO

Transform any camera-equipped devices into real-time, browser-based barcode and QR code scanners.

MRZ SCANNER WEB DEMO

Detects the machine-readable zone of a passport, scans the text, and parses into human-readable data.

APP STORE DEMOS

BARCODE READER SDK FOR IOS

BARCODE READER SDK FOR ANDROID

VIEW MORE DEMOS >
Dev Center
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.

Dynamsoft Barcode Reader SDK - JavaScript BarcodeScanner Class

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

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.
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 false, use the compact-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
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.

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.

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

latest version

  • Latest version
  • Version 9.x
    • Version 9.2.12
    • Version 9.0.2
    • Version 9.0.1
    • Version 9.0.0
  • Version 8.x
    • Version 8.8.7
    • Version 8.8.5
    • Version 8.8.3
    • Version 8.8.0
    • Version 8.6.3
    • 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.x
    • Version 7.6.0
    • Version 7.5.0
Change +
© 2003–2023 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support