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/screen
All
提示
该接口用于获取该设备下所有屏幕基本信息(屏ID,屏名称等)、箱体信息、幕布信息、图层信息等

请求参数

Query 参数
isNeedCabinetInfo
string 
可选
如果传 1,获取到的屏体数据里的幕布信息中不包含箱子和箱体组数据
示例值:
0:需要 1:不需要 默认为0
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/screen?isNeedCabinetInfo=0:需要 1:不需要 默认为0' \
--header 'Device-Key: 10.40.41.200:8001'

返回响应

🟢200成功
application/json
Body
code
number 
错误码
必需
data
object 
返回数据
必需
screens
array [object {14}] 
屏幕信息
必需
screenGroups
array [object {3}] 
屏幕组信息
必需
message
string 
必需
示例
{
    "code": 0,
    "data": {
        "screens": [
            {
                "screenID": "string",
                "screenName": "string",
                "createTime": "string",
                "workingMode": 0,
                "lowLatency": true,
                "layoutMode": 0,
                "screenIndex": 0,
                "screenGroupID": "string",
                "ordinal": 0,
                "position": {
                    "x": 0,
                    "y": 0
                },
                "canvases": [
                    {
                        "canvasID": 0,
                        "outputCardId": 0,
                        "canvasSerialNum": 0,
                        "ordinal": 0,
                        "size": {
                            "width": 0,
                            "height": 0
                        },
                        "isCustomSize": true,
                        "position": {
                            "x": 0,
                            "y": 0
                        },
                        "rectSize": {
                            "width": 0,
                            "height": 0
                        },
                        "cabinets": [
                            {
                                "cabinetID": 0,
                                "connectID": 0,
                                "outputID": 0,
                                "position": {
                                    "x": 0,
                                    "y": 0
                                },
                                "size": {
                                    "width": 0,
                                    "height": 0
                                },
                                "angle": 0,
                                "lockStatus": true
                            }
                        ],
                        "groups": [
                            {
                                "groupID": "string",
                                "groupName": "string",
                                "groupColor": {
                                    "r": 0,
                                    "g": 0,
                                    "b": 0
                                },
                                "cabinetIDs": [
                                    0
                                ],
                                "angle": 0
                            }
                        ],
                        "maxFrameRate": 0,
                        "layoutLines": [
                            "string"
                        ],
                        "zorder": 0,
                        "frequencyPhaseStatus": 0
                    }
                ],
                "layersInWorkingMode": [
                    {
                        "workingMode": 0,
                        "layerLayoutMode": 0,
                        "layers": [
                            {
                                "id": 0,
                                "layerIndex": 0,
                                "source": 0,
                                "position": {
                                    "x": 0,
                                    "y": 0
                                },
                                "zOrder": 0,
                                "lock": true,
                                "border": {
                                    "enable": true,
                                    "width": 0,
                                    "color": {
                                        "r": 0,
                                        "g": 0,
                                        "b": 0
                                    }
                                },
                                "cut": {
                                    "enable": true,
                                    "rect": {
                                        "x": 0,
                                        "y": 0,
                                        "width": 0,
                                        "height": 0
                                    }
                                },
                                "scaler": {
                                    "width": 0,
                                    "height": 0
                                },
                                "followState": true,
                                "layerInCanvasId": 0
                            }
                        ]
                    }
                ],
                "masterFrameRate": 0,
                "pixToPixMode": 0
            }
        ],
        "screenGroups": [
            {
                "screenGroupID": "string",
                "name": "string",
                "ordinal": 0
            }
        ]
    },
    "message": "string"
}
修改于 2024-06-28 09:21:15
上一页
获取屏幕箱体数量
下一页
获取屏幕属性信息
Built with