文档
测试

实况OSD设置

PUT
http://ip:port/LAPI/V1.0/Channel/0/Media/OSD/0

接口描述

实况OSD设置

请求参数

参数名
类型
描述
必填
AreaNum
int
OSD区域个数
必填
InfoOSD
array
OSD区域配置信息,成员个数由AreaNum决定
必填
Index
int
区域索引,取值范围[0,7],对应区域1-8
必填
Enable
int
区域使能开关,涉及:0-不使能;1-使能
必填
InfoParam
array
信息参数,定长数组,必须下发8个成员信息,参考示例填写方式
必填
InfoType
int
信息类型,涉及:0-不使用;1-自定义文本;2-时间日期(2020-07-15 12:00:00)
必填
Value
string
仅信息类型为1时,填充该字段,汉字进行UTF-8编码,类型为0/2时,内容不填充,例:你好
必填
Area
object
区域坐标
必填
TopLeft
object
左上角坐标
必填
X
int
横坐标,取值范围[0,99]
必填
Y
int
纵坐标,取值范围[0,99]
必填
BotRight
object
右下角坐标
必填
X
int
横坐标,取值范围[0,99]
必填
Y
int
纵坐标,取值范围[0,99]
必填

响应参数

参数名
类型
描述
必填
Response
object
响应消息
必填
ResponseURL
string
响应URL,例:/LAPI/V1.0/Channel/0/Media/OSD/0
必填
CreatedID
int
仅新增订阅用户时,该字段有意义,其余无意义,默认:-1
必填
ResponseCode
int
响应结果码,涉及:0-成功;1-通用错误;2-参数非法;3-未鉴权;4-设备不支持
必填
SubResponseCode
int
子响应结果,仅ResponseCode为3时字段有意义,涉及:0-正常鉴权失败;1-需要二次鉴权
必填
ResponseString
string
响应结果描述,涉及:0-Succeed;1-Common Error;2-Invalid Arguments;3-Not Authorized;4-Not Supported
必填
StatusCode
int
标准响应码,涉及:200;401
必填
StatusString
string
响应描述,涉及:200-Succeed;401-Unauthorized
必填
Data
string
数据
必填

说明 / 示例

请求示例: { "AreaNum": 3, "InfoOSD": [{ "Index":0, "Enable": 1, "InfoParam": [{ "InfoType":2, "Value":"" }, { "InfoType":1, "Value":"区域1第二行" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }], "Area": { "TopLeft": { "X":10, "Y":10 }, "BotRight": { "X":0, "Y":0 } } }, { "Index": 1, "Enable":1, "InfoParam": [{ "InfoType":1, "Value":"区域2第一行" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }], "Area": { "TopLeft": { "X":0, "Y":0 }, "BotRight": { "X":0, "Y":0 } } }, { "Index": 2, "Enable":1, "InfoParam": [{ "InfoType":1, "Value":"区域3第一行" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }, { "InfoType":0, "Value":"" }], "Area": { "TopLeft": { "X":0, "Y":0 }, "BotRight": { "X":0, "Y":0 } } }] } 响应示例: { "Response": { "ResponseURL": "/LAPI/V1.0/Channel/0/Media/OSD/0", "CreatedID": -1, "ResponseCode": 0, "SubResponseCode": 0, "ResponseString": "Succeed", "StatusCode": 0, "StatusString": "Succeed", "Data": "null" } }