设置屏幕的文字OSD

POST

/open/api/screen/writeOSD

字段	说明
deviceId	设备号
screenId	屏幕id
enable	是否开启osd，1开启，0不开启
type	osd类型：0：文字；1：图片
isJudge	是否判断显示完整性，0：否，直接执行；1：是,成功才执行，不成功反馈错误码412；首次设置isJudge使用值1
x	x坐标
y	y坐标
words	文字台标
chars	文字内容
font	字体(系统自带10种:分别为:阿里巴巴普惠体,优设标题黑,HarmonyOSSansSC,思源黑体CN-Regular,思源宋体CN-Regular,buttersans,Chivo-Regular,LibreBaskerville-Regular,Porto400,Rany
fontPercent	字号
backgroundEnable	是否启用背景
backgroundType	背景信息
direction	0：从右往左，1：从左往右
aligned	对齐方式，0--左对齐，1—居中对齐，2—右对齐
space	字间距，默认为100表示1.0倍，115表示1.15倍，小于100的时候按100处理
speed	滚动速度
fontColor	前景色A R G B
backgroundColor	背景颜色

请求参数

Body 参数application/json

示例

{
    "body":{
        "screenId":2,
        "deviceId":0,
        "enable":1,
        "isJudge":1,
        "type":0,
        "x":1005,
        "y":1005,
        "width":1920,
        "height":300,
        "words":{
            "chars":"welcome1233",
            "font":0,
            "fontPercent":80,
            "speed":50,
            "direction":0,
            "aligned":0,
            "space":100,
            "backgroundEnable":1,
            "backgroundType":0,
            "fontColor":{
                "A":100,
                "R":255,
                "G":0,
                "B":0
            },
            "backgroundColor":{
                "A":50,
                "R":50,
                "G":50,
                "B":50
            }
        }
    },
    "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/writeOSD' \
--header 'Content-Type: application/json' \
--data-raw '{
    "body":{
        "screenId":2,
        "deviceId":0,
        "enable":1,
        "isJudge":1,
        "type":0,
        "x":1005,
        "y":1005,
        "width":1920,
        "height":300,
        "words":{
            "chars":"welcome1233",
            "font":0,
            "fontPercent":80,
            "speed":50,
            "direction":0,
            "aligned":0,
            "space":100,
            "backgroundEnable":1,
            "backgroundType":0,
            "fontColor":{
                "A":100,
                "R":255,
                "G":0,
                "B":0
            },
            "backgroundColor":{
                "A":50,
                "R":50,
                "G":50,
                "B":50
            }
        }
    },
    "sign":"MjI0OGYzMGQwMjhlMmI4YTNmMjM2MjE3MjYzYTFkODg=",
    "pId":"1",
    "timeStamp":"1631949094265"
}'

返回响应

🟢200成功

application/json

Body

示例

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

修改于 2025-10-20 11:47:45

设置屏幕的图片OSD

批量删除屏幕