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

getSpeakerSettings (v1.0)

Estimated reading time: 2 minutes

This API provides current settings and supported settings related to speaker 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 speaker setting information by setting the empty string to "target". The client can get specific speaker setting values by explicitly setting the target name to "target".
  • "" - Settings of all targets.
  • "tvPosition" - Sets the sound according to the display position.
  • "subwooferLevel" - Sets the level of the Subwoofer speaker. Note that the range and step values vary depending on the device.
  • "subwooferFreq" - Adjusts the cut off frequency of the Wireless Subwoofer. All frequencies the cut off frequency are output to the Wireless Subwoofer instead of the display speakers.
  • "subwooferPhase" - Sets the phase polarity of the subwoofer.
  • "subwooferPower" - Sets the power control method of the Wireless Subwoofer.
JSON Example
{
    "method": "getSpeakerSettings",
    "id": 67,
    "params": [{"target": "tvPosition"}],
    "version": "1.0"
}

Response

result's Elements
An array of objects composed of the following pairs.
name type multiplicity default description
target string 1 Target name.
  • "tvPosition" - Sets the sound according to the display position.
  • "subwooferLevel" - Sets the level of the Subwoofer speaker. Note that the range and step values vary depending on the device.
  • "subwooferFreq" - Adjusts the cut off frequency of the Wireless Subwoofer. All frequencies the cut off frequency are output to the Wireless Subwoofer instead of the display speakers.
  • "subwooferPhase" - Sets the phase polarity of the subwoofer.
  • "subwooferPower" - Sets the power control method of the Wireless Subwoofer.
currentValue string 1 Current value of the target.
  • If "target" is "tvPosition"
    • "tableTop" - Provides the best sound quality when you place the display on a table.
    • "wallMount" - Provides the best sound quality when you hang the display on a wall.
  • If "target" is "subwooferLevel"
    • 0 - Minimum value.
    • :(step by 1)
    • 24 - Maximum value.
  • If "target" is "subwooferFreq"
    • 0 - Minimum value.
    • :(step by 1)
    • 30 - Maximum value.
  • If "target" is "subwooferPhase"
    • "normal" - normal.
    • "reverse" - reverse.
  • If "target" is "subwooferPower"
    • "on" - on.
    • "off" - off.
JSON Example
{
    "result": [[{
        "currentValue": "tableTop",
        "target": "tvPosition"
    }]],
    "id": 67
}
Error Code
No additional error codes are defined. Refer to error code for common errors.
Last modified: 26 Jul 2024