add-surface 接口
新增一个叠加选项,主码流和次码流可以分别添加 8 个叠加选项,总计 16 个。
通过 get-info 可以获取到文字和图片叠加相关参数取值范围:
{
"surface": {
"image": {}, // 图片添加的限制条件
"image-type": [], // 图片类型的取值范围
"type": [], // 叠加类型的取值范围
"position": [], // 叠加位置的取值范围
"font-family": [], // 文字叠加字体的取值范围
"font-style": [], // 文字叠加样式的取值范围
"font-weight": [], // 文字叠加字重的取值范围
"time-format": [], // 时间叠加格式的取值范围
}
}
请求方式
GET http://ip/usapi?method=add-surface&type=xxx&stream-index=1...
参数 | 说明 |
---|---|
method | 方法名称:add-surface |
stream-index | 编码码流 0: 主码流 1: 次码流 |
position | 叠加位置 |
x-offset | 叠加位置的左上角x坐标,叠加位置为自定义时有效 |
y-offset | 叠加位置的左上角y坐标,叠加位置为自定义时有效 |
margin | 叠加选项与外边距的宽度,默认值为0 |
condition | 保留参数 |
class | 叠加选项类型 0: 文本 1: 系统时间 2: 图片 |
文本 | |
font-family | 文字字体 |
font-size | 字体大小 |
font-style | 字体样式 |
font-weight | 字体字重 |
font-color | 字体颜色 |
line-width | 边框宽度 |
line-color | 边框颜色 |
width | 文本宽度 |
height | 文本高度 |
text | 文本内容 |
系统时间 | |
font-family | 文字字体 |
font-size | 字体大小 |
font-style | 字体样式 |
font-weight | 字体字重 |
font-color | 字体颜色 |
line-width | 边框宽度 |
line-color | 边框颜色 |
width | 文本宽度 |
height | 文本高度 |
text | 时间格式 |
图片 | |
index | 图片 ID,通过 get-images 获取 |
alpha | 透明度,取值范围0-255 |
scale | 缩放因子,取值范围1-400% |
返回数据
{
"result": 0
}
属性 | 说明 |
---|---|
result | 返回状态,0:新增成功,返回其它值请参考 API 状态码 |