1. Image
COEX
English
  • 简体中文
  • English
  • Contents
    • API Instructions
    • Error Codes
    • General API
      • Retrieve Screen Information
      • Set Screen Brightness
      • Set Screen Gamma
      • Set Blackout/Freeze Screen
      • Retrieve Preset Information
      • Apply Preset
      • Retrieve All Cabinet Information
      • Enable Cabinet Mapping
      • Adjust Cabinet Color Temperature
      • Switch Source for Layer
      • Configure EDID
      • Retrieve Real-Time Monitoring Information
    • Input
      • Internal sources
        • Set Internal Source Information
        • Set Sending Card Test Pattern
      • Retrieve Input Information
        • Retrieve Input Source Info
        • Retrieve Input Data
      • Color Adjustment
        • Set Red Shadow
        • Set Green Shadow
        • Set Blue Shadow
        • Set Red Highlight
        • Set Green Highlight
        • Reset Color Adjustment
        • Set Blue Highlight
        • Set Saturation
        • Set Contrast
        • Set Black Level
        • Adjust Hue
      • EDID
        • Set EDID
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Set Screen Color Temperature
          PUT
        • Retrieve Screen Display Effect Parameters
          GET
        • Set Brightness Limit On/Off
          POST
        • Set Brightness Limit Value
          POST
        • Set Custom Gamma for the Screen
          POST
        • Set Screen Color Temperature
          PUT
        • Set Screen Brightness
          PUT
        • Set Screen Gamma
          PUT
      • Schedule
        • Retrieve All Schedule Information of the Screens
        • Set Schedule On\Off
        • Delete Brightness Strategy
      • Color Correction
        • Set Color Correction On/Off
        • Set Color Correction Data (Black/White)
        • Set Color Correction Data (Other Colors)
      • Layer
        • Switch Source for Layer
      • Process
        • 3D LUT
          • Import 3D LUT File
          • Delete 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Retrieve Preset Information
        • Apply Preset
        • Modify Preset
      • Output
        • 3D
          • 3D Emitter
            • Enable 3D Emitter
          • Enable/Disable 3D
        • Retrieve Output Parameters
          • Retrieve Screen Output Data
        • Display Mode
          • Set Blackout/Freeze Screen
        • Multi-Mode
          • Set Multi-mode by Screens
        • Retrieve Display Status
        • Set Output Bit Depth
        • Output Sync Source Switching
      • Retrieve the Number of Cabinets of the Screen
        GET
      • Retrieve Screen Information
        GET
      • Retrieve Screen Properties Information
        GET
    • Device
      • Audio
        • Set Output Audio
        • Retrieve Audio Settings
      • Controller Identify
        • Controller Identify
      • Device Backup
        • Retrieve Device Backup Status
        • Primary/Backup Verify
      • Logs
        • Export Log
      • Controller Time
        • Set System Time
        • Automatic Time Setting On/Off
        • Change the time zone
      • Controller Name
        • Change Controller Name
      • SNMP
        • Retrieve SNMP On/Off Status
        • Set SNMP On/Off
      • Multifunction Card
        • Retrieve Multifunction Card Information
      • Device Identify
        • Device Identify
      • Monitoring
        • Retrieve Real-Time Monitoring Information
      • Set Blackout/Freeze Screen
      • Retrieve Device Information
    • Cabinet
      • Pre-stored Image
        • Set No Data Signal
      • Thermal Calibration
        • Set Thermal Compensation On/Off
        • Thermal Compensation Intensity Adjustment
        • Set Thermal Compensation Mode
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Adjust Color Temperature
        • Adjust Cabinet Color Temperature
      • Cabinet Display Control
        • Set Receiving Card Test Pattern
      • Cabinet Identify
        • Enable Cabinet Mapping
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
      • Retrieve All Cabinet Information
      • Set Cabinet RGBW Brightness Components
  1. Image

Retrieve Screen Display Effect Parameters

GET
/api/v1/screen/displayparams
TIP
Retrieve the overall brightness, color temperature, gamma of each screen

Request

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'http://prod-cn.your-api-server.com/api/v1/screen/displayparams' \
--header 'Device-Key: 10.40.41.200:8001'

Responses

🟢200Successful
application/json
Bodyapplication/json

Example
{
    "list": {
        "screenId": 0,
        "brightness": 0,
        "colorTemperature": 0,
        "gamma": 0
    }
}
Modified at 2025-10-21 01:43:57
Previous
Set Screen Color Temperature
Next
Set Brightness Limit On/Off
Built with