setPictureQualitySettings (v1.0)

Estimated reading time: 1 minute

This API provides a function to change settings related to picture quality setting items.

Syntax

http://<Base URL>/video

Authentication Level

generic

Request

params' Elements
An object composed by following pair(s).
name type multiplicity default description
target string ? null Target name (UI setting target). Please use getPictureQualitySettings to acquire the available targets.
  • "color" - Adjust the color saturation level.
  • "brightness" - Adjust the luminance level of the screen.
  • "contrast" - Adjust the picture white level.
  • "sharpness" - Adjust the picture detail.
  • "pictureMode" - Set picture mode.
  • "lightSensor" - Optimize brightness according to ambient light.
  • "colorSpace" - Change the color reproduction range.
  • "colorTemperature" - Adjust the color temperature.
  • "autoPictureMode" - Automatically selects the picture mode based on the viewing content.
  • "hdrMode" - Picture that is suitable for a High Dynamic Range signal.
  • "autoLocalDimming" - Optimizes contrast by adjusting brightness in individual sections of the screen.
  • "xtendedDynamicRange" - Adjust peak luminance for the brightness whites and blackest blacks.
value string ? null The value to set for target name. Please use getPictureQualitySettings to acquire the candidate values of target.
JSON Example
{
    "method": "setPictureQualitySettings",
    "id": 12,
    "params": [{"settings": [{
        "value": "2",
        "target": "color"
    }]}],
    "version": "1.0"
}

Response

result's Elements
Not necessary.
JSON Example
{
    "result": [],
    "id": 12
}
Error Code
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. Client needs to call paired APIs (getXXXSettings) to identify which parameters fail to be updated.
Last modified: 5 Aug 2021