拼控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模板开窗
  • 场景
    • 创建场景
      POST
    • 删除场景
      POST
    • 设置指定场景的基本信息
      POST
    • 播放场景
      POST
    • 读取指定场景的详细信息
      POST
    • 清空场景
      POST
    • 获取屏幕场景分组列表
      POST
    • 创建场景分组
      POST
    • 删除场景分组
      POST
    • 获取场景分组枚举
      POST
    • 场景轮巡播放
      POST
    • 读取屏幕全部场景
      POST
    • 读取场景轮巡
      POST
    • 读取屏幕当前播放场景
      POST
    • 编辑场景分组
      POST
    • 覆盖场景
      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. 场景

创建场景

POST
/open/api/preset/createPreset

请求参数

Body 参数application/json

示例
{
    "body":{
        "deviceId":0,
        "name":"preset1",
        "screenId":3,
        "overWrite":0
    },
    "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/preset/createPreset' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body":{
        "deviceId":0,
        "name":"preset1",
        "screenId":3,
        "overWrite":0
    },
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "body": {
        "OSD": {
            "picEnable": 0,
            "wordEnable": 0
        },
        "audio": {
            "audioOutputMode": 0,
            "channelMode": 0,
            "inputId": 255,
            "inputType": 0,
            "interfaceId": 255,
            "isMute": 0,
            "layerId": 255,
            "outputChannelMode": 0,
            "outputInterfaceId": 255,
            "outputSlotId": 255,
            "slotId": 255,
            "volume": 0
        },
        "bkg": {
            "bkgEn": 0
        },
        "createTime": "0",
        "deviceId": 0,
        "layers": [
            {
                "audioStatus": {
                    "isAvailable": 1,
                    "isOpen": 0
                },
                "general": {
                    "flipType": 0,
                    "isBackground": false,
                    "isFreeze": false,
                    "layerId": 0,
                    "lock": 0,
                    "name": "图层 1",
                    "sizeType": 0,
                    "type": 1,
                    "zorder": 0
                },
                "isExceedingLimit": false,
                "source": {
                    "channelId": 65535,
                    "connectCapacity": 2,
                    "cropId": 255,
                    "decodeId": 255,
                    "decodeMode": 255,
                    "functionType": 0,
                    "hardwareType": 0,
                    "inputId": 4,
                    "interfaceType": 8,
                    "intfCapacity": 255,
                    "modelId": 31503,
                    "montageId": 0,
                    "name": "input 2-1",
                    "originalCropId": 0,
                    "originalInputId": 0,
                    "pullId": 65535,
                    "slotId": 1,
                    "sourceId": 0,
                    "sourceType": 1,
                    "streamId": 65535,
                    "streamIndex": 0,
                    "templateId": 65535,
                    "videoMode": 255
                },
                "window": {
                    "height": 1080,
                    "lockRatio": 0,
                    "width": 1920,
                    "x": 2825,
                    "y": 795
                }
            }
        ],
        "layoutTemplateId": 1,
        "name": "场景1-3",
        "noTimeAudio": {
            "audioOutputMode": 0,
            "channelMode": 0,
            "inputId": 255,
            "inputType": 0,
            "interfaceId": 255,
            "isMute": 0,
            "layerId": 255,
            "outputChannelMode": 0,
            "outputInterfaceId": 0,
            "outputSlotId": 0,
            "slotId": 255,
            "volume": 100
        },
        "presetId": 3,
        "screen3D": {
            "Emitter": 0,
            "LeftFirstThenRight": 0,
            "delayTimeMs": 7,
            "delayTimeUs": 0,
            "enable": 0,
            "startPointLeftright": 960,
            "startPointUpdown": 540,
            "type": 0
        },
        "screenId": 0,
        "startTime": ""
    },
    "msg": "",
    "sign": "",
    "status": 0
}
修改于 2025-11-18 08:35:11
上一页
layer模板开窗
下一页
删除场景
Built with