Home / Docs Center / Device API Reference / UploadOSDImage ParametersSettings

UploadOSDImage ParametersSettings

Device API Reference · New API

Project: Device Interface Document (New Version) | page_id: 1641

[TOC]

Brief Description
  • Upload OSD image parameter settings
Request URL
  • /xsw/api/sys/command
Request Method
  • POST
Parameters
Parameter Name Required Type Description
command Yes string Command parameter, refer to the remarks
Return Example
  {
    "code": 0,
    "msg": ""
  }

Example:

Remarks
  1. Set the font
    SetOSDText'channel'osdIndex'text'
    Example:
    http://192.168.19.20/api/sys/command?command=SetOSDText'0'1'55

  2. Set the coordinates
    SetOSDPosition'channel'osdIndex'x'y
    Example:
    http://192.168.19.20/api/sys/command?command=SetOSDPosition'0'1'300'60

  3. Set the switch
    SetOSDEnable'channel'osdIndex'enable'
    enable: 0 means off, 1 means on
    Example:
    http://192.168.19.20/api/sys/command?command=SetOSDEnable'0'1'1

  4. Set the font size
    SetOSDFontSize'channel'osdIndex'fontSize'
    The size cannot be greater than 96
    Example:
    http://192.168.19.20/api/sys/command?command=SetOSDFontSize'0'1'32

  5. Set the font color
    SetOSDFontColor'channel'osdIndex'RRGGBB'
    Example:
    http://192.168.19.20/api/sys/command?command=SetOSDFontColor'0'1'FF0000

  • Parameter description
    channel: channel index, starting from 0
    osdIndex: display area, starting from 0
Didn't find what you need?Contact us,Talk to our engineers directly.

Request a Quote

Fill in the form and we will get back with a quote and proposal within 1 business day.

Click "Generate inquiry email" to open your mail client with the body pre-filled. If no mail client is configured, click "Copy" and paste it into webmail — recipient: sunshiyang@xstrive.com.