COEX-EN
  1. Screen
COEX-EN
  • Contents
    • API Instructions
    • Error Code
    • General
      • 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
      • Retrieve Input Source List
      • Switch Source for Layer
      • Set EDID
      • Set Screen Color Temperature
    • Input
      • Retrieve Input Information
        • Retrieve Input Data
        • Retrieve Input Source List
      • EDID
        • Set EDID
      • Color Adjustment
        • Set Saturation
        • Set Color Highlight
        • Set Color Shadow
        • Adjust Hue
        • Reset Color Adjustment
      • Internal Source
        • Set Sending Card Test Pattern
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image booster
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Retrieve Screen Display Effect Parameters
        • Set Screen Color Temperature
        • Set Custom Gamma for the Screen
        • Set Screen Brightness
        • Set Screen Gamma
      • Layer
        • Switch Source for Layer
      • Processing
        • 3D LUT
          • Delete 3D LUT File
          • Import 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Modify Preset
        • Retrieve Preset Information
        • Apply Preset
      • Schedule
        • Retrieve All Schedule Information of the Screens
        • Set Schedule On\Off
        • Delete Brightness Schedule
      • Output
        • 3D function
          • 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
        • 3D
          • 3D Emitter
        • Display Mode
        • Retrieve Display Status
        • Set Output Bit Depth
      • Image Booster
        • Color Gamut
      • Retrieve Screen Properties Information
        GET
      • Retrieve the Number of Cabinets of the Screen
        GET
      • Retrieve Screen Information
        GET
    • Device
      • Device Identify
        • Device Identify
      • Monitoring
        • Retrieve Real-Time Monitoring Information
      • Set Blackout/Freeze Screen
    • Cabinet
      • Retrieve Cabinet Information
        • Retrieve All Cabinet Information
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Color Temperature Adjustment
        • Adjust Cabinet Color Temperature
      • Cabinet Control
        • Set Receiving Card Test Pattern
      • Cabinet Identify
        • Enable Cabinet Mapping
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
  1. Screen

Retrieve Screen Properties Information

GET
/api/v1/screen/base/info
MX6000
TIP
Retrieve screen related properties

Request

None

Request 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 -g --request GET 'http://127.0.0.1:8001/api/v1/screen/base/info'

Responses

🟢200Successful
application/json
Body
code
number 
Error code
optional
data
object 
Data
optional
characteristic
number 
Whether the screen has been corrected
optional
screenImageQualityInfo
array [object {2}] 
Image booster information
optional
multiModeInfo
array [object {2}] 
Multi-mode information
optional
message
string 
optional
Example
{
    "code": 0,
    "data": {
        "characteristic": 0,
        "screenImageQualityInfo": [
            {
                "screenId": "string",
                "version": {
                    "version": 0,
                    "functionList": {
                        "isEDE": true,
                        "isABL": true,
                        "IsItmo": true,
                        "isXBit": true,
                        "is18Bit": true,
                        "isColorSpace": true,
                        "isGrayScale": true,
                        "isMagicGray": true
                    }
                }
            }
        ],
        "multiModeInfo": [
            {
                "screenID": "string",
                "multiModeParam": {
                    "currentCfgParam": {
                        "manufactureName": "string",
                        "cabinetName": "string",
                        "cardModel": "string",
                        "status": "string",
                        "version": "string",
                        "issue": 0
                    },
                    "currentModeId": 0,
                    "modeInfo": [
                        {
                            "modeId": 0,
                            "modeName": "string"
                        }
                    ]
                }
            }
        ]
    },
    "message": "string"
}
Modified at 2024-07-09 11:01:54
Previous
Set Output Bit Depth
Next
Retrieve the Number of Cabinets of the Screen
Built with