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

getPictureQualitySettings (v1.0)

Estimated reading time: 2 minutes

This API provides current settings and supported settings related to picture quality configuration items.

Syntax

http://<Base URL>/video

Authentication Level

none

Request

params' Elements
An object composed by following pair(s).
name type multiplicity default description
target string ? "" Target name. Default value is "". It means settings of all targets. Client can get all custom picture quality settings information by setting empty string to "target". Client can get specific custom picture quality setting value by explicitly setting target name to "target".
  • "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.
  • "" - Settings of all targets.
JSON Example
{
    "method": "getPictureQualitySettings",
    "id": 52,
    "params": [{
        "target": "color"
    }],
    "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.
currentValue string 1 Current value of target.
isAvailable boolean ? true This target is currently available or not.
candidate (object-array) ? null Candidates of specified settings. Only If there is no candidate, null is set.
value string ? "" Value of candidate. "" can be set only when settings value is integer and the candidate can be represented by "max", "min", and "step".
max double ? -1 Max value of specified settings. Only If value of target is not indicated by numerical number, -1 is set.
min double ? -1 Min value of specified settings. Only If value of target is not indicated by numerical number, -1 is set.
step double ? -1 Step value of specified settings. Only If value of target is not indicated by numerical number, -1 is set.
JSON Example
{
    "result": [[{
        "target": "color",
        "currentValue": "2",
        "isAvailable": true,
        "candidate": [{
            "max": 100,
            "min": 0,
            "step": 1
        }],
    }]],
    "id": 52
}
Error Code
No additional error codes are defined. Refer to error code for common errors.
Last modified: 26 Jul 2024