Home > Develop > IP Control > REST API > API List

getVolumeInformation (v1.0)

Estimated reading time: 1 minute

This API provides information about the sound volume (and mute status) of the device.

Syntax

http://<Base URL>/audio

Authentication Level

none

Request

params' Elements
Not necessary.
JSON Example
{
    "method": "getVolumeInformation",
    "id": 33,
    "params": [],
    "version": "1.0"
}

Response

result's Elements
An array of objects composed of the following pairs.
name type multiplicity default description
target string 1 Output target of the sound. The following values are defined.
  • "speaker" - outputs sound to the speaker(s)
  • "headphone" - outputs sound to the headphones
volume integer 1 Current volume.
mute boolean 1 Current mute status.
  • true - mute
  • false - not mute
maxVolume integer 1 Max volume level (ex. 100)
minVolume integer 1 Min volume level (ex. 0) 
{
    "result": [[
        {
            "volume": 25,
            "minVolume": 0,
            "mute": false,
            "maxVolume": 100,
            "target": "speaker"
        },
        {
            "volume": 10,
            "minVolume": 0,
            "mute": false,
            "maxVolume": 100,
            "target": "headphone"
        }
    ]],
    "id": 33
}
Error Code
No additional error codes are defined. Refer to error code for common errors.
Last modified: 26 Jul 2024