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

setSceneSetting (v1.0)

Estimated reading time: 1 minute

This API provides the function to change the current scene setting value.

Note

This API is able to set the value at API call timing, which might vary depending on the device state. (For example, depending on the "current" input source.)

Syntax

http://<Base URL>/videoScreen

Authentication Level

generic

Request

params' Elements
An object composed of the following pair(s).
name type multiplicity default description
value string 1 Scene of the input source.
  • "auto" - Automatically selects the scene based on the viewing content.
  • "auto24pSync" - Automatically selects "Cinema" for 24Hz signal content. Behaves as "Auto" for all other signals.
  • "general" - Turns off scene select for general content.
JSON Example
{
    "method": "setSceneSetting",
    "id": 40,
    "params": [{"value": "auto"}],
    "version": "1.0"
}

Response

result's Elements
Not necessary.
JSON Example
{
    "result": [],
    "id": 40
}
Error Code
The following error codes are important for this API. Refer to error code for other errors.
code Explanation
3 The value of "value" in Request is empty.
3 The value of "value" in Request is invalid.
7 Device is in the power off state.
7 Scene select is not supported.
7 The value of "value" in Request is not supported by the current input source of the device.
Last modified: 26 Jul 2024