# 拼控OpenApi协议文档

## Docs
- [使用说明](https://openapi.novastar.tech/zh/h/doc-7491119.md): 
- [错误码](https://openapi.novastar.tech/zh/h/doc-7491116.md): 
- [更新记录](https://openapi.novastar.tech/zh/h/doc-7607674.md): 

## API Docs
- 设备 [读取设备详细信息](https://openapi.novastar.tech/zh/h/api-359740104.md): 
- 设备 [读取设备子卡信息](https://openapi.novastar.tech/zh/h/api-359969722.md): 
- 设备 [读取设备ip](https://openapi.novastar.tech/zh/h/api-359971244.md): 
- main [读取系统初始化状态](https://openapi.novastar.tech/zh/h/api-95469343.md): 
- main [读取视频服务器地址](https://openapi.novastar.tech/zh/h/api-95469344.md): 此协议在1.9.9.0版本后废除,具体预监拉流相关协议可参考以下说明:
- 屏幕 [设置屏幕gamma](https://openapi.novastar.tech/zh/h/api-360313545.md): 
- 屏幕 [设置屏幕id是否显示](https://openapi.novastar.tech/zh/h/api-371374389.md): 设置屏幕id在编辑页面是否显示
- 屏幕 [设置屏幕的亮度](https://openapi.novastar.tech/zh/h/api-413794238.md): 设置屏幕亮度，只有二合一子卡可设置
- 屏幕 [固化屏幕的亮度](https://openapi.novastar.tech/zh/h/api-413798020.md): 固化屏幕亮度，只有二合一子卡可设置
- 屏幕 [新增屏幕](https://openapi.novastar.tech/zh/h/api-95469368.md): 
- 屏幕 [删除屏幕](https://openapi.novastar.tech/zh/h/api-95469369.md): 
- 屏幕 [读取屏幕详细信息](https://openapi.novastar.tech/zh/h/api-95469370.md): 
- 屏幕 [查询屏幕列表](https://openapi.novastar.tech/zh/h/api-95469371.md): 
- 屏幕 [屏幕FTB](https://openapi.novastar.tech/zh/h/api-95469372.md): 
- 屏幕 [屏幕bkg设置](https://openapi.novastar.tech/zh/h/api-95469373.md): 
- 屏幕 [屏幕Freeze](https://openapi.novastar.tech/zh/h/api-95469374.md): 
- 屏幕 [读取屏幕的非实时上屏状态](https://openapi.novastar.tech/zh/h/api-95469375.md): ```
- 屏幕 [设置屏幕的3D](https://openapi.novastar.tech/zh/h/api-95469376.md): | 说明 |
- 屏幕 [设置屏幕的布局信息](https://openapi.novastar.tech/zh/h/api-95469377.md): | 说明 |
- 屏幕 [设置屏幕的图片OSD](https://openapi.novastar.tech/zh/h/api-95469378.md): 
- 屏幕 [设置屏幕的文字OSD](https://openapi.novastar.tech/zh/h/api-95469379.md): 
- 屏幕 [批量删除屏幕](https://openapi.novastar.tech/zh/h/api-95469380.md): 
- 屏幕 [重命名](https://openapi.novastar.tech/zh/h/api-95469381.md): 
- 输入 [读取输入列表](https://openapi.novastar.tech/zh/h/api-95469345.md): | 说明 |
- 输入 [读取指定input的详细信息](https://openapi.novastar.tech/zh/h/api-95469346.md): crops: 截取相关信息内容
- 输入 [创建输入截取](https://openapi.novastar.tech/zh/h/api-95469347.md): 
- 输入 [删除截取](https://openapi.novastar.tech/zh/h/api-95469348.md): 
- 输入 [修改截取](https://openapi.novastar.tech/zh/h/api-95469349.md): 
- 输入 [设置分辨率](https://openapi.novastar.tech/zh/h/api-95469350.md): 
- 输入 [设置timing](https://openapi.novastar.tech/zh/h/api-95469351.md): 
- 输入 [创建输入分组](https://openapi.novastar.tech/zh/h/api-95469352.md): 
- 输入 [输入分组排序](https://openapi.novastar.tech/zh/h/api-95469353.md): 
- 输入 [修改分组](https://openapi.novastar.tech/zh/h/api-95469354.md): 
- 输入 [删除分组](https://openapi.novastar.tech/zh/h/api-95469355.md): 
- 输入 [分组删除输入源](https://openapi.novastar.tech/zh/h/api-95469356.md): 
- 输入 [导入EDID](https://openapi.novastar.tech/zh/h/api-95469357.md): 
- 输入 [重命名](https://openapi.novastar.tech/zh/h/api-95469358.md): 
- 输入 [创建信号源轮巡](https://openapi.novastar.tech/zh/h/api-360438055.md): 创建信号轮巡
- 输入 [读取信号轮巡列表](https://openapi.novastar.tech/zh/h/api-360441411.md): 返回数据字段说明
- 输入 [修改信号源轮巡信息](https://openapi.novastar.tech/zh/h/api-360448735.md): 
- 输入 [开启信号源轮巡](https://openapi.novastar.tech/zh/h/api-360449658.md): deviceId	设备号
- 输入 [删除信号源轮巡](https://openapi.novastar.tech/zh/h/api-360449776.md): deviceId	设备号
- 输出 [设置4k输出卡timing](https://openapi.novastar.tech/zh/h/api-360305918.md): 
- 输出 [读取详细信息](https://openapi.novastar.tech/zh/h/api-95469359.md): 
- 输出 [读取输出列表](https://openapi.novastar.tech/zh/h/api-95469360.md): 
- 输出 [设置输出的timing](https://openapi.novastar.tech/zh/h/api-95469361.md): 
- 输出 [设置输出分辨率](https://openapi.novastar.tech/zh/h/api-95469362.md): 
- 输出 [设置二合一卡带载面积](https://openapi.novastar.tech/zh/h/api-95469363.md): 
- 输出 [设置画质](https://openapi.novastar.tech/zh/h/api-95469364.md): 
- 输出 [设置输出gamma](https://openapi.novastar.tech/zh/h/api-95469365.md): 
- 输出 [设置输出定位](https://openapi.novastar.tech/zh/h/api-95469366.md): 
- 输出 [重命名](https://openapi.novastar.tech/zh/h/api-95469367.md): 
- 图层 [设置拉流规则(针对IPC信号源)](https://openapi.novastar.tech/zh/h/api-360562732.md): | 说明 |
- 图层 [添加layer](https://openapi.novastar.tech/zh/h/api-95469383.md): ```
- 图层 [删除layer](https://openapi.novastar.tech/zh/h/api-95469384.md): 
- 图层 [读取layer列表](https://openapi.novastar.tech/zh/h/api-95469385.md): 返回数据字段说明
- 图层 [读取layer详细信息](https://openapi.novastar.tech/zh/h/api-95469386.md): 
- 图层 [设置layer基础信息](https://openapi.novastar.tech/zh/h/api-95469387.md):  |说明 |
- 图层 [读取layer的z 序](https://openapi.novastar.tech/zh/h/api-95469388.md): ```
- 图层 [设置layer窗口信息](https://openapi.novastar.tech/zh/h/api-95469389.md):  |说明 |
- 图层 [屏幕layer清除](https://openapi.novastar.tech/zh/h/api-95469390.md): 
- 图层 [设置layer的z序](https://openapi.novastar.tech/zh/h/api-95469391.md): layersZOrderAct操作类型
- 图层 [设置layer的锁定](https://openapi.novastar.tech/zh/h/api-95469392.md): lock	0:关闭(不启用锁);1:开启(锁定)
- 图层 [更改layer源信息](https://openapi.novastar.tech/zh/h/api-95469393.md): ```
- 图层 [layer冻结](https://openapi.novastar.tech/zh/h/api-95469394.md): 
- 图层 [layer模板开窗](https://openapi.novastar.tech/zh/h/api-95469395.md): ```
- 场景 [创建场景](https://openapi.novastar.tech/zh/h/api-95469396.md): 
- 场景 [删除场景](https://openapi.novastar.tech/zh/h/api-95469397.md): 
- 场景 [设置指定场景的基本信息](https://openapi.novastar.tech/zh/h/api-95469398.md): 
- 场景 [播放场景](https://openapi.novastar.tech/zh/h/api-95469399.md): 
- 场景 [读取指定场景的详细信息](https://openapi.novastar.tech/zh/h/api-95469400.md): 
- 场景 [清空场景](https://openapi.novastar.tech/zh/h/api-95469401.md): 
- 场景 [获取屏幕场景分组列表](https://openapi.novastar.tech/zh/h/api-95469402.md): | 说明 |
- 场景 [创建场景分组](https://openapi.novastar.tech/zh/h/api-95469403.md): | 说明 |
- 场景 [删除场景分组](https://openapi.novastar.tech/zh/h/api-95469404.md): 
- 场景 [获取场景分组枚举](https://openapi.novastar.tech/zh/h/api-95469405.md): 
- 场景 [场景轮巡播放](https://openapi.novastar.tech/zh/h/api-95469406.md): deviceId		设备ID
- 场景 [读取屏幕全部场景](https://openapi.novastar.tech/zh/h/api-95469407.md): 
- 场景 [读取场景轮巡](https://openapi.novastar.tech/zh/h/api-95469408.md): 
- 场景 [读取屏幕当前播放场景](https://openapi.novastar.tech/zh/h/api-95469409.md): deviceId	设备ID
- 场景 [编辑场景分组](https://openapi.novastar.tech/zh/h/api-95469410.md):  |说明 |
- 场景 [覆盖场景](https://openapi.novastar.tech/zh/h/api-95469411.md): 
- BKG [创建bkg](https://openapi.novastar.tech/zh/h/api-95469412.md): | 说明 |
- BKG [删除bkg](https://openapi.novastar.tech/zh/h/api-95469413.md): 
- BKG [获取bkg的详细信息](https://openapi.novastar.tech/zh/h/api-95469414.md): | 说明 |
- BKG [bkg综合查询](https://openapi.novastar.tech/zh/h/api-95469415.md): 
- IPC [IPC信号源列表](https://openapi.novastar.tech/zh/h/api-95469417.md): 
- IPC [IPC信号源列表数据的指定读取](https://openapi.novastar.tech/zh/h/api-95469418.md): 
- IPC [IPC摄像头列表](https://openapi.novastar.tech/zh/h/api-95469419.md):  |说明 |
- IPC [IPC源下的获取通道列表](https://openapi.novastar.tech/zh/h/api-95469420.md): 
- IPC [IPC源下获取通道列表详情](https://openapi.novastar.tech/zh/h/api-95469421.md): 
- IPC [IPC拼接源通道数据详情](https://openapi.novastar.tech/zh/h/api-95469422.md): 
- IPC [IPC源新增](https://openapi.novastar.tech/zh/h/api-95469423.md): 
- IPC [IPC源删除](https://openapi.novastar.tech/zh/h/api-95469424.md): 
- IPC [IPC源重命名](https://openapi.novastar.tech/zh/h/api-95469425.md): 
- IPC [IPC源通道修改](https://openapi.novastar.tech/zh/h/api-95469426.md): 
- IPC [IPC源通道添加](https://openapi.novastar.tech/zh/h/api-95469427.md): 
- IPC [IPC源通道删除](https://openapi.novastar.tech/zh/h/api-95469428.md): 
- IPC [IPC源槽位列表数据](https://openapi.novastar.tech/zh/h/api-95469429.md): 
- IPC [IPC源以及通道数据统计](https://openapi.novastar.tech/zh/h/api-95469430.md): 
- IPC [IPC源名称检查](https://openapi.novastar.tech/zh/h/api-95469431.md): 
- IPC [IPC分组列表](https://openapi.novastar.tech/zh/h/api-95469432.md): 
- IPC [IPC分组创建](https://openapi.novastar.tech/zh/h/api-95469434.md): 
- IPC [IPC分组删除](https://openapi.novastar.tech/zh/h/api-95469435.md): 
- IPC [IPC分组修改](https://openapi.novastar.tech/zh/h/api-95469436.md): 
- IPC [IPC源分组删除节点](https://openapi.novastar.tech/zh/h/api-95469437.md): 
- IPC [IPC拼接源列表](https://openapi.novastar.tech/zh/h/api-95469438.md):  |说明 |
- IPC [创建IPC拼接源模板](https://openapi.novastar.tech/zh/h/api-95469439.md):  |说明 |
- IPC [更新IPC拼接源模板](https://openapi.novastar.tech/zh/h/api-95469440.md):  |说明 |
- IPC [删除IPC拼接源模板](https://openapi.novastar.tech/zh/h/api-95469441.md): 
- IPC [应用IPC拼接源模板](https://openapi.novastar.tech/zh/h/api-95469442.md): 
- IPC [IPC拼接源重命名](https://openapi.novastar.tech/zh/h/api-95469443.md):