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

getSpkVol (Querying the Current Speaker Volume)

Interface Description

This interface is invoked to query the current volume of the speaker.

Notes

The WebSocket connection with the OpenEye is set up.

Method Definition

OpenEyeCall.prototype.getSpkVol = function(callbacks)

Parameter Description

Table 1 Parameter description

Parameter

Type

Mandatory/Optional

Description

callbacks

Callback

Optional

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.

param

Param

Volume information.

Table 4 Param

Parameter

Type

Description

volume

Number

Current output volume.

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

{
   "description" : "tsdk_get_speak_volume",
   "param" : {
      "volume" : 80
   },
   "result" : 0,
   "rsp" : 67558
}

Examples

function getSpkVol() {
    global_openEye_SDK.openEyeCall.getSpkVol({
        response: getSpkVolResponse
    });
}

function getSpkVolResponse(data) {
    console.info(data);
    if (data.result == 0) {
        console.info("GetSpkVol Success.");
    } else {
        console.error("GetSpkVol failed");
    }
}