拼控OpenApi协议文档
首页
英文版
首页
英文版
  1. 首页
  • 使用说明
  • 错误码
  • 更新记录
  • 设备
    • 读取设备详细信息
      POST
    • 读取设备子卡信息
      POST
    • 读取设备ip
      POST
  • main
    • 读取系统初始化状态
      POST
    • 读取视频服务器地址
      POST
  • 屏幕
    • 设置屏幕gamma
      POST
    • 设置屏幕id是否显示
      POST
    • 设置屏幕的亮度
      POST
    • 固化屏幕的亮度
      POST
    • 新增屏幕
      POST
    • 删除屏幕
      POST
    • 读取屏幕详细信息
      POST
    • 查询屏幕列表
      POST
    • 屏幕FTB
      POST
    • 屏幕bkg设置
      POST
    • 屏幕Freeze
      POST
    • 读取屏幕的非实时上屏状态
      POST
    • 设置屏幕的3D
      POST
    • 设置屏幕的布局信息
      POST
    • 设置屏幕的图片OSD
      POST
    • 设置屏幕的文字OSD
      POST
    • 批量删除屏幕
      POST
    • 重命名
      POST
  • 输入
    • 读取输入列表
    • 读取指定input的详细信息
    • 创建输入截取
    • 删除截取
    • 修改截取
    • 设置分辨率
    • 设置timing
    • 创建输入分组
    • 输入分组排序
    • 修改分组
    • 删除分组
    • 分组删除输入源
    • 导入EDID
    • 重命名
    • 创建信号源轮巡
    • 读取信号轮巡列表
    • 修改信号源轮巡信息
    • 开启信号源轮巡
    • 删除信号源轮巡
  • 输出
    • 设置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. 首页

更新记录

标题
所属版本协议名称更新说明更新时间更新人员
V1980去除开窗请求参数zorder参数修改协议2024/12/09程声清
V1983增加模板开窗接口新增协议2025/1/7程声清
V19901.去除ws请求头认证的问题2.增加输入源单一详情数据的更新3.增加图层的Z序设置的推送信息新增协议2025/2/20程声清
V19901.新增设置ipc源图层使用主辅码流接口2.新增信号源轮巡CRUD接口3.新增预监拉流新的适配方式4.更新OSD相关详细数据新增协议2025/4/15程声清
V2200(待发布)设置屏幕id是否显示新增协议2025-11-04刘爱锋
V2000创建场景修改协议的返回数据2025-11-18刘爱锋
V2000设置屏幕亮度新增协议文档2026-02-02刘爱锋
V2000固化屏幕亮度新增协议文档2025-02-02刘爱锋
修改于 2026-02-06 09:09:59
上一页
错误码
下一页
读取设备详细信息
Built with