getMicVol (Querying the Current Microphone Volume)

Interface Description

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

Notes

The WebSocket connection with the OpenEye is set up.

Method Definition

OpenEyeCall.prototype.getMicVol = 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 microphone volume.

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

{
   "description" : "tsdk_get_mic_volume",
   "param" : {
      "volume" : 20
   },
   "result" : 0,
   "rsp" : 67578
}

Examples

function getMicVol() {
    global_openEye_SDK.openEyeCall.getMicVol({
        response: getMicVolResponse
    });
}

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

Parent topic: Device Management

Previous topic: setMicVol (Setting the Microphone Volume)

Next topic: setSpkVol (Setting the Speaker Volume)