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
Retrieve the screen output data (3D on/off, frame multiplication, sync, etc.)

Request

None

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

Responses

🟢200Successful
application/json
Body

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