设置屏幕的图片OSD

POST

/open/api/screen/writeImageOSD

字段	说明
file	二级制数据转为Base64字符串
data	json数据，详情如下
deviceId	设备Id
screenId	屏幕id
enable	是否开启osd，1开启，0不开启
type	osd类型：0：文字；1：图片
"isJudge"	是否判断显示完整性，0：否，直接执行；1：是,成功才执行，不成功反馈错误码412；首次设置isJudge使用值1
x	x坐标
y	y坐标
image	图片数据
opacity	不透明度
fileName	文件名（扩展名也要带上），eg :1.ipg
fileLength	文件长度
width	文件宽
height	文件高
hashSum	校验值s

请求参数

Body 参数application/json

示例

{
    "body":{
        "screenId":1,
        "deviceId":0,
        "enable":1,
        "height":400,
        "image":{
            "fileLength":407,
            "fileName":"1.png",
            "opacity":100,
            "hashSum":0,
            "file":"iVBORw0KGgoAAAANSUhEUgAAAA8AAAAZCAYAAADuWXTMAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAEsSURBVDhPY1BUVPxPLh7VTCIejJo9Tv236Lz+X8sEytdp+6+Zfe+/WedroPjT/ybZK/Bo9rvw327S0/86FiB+/X/tpk//7SY8/W+UuvW/dur1/xYTPhGp2WLPf7NJn/4bhYbD5ZX9DhOpWX/9f2OgTbatF/5r2qT8V1KGqCHS2Yr/lZz3/DfuBDod6AIQtqg9RbxmCLb5r6Tb9l895tR/025kPxv2/tcMXPFfzRDKD7gO16zstee/QcHh/+r6UDmoPEKz3eH/FkDnWBav+K+i3/ZfqxIUutf/a2ogyZVv/a9mlv1f2Wbhf31g6CM52+a/aty9/9bAgAH7Cxgteh5xcDmVgAv/zWByQGzb9xSbnz2B/kJECQbWAdqsYQNm4w4wIvCoZhIxBZoV/wMAxH9NlV/X+vkAAAAASUVORK5CYII="
        },
        "isJudge":0,
        "type":1,
        "width":1920,
        "x":1005,
        "y":1005
    },
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/open/api/screen/writeImageOSD' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body":{
        "screenId":1,
        "deviceId":0,
        "enable":1,
        "height":400,
        "image":{
            "fileLength":407,
            "fileName":"1.png",
            "opacity":100,
            "hashSum":0,
            "file":"iVBORw0KGgoAAAANSUhEUgAAAA8AAAAZCAYAAADuWXTMAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAEsSURBVDhPY1BUVPxPLh7VTCIejJo9Tv236Lz+X8sEytdp+6+Zfe+/WedroPjT/ybZK/Bo9rvw327S0/86FiB+/X/tpk//7SY8/W+UuvW/dur1/xYTPhGp2WLPf7NJn/4bhYbD5ZX9DhOpWX/9f2OgTbatF/5r2qT8V1KGqCHS2Yr/lZz3/DfuBDod6AIQtqg9RbxmCLb5r6Tb9l895tR/025kPxv2/tcMXPFfzRDKD7gO16zstee/QcHh/+r6UDmoPEKz3eH/FkDnWBav+K+i3/ZfqxIUutf/a2ogyZVv/a9mlv1f2Wbhf31g6CM52+a/aty9/9bAgAH7Cxgteh5xcDmVgAv/zWByQGzb9xSbnz2B/kJECQbWAdqsYQNm4w4wIvCoZhIxBZoV/wMAxH9NlV/X+vkAAAAASUVORK5CYII="
        },
        "isJudge":0,
        "type":1,
        "width":1920,
        "x":1005,
        "y":1005
    },
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "data": {},
    "msg": "",
    "status": 0
}

修改于 2025-10-20 11:37:13

设置屏幕的布局信息

设置屏幕的文字OSD