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

getSoundSettings (v1.1)

Estimated reading time: 1 minute

This API provides the current settings and supported settings related to the sound configuration items.

Syntax

http://<Base URL>/audio

Authentication Level

none

Request

params' Elements
An object composed of the following pair(s).
name type multiplicity default description
target string ? "" Target name. The default value is "". This indicates the settings of all targets. The client can get all sound setting information by setting the empty string to "target". The client can get specific sound setting values by explicitly setting the target name to "target".
  • "" - This indicates the settings of all targets.
  • "outputTerminal" - Selecting speakers or terminals to output sound.
JSON Example
{
    "method": "getSoundSettings",
    "id": 73,
    "params": [{"target": "outputTerminal"}],
    "version": "1.1"
}

Response

result's Elements
An array of objects composed of the following pairs.
name type multiplicity default description
target string 1 Target name.
  • "outputTerminal" - Selecting speakers or terminals to output sound.
currentValue string 1 Current value of target.
  • If "target" is "outputTerminal"
    • "speaker" - Audio is output from the speaker.
    • "speaker_hdmi" - Audio is output from the speaker and HDMI.
    • "hdmi" - Audio is output from HDMI.
    • "audioSystem" - Audio is output from HDMI or digital audio output.
JSON Example
{
    "result": [[{
        "currentValue": "audioSystem",
        "target": "outputTerminal"
    }]],
    "id": 73
}
Error Code
No additional error codes are defined. Refer to error code for common errors.
Last modified: 6 Aug 2024