水印配置对源流和转码流都生效。
为指定发布点设置水印模版。
PATCH https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/watermark
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
请求包体为 JSON Object 类型,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
watermarkSet |
WaterMark 组成的 JSON Array | 必填。水印配置集,一次最多可以添加 5 个。 |
如果返回的 HTTP 状态码为 200,表示请求成功。
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
PATCH https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/watermark HTTP/1.1
请求 body
{
"waterMarkSet": [
{
"url": "http://pngimg.com/uploads/egg/egg_PNG40777.png",
"x": 0,
"y": 0,
"width": 200,
"height": 200,
"zOrder": 2
},
{
"url": "http://pngimg.com/uploads/egg/egg_PNG40777.png",
"x": 0,
"y": 0,
"width": 300,
"height": 300,
"zOrder": 3
}
]
}
响应行
HTTP/1.1 200 OK
获取指定发布点的水印模版。
GET https://api.sd-rtn.com/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/watermark
参数 | 类型 | 描述 |
---|---|---|
appid |
String | 必填。在声网控制台获取的 App ID。 |
entry_point |
String | 必填。发布点名称。 |
如果返回的 HTTP 状态码为 200,表示请求成功。响应包体中包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
watermarkSet |
WaterMark 组成的 JSON Array | 水印模版列表。 |
如果返回的 HTTP 状态码非 200,表示请求失败。你可以参考 HTTP 状态码了解可能的原因。
请求行
GET https://api.sd-rtn.com/v1/projects/{your_appid}/fls/entry_points/live/settings/watermark HTTP/1.1
响应 body
{
"waterMarkSet": [
{
"url": "http://pngimg.com/uploads/egg/egg_PNG40777.png",
"x": 0,
"y": 0,
"width": 200,
"height": 200,
"zOrder": 2
},
{
"url": "http://pngimg.com/uploads/egg/egg_PNG40777.png",
"x": 0,
"y": 0,
"width": 300,
"height": 300,
"zOrder": 3
}
]
}
响应行
HTTP/1.1 200 OK
水印配置参数,包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
url |
String | 必填。水印图片 URL,目前只支持 PNG 格式的图片。为了方便给不同发布点或者直播流设置不同的水印,你可以在水印图片 URL 中使用以下参数:{entry_point} :该参数会被替换成指定的发布点。{stream_name} :该参数会被替换成指定的流名称。 |
x |
Integer | 必填。水印的 x 坐标。取值范围 [0,1920]。 |
y |
Integer | 必填。水印的 y 坐标。取值范围 [0,1920]。 |
width |
Integer | 必填。水印的宽,取值范围 [0,1920]。 |
height |
Integer | 必填。水印的高。取值范围 [0,1920]。 |
zOrder |
Integer | 必填。水印位于的图层。取值范围 [0,100]。0 代表水印位于最底层,100 代表水印位于最上层。 |
状态码 | 描述 |
---|---|
200 | 请求成功。 |
400 | 参数非法,如 appid 或者 entry_point 为空。 |
401 | 未经授权(客户 ID/客户密钥匹配错误)。 |
404 | 服务器无法根据请求找到资源,即请求的发布点不存在,或者请求的 URI 路径非法。 |
500 | 服务器内部错误,无法完成请求。 |
504 | 服务器内部错误。充当网关或代理的服务器未从远端服务器获取请求。 |