getOSDItem.lua
[返回首页]

API说明

获得主码流/子码流的字符叠加配置

参数

HTTP提交参数:GET; POST

通过HTTP测试该API调用 (URL):

Stream
(必需参数)

指定码流

main

主码流

sub

子码流

测试值:

返回

返回JSON格式的结果。该JSON数据的格式如下:

{
/*对象*/

"Result":
数值

200表示OK, 其它错误码含义类似于HTTP Response.

"Status":
"字符串"

状态消息。反馈API执行的结果状态,如有错误,将描述出错的原因。

"Data": [
/*数组*/

每一项为一个OSD叠加项,具体内容如下:

{
/*对象*/

"ID":
整数

当前叠加项的ID,范围 0-3

"Type":
"字符串"

叠加内容类型:

text

指定的文字

time

显示系统时间

none

关闭叠加

"Position":
"字符串"

叠加位置。分别表示:

left-top

左上角

top-center

顶部居中

right-top

右上角

left-bottom

左下角

bottom-center

底部居中

right-bottom

右下角

special

手动指定位置

"X":
整数

像素为单位,手动指定的水平叠加位置(仅当Position参数为special时有效)

"Y":
整数

像素为单位,手动指定的垂直叠加位置(仅当Position参数为special时有效)

"Font":
"字符串"

字体名称。当前支持的字体有:

default

默认,英文

song

中文,宋体

vera

英文

lucida

英文

"Size":
整数

值为0,表示小号字体;1表示中等字体;2表示大号字体;大于2表示指定的文字大小(px)

"Outline":
整数

指定在文字的外围加上边框的粗细;0表示不加边框,数值越大,边框越粗。

"Bold":
整数

0|1, 字体加粗。0表示不加粗,1表示加粗

"Italic":
整数

0|1,斜体。0表示正常,1表示斜体(注:当前尚不支持斜体功能)

"Text":
"字符串"

叠加文字(UTF-8编码,仅当 Type 为 text 时有效)

}
]
}

其它说明

Device HTTP API, v1.0