setSpkVol (Setting the Speaker Volume)

Interface Description

This interface is invoked to set the speaker volume.

Notes

The WebSocket connection with the OpenEye is set up.

Method Definition

OpenEyeCall.prototype.setSpkVol = function(volume, device, callbacks)

Parameter Description

**Table 1** Parameter description
Parameter	Type	Mandatory/Optional	Description
volume	Number	Mandatory	Volume. The value ranges from 0 to 100.
device	Number	Mandatory	Device type. Set this parameter to 0.
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.

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

{
   "description" : "tsdk_set_speak_volume",
   "result" : 0,
   "rsp" : 67557
}

Examples

function setSpkVol() {
    global_openEye_SDK.openEyeCall.setSpkVol(80, 0, {
        response: setSpkVolResponse
    });
}

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

Parent topic: Device Management

Previous topic: getMicVol (Querying the Current Microphone Volume)

Next topic: getSpkVol (Querying the Current Speaker Volume)