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/cabinet
All
提示
该接口用于获取箱体的信息

请求参数

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/cabinet' \
--header 'Device-Key: 10.40.41.200:8001'

返回响应

🟢200成功
application/json
Body
array of:
resolution
object 
箱体像素点(仅内部使用)
必需
width
integer 
箱体宽
必需
Int32
默认值:
0
height
integer 
箱体高
必需
Int32
默认值:
0
size
object 
箱体物理尺寸
必需
width
integer 
箱体宽
必需
Int32
默认值:
0
height
integer 
箱体高
必需
Int32
weight
integer 
箱体重量(仅内部使用))
必需
Int32
默认值:
0
power
integer 
箱体功率(仅内部使用)
必需
Int32
默认值:
0
gamma
object 
R G B Gamma值(仅内部使用)
必需
r
number 
红gamma值
必需
默认值:
2.8
g
number 
绿gamma值
必需
默认值:
2.8
b
number 
蓝gamma值
必需
默认值:
2.8
colorTemperature
integer 
色温值
必需
Int32
默认值:
6500
voltage
integer 
箱体电压(仅内部使用)
必需
Int32
默认值:
5.0
rvCardName
string 
箱体中接收卡名称(仅内部使用)
必需
brightness
number 
亮度
必需
float
customGamma
boolean 
自定义gamma使能(仅内部使用)
必需
默认值:
false
gain
object 
电流增益(仅内部使用)
必需
r
integer 
红增益
必需
Int32
默认值:
0
g
integer 
绿增益
必需
Int32
默认值:
0
b
integer 
蓝增益
必需
Int32
默认值:
0
outputID
integer 
箱体所在的网口号
必需
uint8
默认值:
0
canvasID
integer 
箱体所在的幕布ID
必需
outputCardID
integer 
箱体所在的输出子卡ID
必需
index
integer 
箱体索引(仅内部使用)
必需
uint32
默认值:
0
bunchesIndex
integer 
箱体所在的串索引(仅内部使用)
必需
uint16
默认值:
0
id
integer 
箱体ID
必需
uint64
默认值:
0
moduleCount
integer 
箱体中模组数量(仅内部使用)
必需
int
默认值:
0
cabType
string 
箱体类型(仅内部使用)
必需
beacon
boolean 
Beacon使能(仅内部使用)
必需
indicatorLightState
boolean 
接收卡指示灯状态(仅内部使用)
必需
manufacture
string 
箱体厂商(仅内部使用)
必需
pointSpacing
string 
箱体点间距(仅内部使用)
必需
shortName
string 
箱体短名称(仅内部使用)
必需
familyName
string 
箱体系列名称(仅内部使用)
必需
ncpVersion
string 
箱体库版本(仅内部使用)
必需
vsFreMax
场频最大值(仅内部使用)
必需
angle
integer 
旋转角度(仅内部使用)
必需
moduleSize
object 
覆写的模组大小(仅内部使用)
必需
overwrite
boolean 
是否覆写
必需
moduleRow
integer 
行
必需
moduleCol
integer 
列
必需
rvCardInfo
object 
接收卡信息(仅内部使用)
必需
firmware
string 
固件版本
必需
firmwareRemark
string 
fpga版本备注信息
必需
mcuFirmWare
string 
MCU固件版本
必需
mcuFirmWareRemark
string 
MCU版本备注信息
必需
driverChip
string 
驱动芯片
必需
decodeIc
string 
译码ic型号
必需
scanNumber
number 
扫描数
必需
moduleResolution
object 
模组规格
必需
refreshRate
视觉刷新率
必需
grayScale
number 
灰度级数
必需
chipEffectFlag
number 
芯片高低有效
必需
maxGamma
number 
ICN芯片最大gamma值
必需
cabinetFileParam
object 
在用的箱体文件参数(仅内部使用)
必需
manufactureName
string 
厂商
必需
cabinetName
string 
箱体名称
必需
cardModel
string 
卡型号
必需
status
string 
发布状态
必需
version
string 
版本号
必需
issue
string 
修订号
必需
示例
[
    {
        "resolution": {
            "width": "0",
            "height": "0"
        },
        "size": {
            "width": "0",
            "height": 0
        },
        "weight": "0",
        "power": "0",
        "gamma": {
            "r": "2.8",
            "g": "2.8",
            "b": "2.8"
        },
        "colorTemperature": "6500",
        "voltage": "5.0",
        "rvCardName": "string",
        "brightness": 0,
        "customGamma": false,
        "gain": {
            "r": "0",
            "g": "0",
            "b": "0"
        },
        "outputID": "0",
        "canvasID": 0,
        "outputCardID": 0,
        "index": "0",
        "bunchesIndex": "0",
        "id": "0",
        "moduleCount": "0",
        "cabType": "string",
        "beacon": true,
        "indicatorLightState": true,
        "manufacture": "string",
        "pointSpacing": "string",
        "shortName": "string",
        "familyName": "string",
        "ncpVersion": "string",
        "vsFreMax": null,
        "angle": 0,
        "moduleSize": {
            "overwrite": true,
            "moduleRow": 0,
            "moduleCol": 0
        },
        "rvCardInfo": {
            "firmware": "string",
            "firmwareRemark": "string",
            "mcuFirmWare": "string",
            "mcuFirmWareRemark": "string",
            "driverChip": "string",
            "decodeIc": "string",
            "scanNumber": 0,
            "moduleResolution": {
                "width": 0,
                "height": 0
            },
            "refreshRate": null,
            "grayScale": 0,
            "chipEffectFlag": 0,
            "maxGamma": 0
        },
        "cabinetFileParam": {
            "manufactureName": "string",
            "cabinetName": "string",
            "cardModel": "string",
            "status": "string",
            "version": "string",
            "issue": "string"
        }
    }
]
修改于 2024-07-02 03:49:48
上一页
应用预设
下一页
设置箱体的mapping使能
Built with