COEX-EN
  1. Output
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
          GET
        • Set Output Bit Depth
          PUT
      • 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. Output

Retrieve Display Status

GET
/api/v1/screen/output/display/state
/api/v1/screen/output/display/state
MX6000
TIP
Retrieve the display status of the canvas (canvas position, and whether the blackout and freeze screen functions are enabled)

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/output/display/state'

Responses

🟢200Successful
application/json
Body
mappingState
array [object {2}] 
Mapping status
optional
canvasID
number 
Canvas ID
required
enable
boolean 
Enable
required
displayState
array [object {2}] 
Display status
optional
canvasID
number 
Canvas ID
optional
displayMode
number 
Display mode
optional
0: normal display, 1: frozen, 2: blackout, with the default being the normal display.
Example
{
  "mappingState": [
    {
      "canvasID": 0,
      "enable": true
    }
  ],
  "displayState": [
    {
      "canvasID": 0,
      "displayMode": 0
    }
  ]
}
Modified at 2024-07-09 11:01:54
Previous
Set Multi-mode by Screens
Next
Set Output Bit Depth
Built with