You need to enable JavaScript to run this app.
导航
更新水印
最近更新时间:2023.10.12 17:39:58首次发布时间:2022.06.09 10:51:22

修改指定 App 的水印。支持修改水印图片、位置、尺寸等参数。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版更新水印接口。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 生效时间:完成水印更新,需要 5 分钟生效;生效后,在指定应用 App 新产生的转码流中会添加更新后的水印。
  • 请求约束:请求时,仅需要传入待变更的参数。

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=UpdateWatermarkPreset&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringUpdateWatermarkPreset接口名称。当前 API 的名称为 UpdateWatermarkPreset
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述
VhostStringlive.example.com域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成
AppStringlive应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成

Orientation

String

vertical

直播画面方向,支持 2 种取值。

  • vertical:竖屏;
  • horizontal:横屏。

Picture

String

data:image/png;base64,iVBORw0KGg****mCC

水印图片链接,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片使用 data URI 协议,格式为:data:[<mediatype>];[base64],<data>

  • mediatype:图片类型,支持 png、jpg、jpeg 格式;
  • data:base64 编码的图片字符串。
    例如,data:image/png;base64,iVBORw0KGg****mCC

注意

如果水印图片不更新,请勿传入该参数。否则会造成水印无法显示。

PosXFloat0水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1]
PosYFloat0垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1]
RelativeWidthFloat0.1水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放

返回参数

本接口无特有的返回参数。更多信息请见返回结构

示例

请求示例

命令行请求示例

picture_path="./example_picture.jpeg"; curl -X POST -H "Content-Type: application/json" -d '{"Vhost":"testVhost", "App":"testApp", "Orientation": "vertical", "PosX": 0.1, "PosY": 0.1, "RelativeWidth": 0.185, "Picture": "data:'"$(file --mime-type -b ${picture_path})"';base64,'"$(base64 ${picture_path})"'"}' http://live.volcengineapi.com/?Action=UpdateWatermarkPreset&Version=2020-08-01

POST 请求示例

POST https://live.volcengineapi.com?Action=UpdateWatermarkPreset&Version=2020-08-01
{
  "Vhost": "live.example.com",
  "App": "live",
  "Orientation": "horizontal",
  "PosX": 0.1,
  "PosY": 0.1,
  "RelativeWidth": 0.185,
  "Picture": "data:image/png;base64,iVBORw0KGgoA****kSuQmCC"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateWatermarkPreset",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

访问公共错误码获取详细信息。