Set Image OSD

POST

/open/api/screen/writeImageOSD

Field	Description
file	The binary data is converted to Base64 strings.
data	JSON data, details as follows
deviceId	Device ID
screenId	Screen ID
enable	Whether to enable OSD (1: Enable, 0: Disable)
type	OSD type (0: Text, 1: Image)
"isJudge"	Whether to judge the display integrity (0: No, execute directly; 1: Yes, execute only if succeeded, feedback error code 412 if failed)
Set the value of isJudge to 1 for first settings.
x	X coordinate
y	Y coordinate
image	Image data
opacity	Opacity
fileName	File name with extension, eg: 1.ipg
fileLength	File length
width	File width
height	File height
hashSum	Check values

Request

Body Params application/json

Example

{
    "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"
}

Request Code Samples

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"
}'

Responses

🟢200Successful

application/json

Body

Example

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

Modified at 2025-10-23 10:10:22

Set Screen Layout Information

Set Text OSD