This page is applicable to version 8.2.3

JavaScript API Reference - BarcodeScanner Camera Control Methods

getAllCameras

Get information of all available cameras on the device.

getAllCameras() returns Promise

Return Value

Promise<VideoDeviceInfo[]>

Sample

let cameras = await scanner.getAllCameras();
if(cameras.length){
    await scanner.setCurrentCamera(cameras[0]);
}

getCurrentCamera

Get information about the currently used camera.

getCurrentCamera() returns Promise

Return Value

Promise<VideoDeviceInfo[] | null>

setCurrentCamera

Set camera by its information or device ID.

setCurrentCamera(cameraInfoOrDeviceId) returns Promise

Parameters

cameraInfoOrDeviceId any

Return Value

Promise<ScannerPlayCallbackInfo>

Sample

    let cameras = await scanner.getAllCameras();
    if(cameras.length){
        await scanner.setCurrentCamera(cameras[0]);
    }

hide

Stop decoding, close and release the camera, unbind from UI, and set the UI element with display:none;

hide() returns void

Return Value

void

Sample

Read barcodes from live camera

show

Bind UI, open the camera, remove the UIElement display style if the original style is display:none;, and start decoding.

show() returns Promise

Return Value

Promise<ScannerPlayCallbackInfo>

Sample

await scanner.show();

close

Stop decoding, close and release the camera, and unbind from UI.

close() returns void

Return Value

void

Sample

Read barcodes from live camera

isOpen

Check if the scanner is open.

isOpen() returns Boolean

Return Value

Boolean

Sample

Read barcodes from live camera

open

Bind UI, open the camera, and start decoding.

open() returns Promise

Return Value

Promise<ScannerPlayCallbackInfo>

Sample

await scanner.open();

pause

Pause the video stream but will not release the camera.

pause() returns void

Return Value

void

Sample

Read barcodes from live camera

play

Continue the video stream.

play(deviceId, width, height) returns Promise

Parameters

• deviceId string
• width number
• height number

Return Value

Promise<ScannerPlayCallbackInfo>

Sample

await scanner.play();

stop

Stop the video, and release the camera.

stop() returns void

Return Value

void

Sample

Read barcodes from live camera

pauseScan

Pause the video decoding process.

pauseScan() returns void

Return Value

void

Sample

Read barcodes from live camera

resumeScan

Resume the video decoding process.

resumeScan() returns void

Return Value

void

Sample

Read barcodes from live camera