拼控OpenApi协议文档
首页
英文版
首页
英文版
  1. 输入
  • 使用说明
  • 错误码
  • 更新记录
  • 设备
    • 读取设备详细信息
      POST
    • 读取设备子卡信息
      POST
    • 读取设备ip
      POST
  • main
    • 读取系统初始化状态
      POST
    • 读取视频服务器地址
      POST
  • 屏幕
    • 设置屏幕gamma
    • 设置屏幕id是否显示
    • 设置屏幕的亮度
    • 固化屏幕的亮度
    • 新增屏幕
    • 删除屏幕
    • 读取屏幕详细信息
    • 查询屏幕列表
    • 屏幕FTB
    • 屏幕bkg设置
    • 屏幕Freeze
    • 读取屏幕的非实时上屏状态
    • 设置屏幕的3D
    • 设置屏幕的布局信息
    • 设置屏幕的图片OSD
    • 设置屏幕的文字OSD
    • 批量删除屏幕
    • 重命名
  • 输入
    • 读取输入列表
      POST
    • 读取指定input的详细信息
      POST
    • 创建输入截取
      POST
    • 删除截取
      POST
    • 修改截取
      POST
    • 设置分辨率
      POST
    • 设置timing
      POST
    • 创建输入分组
      POST
    • 输入分组排序
      POST
    • 修改分组
      POST
    • 删除分组
      POST
    • 分组删除输入源
      POST
    • 导入EDID
      POST
    • 重命名
      POST
    • 创建信号源轮巡
      POST
    • 读取信号轮巡列表
      POST
    • 修改信号源轮巡信息
      POST
    • 开启信号源轮巡
      POST
    • 删除信号源轮巡
      POST
  • 输出
    • 设置4k输出卡timing
    • 读取详细信息
    • 读取输出列表
    • 设置输出的timing
    • 设置输出分辨率
    • 设置二合一卡带载面积
    • 设置画质
    • 设置输出gamma
    • 设置输出定位
    • 重命名
  • 图层
    • 设置拉流规则(针对IPC信号源)
    • 添加layer
    • 删除layer
    • 读取layer列表
    • 读取layer详细信息
    • 设置layer基础信息
    • 读取layer的z 序
    • 设置layer窗口信息
    • 屏幕layer清除
    • 设置layer的z序
    • 设置layer的锁定
    • 更改layer源信息
    • layer冻结
    • layer模板开窗
  • 场景
    • 创建场景
    • 删除场景
    • 设置指定场景的基本信息
    • 播放场景
    • 读取指定场景的详细信息
    • 清空场景
    • 获取屏幕场景分组列表
    • 创建场景分组
    • 删除场景分组
    • 获取场景分组枚举
    • 场景轮巡播放
    • 读取屏幕全部场景
    • 读取场景轮巡
    • 读取屏幕当前播放场景
    • 编辑场景分组
    • 覆盖场景
  • BKG
    • 创建bkg
    • 删除bkg
    • 获取bkg的详细信息
    • bkg综合查询
  • IPC
    • IPC信号源列表
    • IPC信号源列表数据的指定读取
    • IPC摄像头列表
    • IPC源下的获取通道列表
    • IPC源下获取通道列表详情
    • IPC拼接源通道数据详情
    • IPC源新增
    • IPC源删除
    • IPC源重命名
    • IPC源通道修改
    • IPC源通道添加
    • IPC源通道删除
    • IPC源槽位列表数据
    • IPC源以及通道数据统计
    • IPC源名称检查
    • IPC分组列表
    • IPC分组创建
    • IPC分组删除
    • IPC分组修改
    • IPC源分组删除节点
    • IPC拼接源列表
    • 创建IPC拼接源模板
    • 更新IPC拼接源模板
    • 删除IPC拼接源模板
    • 应用IPC拼接源模板
    • IPC拼接源重命名
  1. 输入

读取输入列表

POST
/open/api/input/readList
说明
"inputId":输入id;每个卡固定四个接口id,即输入卡1的四个接口ID分别是0、1、2、3。卡槽不插子卡也占id。
"deviceId":设备id;
"general":
colorDepth":位深;[0:8bits,1:10bits,2:12bits,3:16bits]
"colorSpace":output的颜色空间[0:RGB,1:YCbCr];
"sampleRate":色彩空间/采样率[0:444,1:422,2:420]
"connectCapacity":连接容量,[0:SL,1:DL,2:4K,];
"HDCPEncryted":是否加密;
"cscMode":0 关闭limit2full功能;1:打开limit2full功能
“backup” : 此字段现已经弃用
"resolution":输入的实际分辨率,refresh是实际值x100
"timing":
"refreshRate":刷新率x100
"templateOperationType":[0:默认EDID模板,1:下载EDID的模板]
"horizontal"、"vertical"代表了水平和垂直时序;
"addrTime":水平或垂直分辨率;
"frontPorch":前肩;
"sync":同步;
"syncPolarity":同步极性
"online":[0:表示不在线 1:表示在线 2:表示上线后又掉线]
"isSupportAudio":是否支持音频,0:不支持,1:支持音频
"withAudioInterface":该接口是否有音频接口(比如3.5mm接口)
"audioSrc":0:来自视频接口,1:音频音频接口(比如3.5mm输入)
"linkStatus":音频接口的link状态,0:不在线,1:在线
"hdcpConfig":接口的hdcp配置 [0:关闭 1:hdcp1.3 2:hdcp1.4 3:hdcp2.2]
“reverseControl”: 反控
1、输入源中online=1表示输入源有效。

请求参数

Body 参数application/json

示例
{
    "body":
      "PRHDAqKg0ZVlmoTm5ezyNBhYLkeHY/Bq",
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/open/api/input/readList' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body":
      "PRHDAqKg0ZVlmoTm5ezyNBhYLkeHY/Bq",
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "body": {
        "inputs": [
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-3-1",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-3-1",
                    "dynamicRange": 0,
                    "name": "input 3-3-1",
                    "sampleRate": 0
                },
                "inputId": 8,
                "interfaceId": 0,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 1,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-3-1",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            },
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-3-2",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-3-2",
                    "dynamicRange": 0,
                    "name": "input 3-3-2",
                    "sampleRate": 0
                },
                "inputId": 9,
                "interfaceId": 1,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 0,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-3-2",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            },
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-4-1",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-4-1",
                    "dynamicRange": 0,
                    "name": "input 3-4-1",
                    "sampleRate": 0
                },
                "inputId": 10,
                "interfaceId": 2,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 1,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-4-1",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            },
            {
                "audioInterface": {
                    "audioSrc": 1,
                    "linkStatus": 0,
                    "withAudioInterface": 0
                },
                "backup": {
                    "cropId": 0,
                    "enable": 0,
                    "inputId": 0,
                    "type": 0
                },
                "crops": [],
                "defaultName": "input 3-4-2",
                "general": {
                    "HDCPEncryted": 0,
                    "channelNum": 1,
                    "colorDepth": 0,
                    "colorGamut": 0,
                    "colorRange": 0,
                    "colorSpace": 0,
                    "connectCapacity": 0,
                    "cscMode": 0,
                    "defaultName": "input 3-4-2",
                    "dynamicRange": 0,
                    "name": "input 3-4-2",
                    "sampleRate": 0
                },
                "inputId": 11,
                "interfaceId": 3,
                "interfaceType": 27,
                "isSupportAudio": 0,
                "isUsed": 0,
                "macCompatibility": 0,
                "mismatchState": 0,
                "modelId": 31504,
                "mosaicMode": 0,
                "name": "input 3-4-2",
                "online": 1,
                "overLoadState": 0,
                "resolution": {
                    "height": 0,
                    "isInterlace": 0,
                    "refresh": 0,
                    "width": 0
                },
                "reverseControl": {
                    "ip": "",
                    "port": 18986
                },
                "slotId": 2,
                "sourceType": 1,
                "timing": {
                    "horizontal": {
                        "addrTime": 3840,
                        "frontPorch": 176,
                        "sync": 88,
                        "syncPolarity": 0,
                        "totalTime": 4400
                    },
                    "refreshRate": 60,
                    "templateId": 0,
                    "templateOperationType": 0,
                    "vertical": {
                        "addrTime": 2160,
                        "frontPorch": 8,
                        "sync": 10,
                        "syncPolarity": 0,
                        "totalTime": 2250
                    }
                }
            }
        ]
    },
    "msg": "Success",
    "sign": "",
    "status": 0
}
修改于 2025-10-14 01:55:58
上一页
重命名
下一页
读取指定input的详细信息
Built with