拼控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信号源)
      POST
    • 添加layer
      POST
    • 删除layer
      POST
    • 读取layer列表
      POST
    • 读取layer详细信息
      POST
    • 设置layer基础信息
      POST
    • 读取layer的z 序
      POST
    • 设置layer窗口信息
      POST
    • 屏幕layer清除
      POST
    • 设置layer的z序
      POST
    • 设置layer的锁定
      POST
    • 更改layer源信息
      POST
    • layer冻结
      POST
    • layer模板开窗
      POST
  • 场景
    • 创建场景
    • 删除场景
    • 设置指定场景的基本信息
    • 播放场景
    • 读取指定场景的详细信息
    • 清空场景
    • 获取屏幕场景分组列表
    • 创建场景分组
    • 删除场景分组
    • 获取场景分组枚举
    • 场景轮巡播放
    • 读取屏幕全部场景
    • 读取场景轮巡
    • 读取屏幕当前播放场景
    • 编辑场景分组
    • 覆盖场景
  • 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. 图层

添加layer

POST
/open/api/layer/create
"audioStatus": 
    isAvailable图层的音频是否可用
    isOpen图层的音频是否打开播放

"general": 
  name 图层的名称;
  isFreeze是否冻结
  flipType 翻转类型(0:正常;1:水平翻转;2:垂直翻转;3:镜像翻转)

  isBackground 图层是否为所在screen的背景;
  sizeType [0:SL,1:DL,2:4K]
  type 图层的类型[0:mix,1:SL 2:remapping ]
  lock 是否锁定

"source":
  sourceType源类型:
0:无源,
1:普通输入源类型
IPC类型: 255 或者 3 (1990之前版本传递255; 1990之后传递3与255皆可)
  cropId截取Id,255表示使用原始源
  interfaceType 接口类型
 connectCapacity连接容量
  slotId槽位id
  name源名称
"window":
  width宽,单位:像素
  height 高,单位:像素
  x   水平起始位置,单位:像素
  y   垂直起始位置,单位:像素
普通输入源开窗
{
    "body": {
        "screenId": 0,
        "audioStatus": {
            "isAvailable": 0,
            "isOpen": 0
        },
        "general": {
            "name": "图层 1",
            "isFreeze": false,
            "flipType": 0,
            "isBackground": false,
            "sizeType": 0,
            "type": 1,
            "lock": 0
},
        "source": {
            "sourceType": 1,
            "inputId": 16,
            "cropId": 255,
            "interfaceType": 6,
            "connectCapacity": 2,
            "slotId": 4,
            "name": "input 5-1"
        },
        "window": {
            "width": 1920,
            "height": 1080,
            "x": 1000,
            "y": 1000
        },
        "deviceId": 0
    },
    "sign": "NTY2YjQ2MDEwMWJlOGU5ZmRmZjA0YTk3YmZhYjYwZmI=",
    "pId": "Mjcx",
  "timeStamp": "1689586062335"
}
信号轮训源开窗
{
    "screenId": 0,
    "audioStatus": {
        "isAvailable": 0,
        "isOpen": 0
    },
    "general": {
        "name": "图层 1",
        "zorder": 0,
        "isFreeze": false,
        "flipType": 0,
        "isBackground": false,
        "sizeType": 0,
        "type": 1,
        "lock": 0
    },
    "source": {
        "sourceType": 6,
        "sourceId": 0,
        "name": "信号轮巡 1"
    },
    "window": {
        "width": 3840,
        "height": 2160,
       "x": 1000,
        "y": 1000
    },
    "deviceId": 0
}

请求参数

Body 参数application/json

示例
{
    "body":{
        "screenId":3,
        "deviceId":0,
        "general":{
            "name":"Layer22",
            "isBackground":false,
            "isFreeze":false,
            "flipType":1
        },
        "source":{
            "slotId":0,
            "interfaceType":0,
            "sourceType":0,
            "inputId":0,
            "cropId":255
        },
        "window":{
            "width":90,
            "height":90,
            "x":1000,
            "y":1000
        }
    },
    "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/layer/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body":{
        "screenId":3,
        "deviceId":0,
        "general":{
            "name":"Layer22",
            "isBackground":false,
            "isFreeze":false,
            "flipType":1
        },
        "source":{
            "slotId":0,
            "interfaceType":0,
            "sourceType":0,
            "inputId":0,
            "cropId":255
        },
        "window":{
            "width":90,
            "height":90,
            "x":1000,
            "y":1000
        }
    },
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "data": {
        "id": 0
    },
    "msg": "",
    "status": 0
}
修改于 2025-10-21 03:31:05
上一页
设置拉流规则(针对IPC信号源)
下一页
删除layer
Built with