Auxiliary APIs

Name	Description
on()	Attach an event handler function for a built-in event.
off()	Remove an event handler.
dispose()	Releases all resources used by the CameraEnhancer instance.
getVersion()	Returns the version of the library.
detectEnvironment()	Returns a report on the current running environments.

on

Attach an event handler function for a built-in event.

on(eventName: EventName, listener: Function): void;

Parameters

eventName: specifies the event.

listener: specifies the handler function.

Return value

None.

Code Snippet

let enhancer = await Dynamsoft.DCE.CameraEnhancer.createInstance();
enhancer.on("cameraChange", playCallBackInfo => {
    console.log(playCallBackInfo.deviceId);
});
enhancer.on("cameraOpen", playCallBackInfo => {
    console.log(playCallBackInfo.deviceId);
});
enhancer.on("cameraClose", playCallBackInfo => {
    console.log(playCallBackInfo.deviceId);
});
enhancer.on("resolutionChange", playCallBackInfo => {
    console.log("width:" + playCallBackInfo.width);
    console.log("height:" + playCallBackInfo.height);
});
enhancer.on("played", playCallBackInfo => {
    console.log(playCallBackInfo.deviceId);
});
enhancer.on("singleFrameAcquired", dceFrame => {
    document.body.appendChild(dceFrame.toCanvas());
});
enhancer.on("frameAddedToBuffer", () => {
    let dceFrame = enhancer.getFrameFromBuffer();
    document.body.appendChild(dceFrame.toCanvas());
});

off

Remove an event handler.

off(eventName: EventName, listener: Function): void;

Parameters

eventName: specifies the event.

listener: specifies the handler function.

Return value

None.

Code Snippet

let enhancer = await Dynamsoft.DCE.CameraEnhancer.createInstance();
let cameraChanged = playCallBackInfo => {
    console.log(playCallBackInfo.deviceId);
    enhancer.off("cameraChange", cameraChanged);
}
enhancer.on("cameraChange", cameraChanged);

dispose

Releases all resources used by the CameraEnhancer instance.

The HTML elements used by the instance’s UI element are only removed when removeUIElement is set to true. Otherwise, they are only hidden.

dispose(removeUIElement?: boolean): void;

Parameters

removeUIElement: whether to hide or remove the HTML elements in the instance’s UI element.

Return value

None.

Code Snippet

let enhancer = await Dynamsoft.DCE.CameraEnhancer.createInstance();
// Use the object to perform some tasks
enhancer.dispose();

getVersion

Returns the version of the library.

static getVersion(): string;

Parameters

None.

Return value

The version string of the library.

Code Snippet

Dynamsoft.DCE.CameraEnhancer.getVersion(); // 'JS 1.0.0.20210628'

detectEnvironment

Returns a report (in JSON) on the current running environments.

static detectEnvironment(): Promise<any>;

Parameters

None.

Return value

A JSON object about the running environment. For example

{
    "wasm": true,
    "worker": true,
    "getUserMedia": true,
    "camera": true,
    "browser": "Chrome",
    "version": 90,
    "OS": "Windows"
}

Code Snippet

await Dynamsoft.DCE.CameraEnhancer.detectEnvironment();