setSoundSettings (v1.1)
Estimated reading time: 1 minute
- This API provides the function to change the settings related to sound 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)
|
||
value | string | 1 | The value to set for the target name.
|
- JSON Example
-
{ "method": "setSoundSettings", "id": 5, "params": [{"settings": [{ "value": "speaker", "target": "outputTerminal" }]}], "version": "1.1" }
Response
- result's Elements
- Not necessary.
- JSON Example
-
{ "result": [], "id": 5 }
- 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: 13 Feb 2019