拼控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/screenLayerLayout
screenId:screen的id;
deviceId:device的id;
name:图层的名称;
layerId:模板开窗自定义图层的id;
sizeType:定义如下:
[
0:SL,
1:DL,
2:4K
];
type:图层的类型,定义如下:
[
0:mix,
1:SL,
2:remapping
];
zorder:图层的z序;
source:图层的源信息;
window:图层的位置信息;
color:无源图层颜色
zorder:图层的z序;
isBackground:图层是否为所在screen的背景;
width、height:图层的宽度和高度;
x、y:图层的坐标
"sourceType :源类型,定义如下:
[
0:无源,
1:输入类型,
3:IPC类型,
4:纯色图层
5:IPC拼接类
];
inputId :源的id。
cropId:截取源id, 为255时,表示使用原始源
isAvailable:图层的音频是否可用,(readonly)
isOpen:图层的音频是否打开播放。(r/w)
lock: 图层是否锁定
connectCapacity: 链接容量

请求参数

Body 参数application/json

示例
{
    "body":{
        "deviceId":0,
        "screenId":3,
        "layers":[
            {
                "layerId":0,
                "general":{
                    "layerId":0,
                    "zorder":0,
                    "name":"图层1",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":4,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-1"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1000,
                    "y":1000
                }
            },
             {
                "layerId":1,
                "general":{
                    "layerId":1,
                    "zorder":1,
                    "name":"图层2",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":5,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-2"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1960,
                    "y":1000
                }
            },
            {
                "layerId":2,
                "general":{
                    "layerId":2,
                    "zorder":2,
                    "name":"图层3",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":6,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-3"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1000,
                    "y":1540
                }
            },
            {
                "layerId":3,
                "general":{
                    "layerId":3,
                    "zorder":3,
                    "name":"图层4",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":7,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-4"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1960,
                    "y":1540
                }
            }
        ]
    },
    "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/screenLayerLayout' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body":{
        "deviceId":0,
        "screenId":3,
        "layers":[
            {
                "layerId":0,
                "general":{
                    "layerId":0,
                    "zorder":0,
                    "name":"图层1",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":4,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-1"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1000,
                    "y":1000
                }
            },
             {
                "layerId":1,
                "general":{
                    "layerId":1,
                    "zorder":1,
                    "name":"图层2",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":5,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-2"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1960,
                    "y":1000
                }
            },
            {
                "layerId":2,
                "general":{
                    "layerId":2,
                    "zorder":2,
                    "name":"图层3",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":6,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-3"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1000,
                    "y":1540
                }
            },
            {
                "layerId":3,
                "general":{
                    "layerId":3,
                    "zorder":3,
                    "name":"图层4",
                    "isBackground":false,
                    "isFreeze":false,
                    "flipType":0
                },
                "lock":0,
                "source":{
                    "sourceType":1,
                    "inputId":7,
                    "cropId":255,
                    "interfaceType":10,
                    "connectCapacity":0,
                    "name":"input 2-4"
                },
                "window":{
                    "width":960,
                    "height":540,
                    "x":1960,
                    "y":1540
                }
            }
        ]
    },
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}'

返回响应

🟢200成功
application/json
Body

示例
{"data":{},"msg":"","status":0}
修改于 2025-10-13 12:12:20
上一页
layer冻结
下一页
创建场景
Built with