JavaScript API Reference - BarcodeScanner Accessors

Inherited Accessors from BarcodeReader

defaultUIElementURL

Get or set the default scanner UI. The default scanner UI is defined in the file dist/dbr.scanner.html. Follow these steps to customize the UI.

defaultUIElementURL = 'url'

Property Value

url string

Tips and Tricks

• Be sure to set defaultUIElementURL before you call createInstance.

singleFrameMode

Get or set the camera mode. If true, single video frames will be used instead of a continuous video stream. It’s especially useful for cameras that lack webcam access (lack of WebRTC support, e.g. Chrome on iOS).

singleFrameMode = bool;

Property Value

bool boolean

Sample

let scanner = await Dynamsoft.DBR.BarcodeScanner.createInstance();
scanner.singleFrameMode = true; // use singleFrameMode anyway
scanner.show();

Tips and Tricks

• singleFrameMode is based on WebRTC support, not actual camera connection. In other words, if a browser supports WebRTC, it won’t be using singleFrameMode by default even when there is no camera attached.

• By default, when the default UI is used, a camera icon will appear for the singleFrameMode which is defined by a SVG (className is dbrScanner-bg-camera). If you have customized the UI, you will have to provide your own UI implementation for this mode.

soundOnSuccessfulRead

Get or set the sound played when a barcode is read successfully.

soundOnSuccessfulRead = audio

Property Value

audio HTMLAudioElement

Sample

scanner.soundOnSuccessfulRead = new Audio("./pi.mp3");