OpenEye_SDK (Creating and Initializing an Object)

Updated on 2023-10-12 GMT+08:00

View PDF

Interface Description

When the SDK is initialized, the WebSocket connections with the OpenEyeDeamon, OpenEyeLogin, and OpenEyeCall modules are implemented internally.

Notes

The local client of the OpenEye is started.
Only one web page can be used to initialize the SDK on each PC.
The OpenEye_SDK.js file has been loaded to the third-party application page.

Method Definition

function OpenEye_SDK(opts)

Parameter Description

**Table 1** Parameter description
Parameter	Type	Mandatory/Optional	Description
opts	Opts	Mandatory	Callback method.

**Table 2** Opts
Parameter	Type	Mandatory/Optional	Description
onOpeneyeDeamonReady	function	Mandatory	The WebSocket connection with the OpenEye client is set up.
onOpeneyeDeamonClose	function	Mandatory	The WebSocket connection with the OpenEye client is closed. NOTE: If the WebSocket connection with the OpenEye client is closed, the WebSocket connections with the OpenEyeCall and OpenEyeLogin are also closed.
serviceStartUp	function	Mandatory	The local OpenEye service is started. NOTE: The WebSocket connections with OpenEyeCall and OpenEyeLogin can be set up only after the local OpenEye service is started.
serviceShutDown	function	Mandatory	The local OpenEye service is disabled.
onOpeneyeLoginReady	function	Mandatory	The WebSocket connection with the OpenEyeLogin is set up.
onOpeneyeLoginClose	function	Mandatory	The WebSocket connection with the OpenEyeLogin is closed.
onOpeneyeCallReady	function	Mandatory	The WebSocket connection with the OpenEyeCall is set up.
onOpeneyeCallClose	function	Mandatory	The WebSocket connection with the OpenEyeCall is closed.
onVersionInfoNotify	function	Mandatory	Version information notification.

Examples

function onOpeneyeDeamonReady() {
    console.info("Openeye Deamon is Ready");
}

function onOpeneyeDeamonClose() {
    console.error("Openeye Deamon is Closed,please restart it");
    global_openEye_SDK = null;
}


function serviceStartUp() {
    console.info("OpenEye Service StartUp");
}

function serviceShutDown() {
    console.error("OpenEye Service is shutdown,please restart it");
}

function onOpeneyeCallClose() {
    console.error("onOpeneyeCallClose");
}


function onOpeneyeCallReady() {
    console.info("onOpeneyeCallReady");
}

function onOpeneyeLoginReady() {
    console.info("onTupLoginReady");
}


function onOpeneyeLoginClose() {
    console.info("onOpeneyeLoginClose");
}
function onVersionInfoNotify (data) {
    console.info("version is");
    console.info(data);  
}

var global_openEye_SDK = null;
function initSDK(){
    global_openEye_SDK = new OpenEye_SDK({
            onOpeneyeReady: onOpeneyeReady,
            onOpeneyeClose: onOpeneyeClose,
            serviceStartUp: serviceStartUp,
            serviceShutDown: serviceShutDown,
            onOpeneyeLoginReady: onOpeneyeLoginReady,
            onOpeneyeLoginClose: onOpeneyeLoginClose,
            onOpeneyeCallReady: onOpeneyeCallReady,
            onOpeneyeCallClose: onOpeneyeCallClose,
            onVersionInfoNotify: onVersionInfoNotify
        });
}

Parent topic: Initialization

Previous topic: Initialization

Next topic: config (Configuration)