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

Screenshot (Screenshot)

Interface Description

This interface is invoked to capture and save a frame of the peer video.

Notes

Prerequisites: The WebSocket connection with the OpenEyeCall has been set up, and a video call is in progress.

Method Definition

OpenEyeCall.prototype.screenShot = function(callbacks)

Parameter Description

Table 1 Parameter description

Parameter

Type

Mandatory/Optional

Description

callbacks

Callback

Mandatory

Callback method.

Table 2 Callback

Parameter

Type

Mandatory/Optional

Description

response

function

Mandatory

For details about the input parameters of the callback method, see Table 3.

Table 3 Input parameters of the callback method

Parameter

Type

Description

description

String

Description of the current request.

result

Number

Query result. The value 0 indicates success and other values indicate failure.

rsp

Number

Internal message ID.

The following is an example of input parameters of the callback method:

{
   "description" : "tsdk_share_evt_stopsharewindow",
   "result" : 0,
   "rsp" : 67762
}

Examples

function startScreenShot(){
 console.info("startScreenShot");
 this.global_openEye_SDK.openEyeCall.screenShot({ response: startScreenShotResponse })
}

function startScreenShotResponse(data){
 console.log(data);
 if (data.result == 0) {
        console.info("startScreenShot Success");
    } else {
        console.error("startScreenShot failed");
        console.error(data);
    }
}