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

setSpeakerSettings (v1.0)

Estimated reading time: 2 minutes

This API provides the function to change the settings related to speaker setting items.

Syntax

http://<Base URL>/audio

Authentication Level

generic

Request

params' Elements
An object composed of the following pair(s).
name type multiplicity default description
settings (object-array) 1 Object to accommodate one or more target/value pair(s).
target string 1 Target name. (UI setting target)
  • "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 below 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.
value string 1 The value to set for the target name.
  • If "target" is "tvPosition"
    • "tableTop" - Provides the best sound quality when you place the display on a TV stand.
    • "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
{
    "method": "setSpeakerSettings",
    "id": 62,
    "params": [{"settings": [{
        "value": "wallMount",
        "target": "tvPosition"
    }]}],
    "version": "1.0"
}

Response

result's Elements
Not necessary.
JSON Example
{
    "result": [],
    "id": 62
}
Error Code
The following error codes are important for this API. Refer to error code for other errors.
code Explanation
40004 One or more settings are not set by error when multiple settings are set. The client needs to call paired APIs (getXXXSettings) to identify which parameters failed to be updated.
Last modified: 26 Jul 2024