H Series OpenAPI Instructions
Home
ChineseVersion
Home
ChineseVersion
  1. Screen
  • Instructions
  • Error Codes
  • Change History
  • Devices
    • Read Device Detailed Information
      POST
    • Read Device Card Information
      POST
    • Read Device IP
      POST
  • Homepage
    • Read System Initialization Status
      POST
    • Read Video Server Address
      POST
  • Screen
    • Set Screen Gamma
      POST
    • Display Screen ID
      POST
    • Set Screen Brightness
      POST
    • Save Screen Brightness
      POST
    • Add Screens
      POST
    • Delete Screens
      POST
    • Read Screen Detailed Information
      POST
    • Query Screen List
      POST
    • Screen FTB
      POST
    • Set BKG
      POST
    • Set Freezing
      POST
    • Read Screen Not in Live Mode
      POST
    • Set 3D Effect
      POST
    • Set Screen Layout Information
      POST
    • Set Image OSD
      POST
    • Set Text OSD
      POST
    • Delete Multiple Screens
      POST
    • Rename Screens
      POST
  • Inputs
    • Read Input List
    • Read Detailed Information of Specified Inputs
    • Set Cropping
    • Delete
    • Edit Cropping
    • Set Resolutions
    • Set Timing
    • Create Input Groups
    • Sort Input Groups
    • Edit Groups
    • Delete Groups
    • Delete Input Sources by Groups
    • Import EDID
    • Rename
    • Create Signal Source Playlists
    • Read Signal Source Playlists
    • Edit Signal Source Playlist Information
    • Enable Signal Source Playlists
    • Delete Signal Source Playlists
  • Outputs
    • Set Image Quality
    • Set Gamma
    • Set Output Locating
    • Rename
    • Set Timing for 4K Output Card
    • Read Detailed Information
    • Read Output List
    • Se Output Timing
    • Set Output Resolutions
    • Set Areas Loaded by All-in-One Cards
  • Layers
    • Set Stream Pulling Rules for IPC Sources Only
    • Add Layers
    • Delete Layers
    • Read Layer List
    • Read Layer Details
    • Set Layer Basic Information
    • Read Layer Z-order
    • Set Layer Information
    • Clear Layers
    • Set Layer Z-order
    • Lock Layers
    • Change Layer Source Information
    • Freeze Layers
    • Open Layer Layouts
  • Presets
    • Create Presets
    • Delete Presets
    • Set Basic Information of Specified Presets
    • Load Presets
    • Read Detailed Information of Specified Presets
    • Clear Presets
    • Get Preset Group List
    • Create Preset Groups
    • Delete Preset Groups
    • Get Preset Group Enumeration
    • Play Preset Playlist
    • Read All Presets
    • Read Preset Playlist
    • Read Current Played Preset
    • Edit Preset Groups
    • Overwrite Presets
  • BKG
    • Create BKG
    • Delete BKG
    • Get BKG Detailed Information
    • Comprehensive Query
  • IPC
    • IPC Source List
    • Read Specified Data in IPC Source List
    • IP Camera List
    • Obtain IPC Source Channel List
    • Obtain Details of IPC Source Channel List
    • Details of IPC Mosaic Source Channel Data
    • Add IPC Sources
    • Delete IPC Sources
    • Rename IPC Sources
    • Change IPC Source Channels
    • Add IPC Source Channels
    • Delete IPC Source Channels
    • IPC Source Slot List
    • IPC Sources and Channels
    • Check IPC Source Names
    • IPC Source Group List
    • Create IPC Source Groups
    • Delete IPC Source Groups
    • Change IPC Groups
    • Delete IPC Source Group Nodes
    • IPC Mosaic Source List
    • Create IPC Mosaic Source Templates
    • Update IPC Mosaic Source Templates
    • Delete IPC Mosaic Source Templates
    • Apply IPC Mosaic Source Templates
    • Rename IPC Mosaic Sources
  1. Screen

Set Text OSD

POST
/open/api/screen/writeOSD
FieldDescription
deviceIdDevice ID
screenIdScreen ID
enableWhether to enable OSD (1: Enable, 0: Disable)
typeOSD type (0: Text, 1: Image)
isJudgeWhether 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.
xX coordinate
yY coordinate
wordsText logo
charsText
fontText font (The system provides ten fonts as follows.)
优设标题黑
HarmonyOSSansSC
思源黑体CN-Regular
思源宋体CN-Regular
buttersans
Chivo-Regular
LibreBaskerville-Regular
Porto400
Rany])
fontPercentFont size
backgroundEnableWhether to enable BKG
backgroundTypeBKG information
direction0: From right to left, 1: From left to right
alignedAlignment method (0: Align left, 1: Center, 2: Align right)
spaceText spacing (The value of 100 indicates 1.0 times, and the value of 115 indicates 1.15 times. When the value is less than 100, it is treated as 100.
speedScrolling speed
fontColorForeground color A R G B
backgroundColorBackground color

Request

Body Params application/json

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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"
}'

Responses

🟢200Successful
application/json
Body

Example
{
    "data": {},
    "msg": "",
    "status": 0
}
Modified at 2025-10-23 10:10:39
Previous
Set Image OSD
Next
Delete Multiple Screens
Built with