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 Input Source List

GET
/api/v1/device/input/sources
/api/v1/device/input/sources
All
TIP
Retrieve all input source information (source ID, groupId, type) of the device

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/sources'

Responses

🟢200Successful
application/json
Body
id
integer 
Source ID
required
int
cardId
integer 
Card ID
required
int
type
integer 
Input interface type: HDMI, SDI, etc. [0: DVI, 1: DualDVI, 2: HDMI1.4, 3: HDMI 2.0, 4: DP 1.1, 5: DP 1.2, 6 DP 1.4, 7: 3G SDI, 8: 6G SDI, 9: 12G SDI, 10: PiP Video, 11: HDMI 1.2, 12: HDMI 2.1, 13: Internal Source]
required
Uint8
name
string 
Input source name
required
order
integer 
Source order (internal use only)
required
uint8
step
integer 
Step (internal use only)
required
int
supportFrameRate
string 
All supported frame rates (internal use only)
required
supportResolution
string 
All supported resolutions (internal use only)
required
maxwidth
integer 
Maximum resolution width supported (internal use only)
required
int
maxheight
integer 
Maximum resolution height supported (internal use only)
required
int
minwidth
integer 
Minimum resolution width supported (internal use only)
required
int
minheight
integer 
Minimum resolution height supported (internal use only)
required
actualResolution
object 
The actual resolution
required
height
integer 
Width
required
int
width
integer 
Height
required
int
actualRefreshRate
number 
Actual frame rate
required
float
bitDepth
integer 
Input source bit depth (internal use only)
required
int
colorSpace
string 
Video format (internal use only)
required
0: RGB, 1: YCbCr 4:2:2, 2: YCbCr 4:4:4, 3: YCbCr 4:2:0
dynamicRange
string 
Dynamic range (internal use only)
required
gamut
string 
Color gamut (internal use only)
required
range
integer 
0x00: limit, 0x01: full
required
int
scanMode
integer 
0x00: progressive scanning, 0x01: Interlace Scanning
required
int
inPhase
boolean 
Whether in phase (internal use only)
required
defaultEDID
object 
Default resolution
required
resolution
object 
Resolution
required
refreshRate
number 
Refresh rate
required
float
isCustom
boolean 
Indicates whether the default EDID configuration is customized.
required
true: Customized, false: Default list item.
usable
boolean 
Connector usage status (internal use only)
required
groupId
integer 
Source group ID
required
uint8
isSupportHDR
boolean 
Whether HDR is supported
required
isSupportMetaData
boolean 
Whether MetaData is supported
required
isSupportEDID
boolean 
Whether EDID settings are supported
required
isSupportInputOverride
boolean 
Whether InfoFrame Override is supported
required
isSupportColorAdjust
string 
Whether color adjustment is supported
required
sourceChannel
integer 
Source number (unique within the card, for input view, internal use only)
required
uint8
metaData
object 
MetaData (internal use only)
required
minMasterDisplayLight
number 
Min display mastering luminance
required
float
maxMasterDisplayLight
number 
Max display mastering luminance
required
float
maxContentLight
number 
Max content light level (MaxCLL)
required
float
maxFrameAvgLight
number 
Max frame-average light level (MaxFLL)
required
float
whitePointX
number 
Whitepoint coordinate X
required
float
whitePointY
number 
Whitepoint coordinate Y
required
float
hDRParams
object 
HDRParams (internal use only)
required
overrideHdrType
integer 
Current mode
required
int
pqMode
integer 
PQ mode
required
int
pqMaxCllChecked
boolean 
Whether MaxCLL override is enabled
required
pqMaxCll
integer 
MaxCLL value
required
int
realHdrType
integer 
Real mode
required
int
isSupportHDRParams
boolean 
Whether HDR10 parameters are supported
required
isSupportPQMaxCllChecked
boolean 
Whether HDR10 override is supported
required
hdrList
array[integer]
HDR list
required
isEdidCustom
boolean 
Indicates whether it is customized EDID
required
true: Customized, false: Default list item.
sourceStatus
integer 
Source link status
required
0x00: Not inserted 0x01: Signal available
Example
{
  "id": 0,
  "cardId": 0,
  "type": 0,
  "name": "string",
  "order": 0,
  "step": 0,
  "supportFrameRate": "string",
  "supportResolution": "string",
  "maxwidth": 0,
  "maxheight": 0,
  "minwidth": 0,
  "minheight": 0,
  "actualResolution": {
    "height": 0,
    "width": 0
  },
  "actualRefreshRate": 0,
  "bitDepth": 0,
  "colorSpace": "string",
  "dynamicRange": "string",
  "gamut": "string",
  "range": 0,
  "scanMode": 0,
  "inPhase": true,
  "defaultEDID": {
    "resolution": {
      "width": 0,
      "height": 0
    },
    "refreshRate": 0,
    "isCustom": true
  },
  "usable": true,
  "groupId": 0,
  "isSupportHDR": true,
  "isSupportMetaData": true,
  "isSupportEDID": true,
  "isSupportInputOverride": true,
  "isSupportColorAdjust": "string",
  "sourceChannel": 0,
  "metaData": {
    "minMasterDisplayLight": 0,
    "maxMasterDisplayLight": 0,
    "maxContentLight": 0,
    "maxFrameAvgLight": 0,
    "whitePointX": 0,
    "whitePointY": 0
  },
  "hDRParams": {
    "overrideHdrType": 0,
    "pqMode": 0,
    "pqMaxCllChecked": true,
    "pqMaxCll": 0,
    "realHdrType": 0
  },
  "isSupportHDRParams": true,
  "isSupportPQMaxCllChecked": true,
  "hdrList": [
    0
  ],
  "isEdidCustom": true,
  "sourceStatus": 0
}
Modified at 2024-07-09 11:01:54
Previous
Enable Cabinet Mapping
Next
Switch Source for Layer
Built with