This page is applicable to version 8.2.3
BarcodeScanner
Methods
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. |
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. |
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. |