COEX140
  1. 常用接口
COEX140
  • API使用说明
  • 错误码
  • 常用接口
    • 获取屏幕信息
      GET
    • 设置屏幕亮度
      PUT
    • 设置屏幕gamma
      PUT
    • 设置黑屏冻结
      PUT
    • 获取预设信息
      GET
    • 应用预设
      POST
    • 获取所有箱体信息
      GET
    • 设置箱体的mapping使能
      PUT
    • 获取输入源列表
      GET
    • 图层切换源
      PUT
    • 设置EDID
      PUT
    • 设置屏幕色温
      PUT
    • 获取实时监控信息
      GET
  • 输入
    • 获取输入信息
      • 获取输入源列表
      • 获取输入数据
    • EDID
      • 设置EDID
    • 颜色调节
      • 设置饱和度
      • 设置对比度
      • 设置颜色暗部
      • 设置色调
      • 重置颜色调节
    • 内置源
      • 设置发送卡测试画面
    • 设置HDR模式
      • 设置HDR模式
  • 屏幕
    • 幕布
      • 幕布mapping
    • 图层
      • 图层切换源
    • 处理
      • 3D LUT功能
        • 导入3D LUT文件
        • 删除3D LUT文件
        • 设置3D LUT强度
        • 设置3D LUT使能
    • 画质
      • 色域
        • 以屏幕为单位设置自定义色域
        • 切换色域
      • 获取屏幕显示效果参数
      • 设置屏幕自定义gamma表
      • 设置屏幕色温
      • 设置屏幕亮度
      • 设置屏幕gamma
    • 输出
      • 3D功能
        • 3D发射器功能
          • 设置3D发射器使能
        • 开启/关闭3D
      • 输出参数获取
        • 获取屏幕输出数据
      • 显示模式
        • 设置黑屏冻结
      • 多模式
        • 按屏幕设置多模式
      • 获取显示状态
      • 设置输出位深
      • 输出同步锁定切源
    • 预设
      • 获取预设信息
      • 应用预设
      • 修改预设
    • 计划
      • 获取所有屏的计划信息
      • 设置计划开关状态
      • 删除亮度策略
    • 多模式
    • 获取屏幕箱体数量
      GET
    • 获取屏幕信息
      GET
    • 获取屏幕属性信息
      GET
  • 设备
    • 监控
      • 获取实时监控信息
    • 设备定位
      • 设备定位
    • 设置黑屏冻结
  • 箱体
    • 箱体信息获取
      • 获取所有箱体信息
    • 亮度调节
      • 设置箱体rgb亮度
      • 设置箱体亮度
    • 色温调节
      • 设置箱体的色温
    • 箱体画面控制
      • 设置接收卡测试画面
    • 配置箱体拓扑
      • 移动箱体
    • 箱体定位
      • 设置箱体的mapping使能
    • 多模式
      • 按箱子设置多模式
  1. 常用接口

获取输入源列表

GET
/api/v1/device/input/sources
All
提示
该接口可以获取到该设备下所有输入源信息(源的id,groupId,类型)

请求参数

Header 参数
Device-Key
string 
可选
默认值:
10.40.41.200:8001

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com:8001/api/v1/device/input/sources' \
--header 'Device-Key: 10.40.41.200:8001'

返回响应

🟢200成功
application/json
Body
id
integer 
源ID
必需
int
cardId
integer 
子卡ID
必需
int
type
integer 
输入口的类型
必需
Uint8 (02表示HDMI1_4,03表示HDMI2.0,04表示DP1_1,05表示DP1_2,06表示DP1_4,07表示SDI_3G,08表示SDI_6G,08表示SDI_12G,16表示HDMI1_3,17表示HDMI2_1,18表示PCIE,21表示VByOne,22表示ST2110,224表示内置源)
name
string 
输入源名称
必需
order
integer 
源顺序(仅内部使用)
必需
uint8
step
integer 
步进(仅内部使用)
必需
int
supportFrameRate
string 
支持的所有刷新率(仅内部使用)
必需
supportResolution
string 
支持的所有分辨率(仅内部使用)
必需
maxwidth
integer 
支持的最大分辨率宽(仅内部使用)
必需
int
maxheight
integer 
支持的最大分辨率高(仅内部使用)
必需
int
minwidth
integer 
支持的最小分辨率宽(仅内部使用)
必需
int
minheight
integer 
支持的最小分辨率高(仅内部使用)
必需
actualResolution
object 
实际的分辨率
必需
height
integer 
宽
必需
int
width
integer 
高
必需
int
actualRefreshRate
number 
实际的刷新率
必需
float
bitDepth
integer 
输入源输入位深(仅内部使用)
必需
int
colorSpace
string 
视频格式(仅内部使用)
必需
0表示RGB,1表示YCbCr 4:2:2,2表示YCbCr 4:4:4,3表示YCbCr 4:2:0
dynamicRange
string 
动态范围(仅内部使用)
必需
gamut
string 
色域(仅内部使用)
必需
range
integer 
0x00:limit 0x01:full
必需
int
scanMode
integer 
0x00:progressive scanning 0x01:Interlace Scanning
必需
int
inPhase
boolean 
是否同相位(仅内部使用)
必需
defaultEDID
object 
默认分辨率
必需
resolution
object 
分辨率
必需
refreshRate
number 
刷新率
必需
float
isCustom
boolean 
默认edid配置中是否为自定义
必需
true为自定义,false为默认列表
usable
boolean 
接口使用状态(仅内部使用)
必需
groupId
integer 
源的groupID
必需
uint8
isSupportHDR
boolean 
是否支持HDR
必需
isSupportMetaData
boolean 
是否支持MetaData
必需
isSupportEDID
boolean 
是否支持EDID设置
必需
isSupportInputOverride
boolean 
是否支持输入源覆写
必需
isSupportColorAdjust
string 
是否支持颜色调节
必需
sourceChannel
integer 
源序号(子卡内唯一,回显业务,(仅内部使用))
必需
uint8
metaData
object 
MetaData(仅内部使用)
必需
minMasterDisplayLight
number 
主监视器最小亮度
必需
float
maxMasterDisplayLight
number 
主监视器最大亮度
必需
float
maxContentLight
number 
内容最大亮度
必需
float
maxFrameAvgLight
number 
内容最大帧均亮度
必需
float
whitePointX
number 
白点坐标X
必需
float
whitePointY
number 
白点坐标Y
必需
float
hDRParams
object 
HDRParams(仅内部使用)
必需
overrideHdrType
integer 
当前mode
必需
int
pqMode
integer 
Pq模式
必需
int
pqMaxCllChecked
boolean 
Maxcll是否覆写
必需
pqMaxCll
integer 
Maxcll值
必需
int
realHdrType
integer 
真实模式
必需
int
isSupportHDRParams
boolean 
是否支持HDR10参数
必需
isSupportPQMaxCllChecked
boolean 
是否支持HDR10覆写
必需
hdrList
array[integer]
HDR列表
必需
isEdidCustom
boolean 
是否为自定义EDID
必需
true为自定义,false为默认列表
sourceStatus
integer 
源的link状态
必需
0x00表示未插入 0x01表示有信号
示例
{
    "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
}
修改于 2024-06-26 06:52:39
上一页
设置箱体的mapping使能
下一页
图层切换源
Built with