拼控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. 屏幕

读取屏幕详细信息

POST
/open/api/screen/readDetail
字段说明
deviceId设备号
screenId屏幕id
Osd节点数据参考 https://openapi.novastar.tech/zh/h/api-95469378
OsdImage节点数据参考https://openapi.novastar.tech/zh/h/api-95469378
Bkg参考 https://openapi.novastar.tech/zh/h/api-95469414
Screen3D请参考 https://openapi.novastar.tech/zh/h/api-95469376
audioOuputMode音频输出模式0:随路输出模式 1:固定输出模式,
followId随路模式的音频源inputid
layerId随路模式音频源的所在的图层layerid
inputId固定模式时,音频源inputid
isMute是否静音,1:静音,0:有声音
volume音量大小,0-100
imageQuality画质数据 "all":亮度/对比度的整体值;"R"、"G"、"B"分别代表亮度/对比度的分量值
colorTemperature色温 范围为2000-10000
hue色调;
saturation饱和度;
interfaceId接口号
interfaceType接口类型
resolution分辨率
height高
isInterlace
refresh刷新率 refresh是实际值x100
width宽
usedEyeCare屏幕使用的画质模式的护眼模式开关
eyeCare护眼模式的开关0关闭1开启
mosaic输出的拼接方式
row总行数
column总列数
edgeEnable是否启用边缘融合
edgeWidth边缘宽度
edgeHeight边缘高度
brightness屏幕亮度 值0-100

请求参数

Body 参数application/json

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

返回响应

🟢200成功
application/json
Body

示例
{
    "body": {
        "Bkg": {
            "bkgId": 0,
            "enable": 0,
            "imgUrl": "/data/BKGImage/17590451345451.jpg"
        },
        "Freeze": {
            "enable": 0
        },
        "Ftb": {
            "enable": 1
        },
        "Osd": {
            "deviceId": 0,
            "enable": 0,
            "global": {
                "backgroundColor": {
                    "A": 0,
                    "B": 0,
                    "G": 0,
                    "R": 0
                },
                "backgroundEnable": 1,
                "fontColor": {
                    "A": 100,
                    "B": 0,
                    "G": 0,
                    "R": 255
                }
            },
            "isJudge": 0,
            "position": {
                "height": 540,
                "width": 1920,
                "x": 2285,
                "y": 1115
            },
            "text": []
        },
        "OsdImage": {
            "enable": 0,
            "height": 300,
            "image": {
                "file": {
                    "fileLength": 4096,
                    "fileName": "",
                    "hashSum": 0,
                    "height": 0,
                    "width": 0
                },
                "opacity": 100
            },
            "isJudge": 0,
            "type": 1,
            "width": 1920,
            "x": 1005,
            "y": 1005
        },
        "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
        },
        "brightness": 100,
        "deviceId": 0,
        "gamma": 1,
        "general": {
            "createTime": "1757509392.7567859",
            "name": "屏幕 1"
        },
        "genlock": {
            "enable": 0,
            "status": 0
        },
        "genlockPhase": {
            "phaseEn": 0,
            "phaseOffset": 0
        },
        "imageQuality": [
            {
                "brightness": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "colorTemperature": 6500,
                "contrast": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "eyeCare": 0,
                "hue": 0,
                "imageQualityMode": 0,
                "saturation": 50
            },
            {
                "brightness": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "colorTemperature": 5000,
                "contrast": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "eyeCare": 1,
                "hue": 0,
                "imageQualityMode": 0,
                "saturation": 50
            },
            {
                "brightness": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "colorTemperature": 6500,
                "contrast": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "eyeCare": 0,
                "hue": 0,
                "imageQualityMode": 1,
                "saturation": 50
            },
            {
                "brightness": {
                    "B": 35,
                    "G": 35,
                    "R": 35,
                    "all": 35
                },
                "colorTemperature": 5000,
                "contrast": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "eyeCare": 1,
                "hue": 0,
                "imageQualityMode": 1,
                "saturation": 50
            },
            {
                "brightness": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "colorTemperature": 8700,
                "contrast": {
                    "B": 55,
                    "G": 55,
                    "R": 55,
                    "all": 55
                },
                "eyeCare": 0,
                "hue": 0,
                "imageQualityMode": 2,
                "saturation": 50
            },
            {
                "brightness": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "colorTemperature": 5000,
                "contrast": {
                    "B": 55,
                    "G": 55,
                    "R": 55,
                    "all": 55
                },
                "eyeCare": 1,
                "hue": 0,
                "imageQualityMode": 2,
                "saturation": 50
            },
            {
                "brightness": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "colorTemperature": 8700,
                "contrast": {
                    "B": 55,
                    "G": 55,
                    "R": 55,
                    "all": 55
                },
                "eyeCare": 0,
                "hue": 0,
                "imageQualityMode": 3,
                "saturation": 50
            },
            {
                "brightness": {
                    "B": 50,
                    "G": 50,
                    "R": 50,
                    "all": 50
                },
                "colorTemperature": 5000,
                "contrast": {
                    "B": 55,
                    "G": 55,
                    "R": 55,
                    "all": 55
                },
                "eyeCare": 1,
                "hue": 0,
                "imageQualityMode": 3,
                "saturation": 50
            }
        ],
        "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
        },
        "nonTime": 0,
        "outputMode": {
            "mosaic": {
                "column": 1,
                "edgeEnable": 0,
                "edgeHeight": 0,
                "edgeWidth": 0,
                "row": 1
            },
            "offset": {
                "x": 2285,
                "y": 1115
            },
            "screenInterfaces": [
                {
                    "connectCapacity": 0,
                    "cropx": 0,
                    "cropy": 0,
                    "dlId": 0,
                    "dotpitch": 2,
                    "funcCode": 0,
                    "height": 1080,
                    "interfaceId": 0,
                    "interfaceType": 2,
                    "isCardOnline": 1,
                    "isDL": 0,
                    "mirror": 0,
                    "modelId": 31552,
                    "outputId": 0,
                    "outputName": "output 5-1",
                    "resolution": {
                        "height": 1080,
                        "isInterlace": 0,
                        "refresh": 60,
                        "width": 1920
                    },
                    "rotate": 0,
                    "slotId": 4,
                    "width": 1920,
                    "x": 2285,
                    "y": 1115
                }
            ],
            "size": {
                "height": 1080,
                "width": 1920,
                "x": 2285,
                "y": 1115
            }
        },
        "presetPoll": {
            "enable": 0,
            "presetGroupId": 0
        },
        "screen3D": {
            "Emitter": 0,
            "LeftFirstThenRight": 0,
            "delayTimeMs": 7,
            "delayTimeUs": 0,
            "enable": 0,
            "startPointLeftright": 960,
            "startPointUpdown": 540,
            "type": 0
        },
        "screenBrightness": -1,
        "screenHDR": {
            "ambientLight": 30,
            "hdrEn": 0,
            "hdrMode": 1,
            "lowGray": 15,
            "modeFlag": 4,
            "peakLight": 1000
        },
        "screenId": 0,
        "screenLayers": {
            "deviceId": 0,
            "screenId": 0,
            "screenLayers": [
                {
                    "audioStatus": {
                        "isAvailable": 0,
                        "isOpen": 0
                    },
                    "deviceId": 0,
                    "general": {
                        "flipType": 0,
                        "isBackground": false,
                        "isFreeze": false,
                        "layerId": 2,
                        "lock": 0,
                        "name": "图层 3",
                        "sizeType": 0,
                        "type": 1,
                        "zorder": 1
                    },
                    "isExceedingLimit": false,
                    "layerId": 2,
                    "reverseControl": {
                        "ip": "",
                        "port": 18986
                    },
                    "screenId": 0,
                    "source": {
                        "channelId": 65535,
                        "channelNum": 1,
                        "connectCapacity": 0,
                        "cropId": 255,
                        "decodeId": 255,
                        "decodeMode": 255,
                        "functionType": 0,
                        "hardwareType": 0,
                        "inputId": 10,
                        "interfaceType": 27,
                        "intfCapacity": 255,
                        "modelId": 31504,
                        "montageId": 0,
                        "name": "input 3-4-1",
                        "originalCropId": 0,
                        "originalInputId": 0,
                        "pullId": 65535,
                        "slotId": 2,
                        "sourceId": 0,
                        "sourceType": 1,
                        "streamId": 65535,
                        "streamIndex": 0,
                        "templateId": 65535,
                        "videoMode": 255
                    },
                    "window": {
                        "height": 1080,
                        "lockRatio": 0,
                        "width": 960,
                        "x": 3245,
                        "y": 1115
                    }
                },
                {
                    "audioStatus": {
                        "isAvailable": 0,
                        "isOpen": 0
                    },
                    "deviceId": 0,
                    "general": {
                        "flipType": 0,
                        "isBackground": false,
                        "isFreeze": false,
                        "layerId": 0,
                        "lock": 0,
                        "name": "图层 1",
                        "sizeType": 0,
                        "type": 1,
                        "zorder": 0
                    },
                    "isExceedingLimit": false,
                    "layerId": 0,
                    "reverseControl": {
                        "ip": "",
                        "port": 18986
                    },
                    "screenId": 0,
                    "source": {
                        "channelId": 65535,
                        "channelNum": 1,
                        "connectCapacity": 0,
                        "cropId": 255,
                        "decodeId": 255,
                        "decodeMode": 255,
                        "functionType": 0,
                        "hardwareType": 0,
                        "inputId": 8,
                        "interfaceType": 27,
                        "intfCapacity": 255,
                        "modelId": 31504,
                        "montageId": 0,
                        "name": "input 3-3-1",
                        "originalCropId": 0,
                        "originalInputId": 0,
                        "pullId": 65535,
                        "slotId": 2,
                        "sourceId": 0,
                        "sourceType": 1,
                        "streamId": 65535,
                        "streamIndex": 0,
                        "templateId": 65535,
                        "videoMode": 255
                    },
                    "window": {
                        "height": 1080,
                        "lockRatio": 0,
                        "width": 960,
                        "x": 2285,
                        "y": 1115
                    }
                }
            ]
        },
        "screenType": 1,
        "switchEffect": {
            "PlayPGMIndex": 0,
            "effectType": 0,
            "switchEffect": 0,
            "timeline": 4
        },
        "usedEyeCare": 0,
        "usedImageQualityMode": 0
    },
    "msg": "",
    "sign": "",
    "status": 0
}
修改于 2026-02-03 03:18:46
上一页
删除屏幕
下一页
查询屏幕列表
Built with