COEX-EN
  1. Retrieve Input Information
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
          GET
        • Retrieve Input Source List
          GET
      • 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. Retrieve Input Information

Retrieve Input Data

GET
/api/v1/device/input
/api/v1/device/input
All
TIP
Retrieve input source configuration (including internal sources, source EDID, 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/device/input'

Responses

🟢200Successful
application/json
Body
testPattern
object 
Test pattern (internal use only)
required
mode
integer 
Mode
required
uint8
parameters
object 
Parameter
required
InputPortConfig
object 
Input source configuration
optional
uint8
logicId
integer 
Source logic ID
required
modelId
integer 
Model ID of the source corresponding card (internal use only)
required
hardwareID
string 
Source-corresponding hardware ID (internal use only)
required
cscParameter
object 
Source's CSC parameters (internal use only)
required
edidInfo
object 
EDID information
required
isLimitToFull
boolean 
Whether it is Limited to Full
required
range
integer 
Quantization range
required
colorSpaceType
integer 
Color space
required
colorGamut
integer 
Color gamut
required
hdrParameter
object 
HDR configuration
required
blackLevelInfo
object 
blackLevelInfo parameters (internal use only)
required
capacity
string 
Current port capacity
required
Example
{
  "testPattern": {
    "mode": 0,
    "parameters": {
      "red": 0,
      "green": 0,
      "blue": 0,
      "gray": 0,
      "gridWidth": 0,
      "moveSpeed": 0,
      "gradientStretch": 0,
      "state": 0
    }
  },
  "InputPortConfig": {
    "logicId": 0,
    "modelId": 0,
    "hardwareID": "string",
    "cscParameter": {
      "PortID": 0,
      "HueValue": 0,
      "ContrastValue": 0,
      "SaturationValue": 0
    },
    "edidInfo": {
      "resolution": {
        "width": "string",
        "height": "string"
      },
      "refreshRate": "string",
      "isCustom": "string"
    },
    "isLimitToFull": true,
    "range": 0,
    "colorSpaceType": 0,
    "colorGamut": 0,
    "hdrParameter": {
      "overrideHdrType": 0,
      "pqMode": 0,
      "pqMaxCllChecked": true,
      "realHdrType": "string"
    },
    "blackLevelInfo": {
      "shadow": {},
      "highLight": {}
    },
    "capacity": "string"
  }
}
Modified at 2024-07-09 11:01:54
Previous
Set Screen Color Temperature
Next
Retrieve Input Source List
Built with