COEX-EN
  1. Retrieve Output Parameters
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
            GET
        • 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. Retrieve Output Parameters

Retrieve Screen Output Data

GET
/api/v1/screen/output
/api/v1/screen/output
All
Retrieve the screen output data (3D on/off, frame multiplication, sync, etc.)

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'

Responses

🟢200Successful
application/json
Body
lowDelay
boolean 
Low latency enable
required
additionalFrameDelay
integer 
Additional frame latency
required
uint8
outputBitDepth
object 
Bit Depth
required
bitDepth
integer 
Output bit depth
required
uint8
currentBitDepth
integer 
Current receiving card bit depth
required
uint8
threeD
object 
3D
required
enable
boolean 
3D on/off
required
sourceMode
integer 
Mode (internal use only)
required
uint8
eyePriority
integer 
Left or right eye (internal use only)
required
uint8
rightEyeOffset
object 
Offset (internal use only)
required
threeDFrame
number 
3D frame multiplication mode (internal use only)
required
threeDFrameList
array[string]
3D frame multiplication list (internal use only)
required
currentFrameRate
number 
Frame rate (internal use only)
required
float
curtainMaxFrameRate
number 
Max frame rate supported by the canvas (internal use only)
required
float32
phaseList
array[number]
Phase offset list (internal use only)
required
float[]
curPhase
object 
Current phase offset (internal use only)
required
type
integer 
Type
required
uint8
value
number 
Value
required
float64
absoluteValue
object 
Absolute value
required
genlock
object 
Genlock (internal use only)
required
masterLayerGroupId
integer 
The input source group ID of the main layer in all-in-one controller mode
required
uint8
selectedType
integer 
Current output mode
required
uint8
syncframeratelist
array [object {2}] 
Data
required
frameRemapingData
object 
Multiply (internal use only)
required
frameType
integer 
Type
required
uint8
frameSwitch
boolean 
On or off
required
boolean
frameRemaping
array[object (Multiply) {7}] 
required
hDREOTFParams
object 
EOTF parameters (internal use only)
required
overridePeakLum
boolean 
Whether to overwrite peak screen brightness
required
peakLuminance
integer 
Peak Screen Brightness
required
int
highLightRatio
integer 
Highlight protection ratio
required
int
darkRatio
integer 
Low-grayscale protection ratio
required
int
sceRatio
integer 
Ambient light ratio
required
int
screenid
string 
Screen ID
required
gamutList
object 
Gamut information
required
currentGamutName
string 
Current gamut name
required
colorGamutInfoList
object 
Gamut information list of the screen
required
[]object
Example
{
  "lowDelay": true,
  "additionalFrameDelay": 0,
  "outputBitDepth": {
    "bitDepth": 0,
    "currentBitDepth": 0
  },
  "threeD": {
    "enable": true,
    "sourceMode": 0,
    "eyePriority": 0,
    "rightEyeOffset": {
      "x": 0,
      "y": 0
    },
    "threeDFrame": 0,
    "threeDFrameList": [
      "string"
    ]
  },
  "currentFrameRate": 0,
  "curtainMaxFrameRate": 0,
  "phaseList": [
    0
  ],
  "curPhase": {
    "type": 0,
    "value": 0,
    "absoluteValue": {
      "phaseline": 0,
      "phasepixel": 0,
      "isValid": true
    }
  },
  "genlock": {
    "masterLayerGroupId": 0,
    "selectedType": 0,
    "syncframeratelist": [
      {
        "selectedType": 0,
        "frameratevalue": 0
      }
    ]
  },
  "frameRemapingData": {
    "frameType": 0,
    "frameSwitch": true,
    "frameRemaping": [
      {
        "index": 0,
        "offsetX": 0,
        "offsetY": 0,
        "rData": 0,
        "gData": 0,
        "bData": 0,
        "customColourEn": true
      }
    ]
  },
  "hDREOTFParams": {
    "overridePeakLum": true,
    "peakLuminance": 0,
    "highLightRatio": 0,
    "darkRatio": 0,
    "sceRatio": 0
  },
  "screenid": "string",
  "gamutList": {
    "currentGamutName": "string",
    "colorGamutInfoList": {
      "fromInputStatus": true,
      "isCustomGamut": true,
      "colorGamutInfo": {
        "colorTemperature": 0,
        "targetGamut": {
          "name": "string",
          "gamut": {
            "rLxy": {
              "name": "string",
              "lum": 0,
              "cx": 0,
              "cy": 0
            },
            "gLxy": {
              "name": "string",
              "lum": 0,
              "cx": 0,
              "cy": 0
            },
            "bLxy": {
              "name": "string",
              "lum": 0,
              "cx": 0,
              "cy": 0
            },
            "wLxy": {
              "name": "string",
              "lum": 0,
              "cx": 0,
              "cy": 0
            }
          }
        }
      }
    }
  }
}
Modified at 2024-07-09 11:01:54
Previous
Enable/Disable 3D
Next
Set Blackout/Freeze Screen
Built with