This page is applicable to version 8.2.3
Javascript API Reference - BarcodeScanner
Initialize and Destroy Methods
Method | Description |
---|---|
createInstance() | Create a BarcodeScanner object. |
destroy() | Destroy the BarcodeScanner object. |
getUIElement() | Get HTML element containing the BarcodeScanner object. |
setUIElement() | Set HTML element containing the BarcodeScanner object. |
createInstance
Create a BarcodeScanner
object. Overrides BarcodeReader.createInstance
.
createInstance(config) returns Promise
Parameters
config
optional any
Return Value
Promise<BarcodeScanner>
Sample
let scanner = await Dynamsoft.BarcodeScanner.createInstance();
Read barcodes from live camera
destroy
Destroy the BarcodeScanner
object. Equivalent to the previous method deleteInstance()
. Overrides BarcodeReader.destroy
.
destroy() returns Promise
Return Value
Promise<any>
getUIElement
Get the HTML element containing the BarcodeScanner
object.
getUIElement() returns HTMLElement
Return Value
HTMLElement
Sample
Read barcodes from live camera
setUIElement
Set HTML element containing the BarcodeScanner
object.
setUIElement(elementOrUrl) returns Promise
Parameters
elementOrUrl *HTMLElement |
string* |
Return Value
Promise<void>
Sample
<!-- Define an element that shows only the video input -->
<!-- The video element will be created and appended to the DIV element with the class dce-video-container , make sure the class name is the same.
Besides, the CSS property position of the DIV element must be either relative, absolute, fixed, or sticky. -->
<div class="dce-video-container" style="position:relative;width:100%;height:500px;"></div>
<script>
let scanner = await Dynamsoft.DBR.BarcodeScanner.createInstance();
await scanner.setUIElement(document.getElementsByClassName("dce-video-container")[0]);
await scanner.open();
</script>
Read barcodes from live camera
Tips and Tricks
- This API changes the UI on the fly. If you want the UI to change as soon as the camera is created, use defaultUIElementURL instead.