COEX-EN
  1. General
COEX-EN
  • Contents
    • API Instructions
    • Error Code
    • General
      • Retrieve Screen Information
        GET
      • Set Screen Brightness
        PUT
      • Set Screen Gamma
        PUT
      • Set Blackout/Freeze Screen
        PUT
      • Retrieve Preset Information
        GET
      • Apply Preset
        POST
      • Retrieve All Cabinet Information
        GET
      • Enable Cabinet Mapping
        PUT
      • Retrieve Input Source List
        GET
      • Switch Source for Layer
        PUT
      • Set EDID
        PUT
      • Set Screen Color Temperature
        PUT
    • 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
      • Retrieve the Number of Cabinets of the Screen
      • Retrieve Screen Information
    • 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. General

Retrieve Screen Information

GET
/api/v1/screen
/api/v1/screen
MX6000CX80MX40 Pro
TIP
Retrieve all basic information of screens (screen ID, screen name, etc.), cabinet information, canvas information, layer information, etc.

Request

Query Params
isNeedCabinetInfo
string 
optional
Whether to include cabinet information. 0: Yes, 1: No.

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?isNeedCabinetInfo='

Responses

🟢200Successful
application/json
Body
code
number 
The return code, refer to "Error Codes."
required
data
object 
Return Data
required
screens
array [object {14}] 
Screen information
required
screenGroups
array [object {3}] 
Screen group information (internal use only)
required
message
string 
required
Example
{
  "code": 0,
  "data": {
    "screens": [
      {
        "screenID": "string",
        "screenName": "string",
        "createTime": "string",
        "workingMode": 0,
        "lowLatency": true,
        "layoutMode": 0,
        "screenIndex": 0,
        "screenGroupID": "string",
        "ordinal": 0,
        "position": {
          "x": 0,
          "y": 0
        },
        "canvases": [
          {
            "canvasID": 0,
            "outputCardId": 0,
            "canvasSerialNum": 0,
            "ordinal": 0,
            "size": {
              "width": 0,
              "height": 0
            },
            "isCustomSize": true,
            "position": {
              "x": 0,
              "y": 0
            },
            "rectSize": {
              "width": 0,
              "height": 0
            },
            "cabinets": [
              {
                "cabinetID": 0,
                "connectID": 0,
                "outputID": 0,
                "position": {
                  "x": 0,
                  "y": 0
                },
                "size": {
                  "width": 0,
                  "height": 0
                },
                "angle": 0,
                "lockStatus": true
              }
            ],
            "groups": [
              {
                "groupID": "string",
                "groupName": "string",
                "groupColor": {
                  "r": 0,
                  "g": 0,
                  "b": 0
                },
                "cabinetIDs": [
                  0
                ],
                "angle": 0
              }
            ],
            "maxFrameRate": 0,
            "layoutLines": [
              "string"
            ],
            "zorder": 0,
            "frequencyPhaseStatus": 0
          }
        ],
        "layersInWorkingMode": [
          {
            "workingMode": 0,
            "layerLayoutMode": 0,
            "layers": [
              {
                "id": 0,
                "layerIndex": 0,
                "source": 0,
                "position": {
                  "x": 0,
                  "y": 0
                },
                "zOrder": 0,
                "lock": true,
                "border": {
                  "enable": true,
                  "width": 0,
                  "color": {
                    "r": 0,
                    "g": 0,
                    "b": 0
                  }
                },
                "cut": {
                  "enable": true,
                  "rect": {
                    "x": 0,
                    "y": 0,
                    "width": 0,
                    "height": 0
                  }
                },
                "scaler": {
                  "width": 0,
                  "height": 0
                },
                "followState": true,
                "layerInCanvasId": 0
              }
            ]
          }
        ],
        "masterFrameRate": 0,
        "pixToPixMode": 0
      }
    ],
    "screenGroups": [
      {
        "screenGroupID": "string",
        "name": "string",
        "ordinal": 0
      }
    ]
  },
  "message": "string"
}
Modified at 2025-04-03 01:53:50
Previous
Error Code
Next
Set Screen Brightness
Built with