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

Returning the Base64 Code of a Screenshot

Interface Description

This interface is invoked to capture an image of the other party and return the Base64 code of the image during a video call.

Notes

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

Method Definition

OpenEyeCall.prototype.screenShotBase64 = 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

Callback method.

Table 3 Input parameters of the callback method

Parameter

Type

Description

description

String

Description of the current request.

base64

String

If the operation is successful, this parameter indicates the Base64 code of the image. If the operation fails, this parameter does not exist.

result

Number

Configuration result. The value 1 indicates failure. If the operation is successful, this parameter does not exist.

rsp

Number

Internal message ID.

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

{
   "description" : "OEScreenShot",
   "result" : 1,
   "rsp" : 67762
}

{
   "description" : "OEScreenShot",
   "base64" : "xxx",
   "rsp" : 67762
}

Examples

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

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