文档中心

添加水印

最近更新时间：2024.03.21 13:55:37

首次发布时间：2023.09.25 14:34:06

调用 CreateWatermarkPreset 接口，添加水印配置。

使用说明

直播水印配置依赖于转码配置，创建直播水印配置时需确认在相同的域名空间下存在转码配置。
支持半透明水印，您可根据需要，上传半透明的 PNG 图片。
添加水印配置后，AppName 下的直播流将按照水印配置添加水印，配置完成后约 3-5 分钟生效
水印配置生效后，需要重新转码才会添加水印，对已经开始转码的转码流不会添加水印。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=CreateWatermarkPreset&Version=2023-01-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateWatermarkPreset`	接口名称。当前 API 的名称为 `CreateWatermarkPreset`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间名称，由 1 到 60 位数字、字母、下划线及"-"和"."组成。
App	String	是	`live`	应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。
Orientation	String	否	`vertical`	需要添加水印的直播画面方向，支持 2 种取值。 vertical：竖屏； horizontal：横屏。说明该参数属于历史版本参数，预计将于未来移除。建议使用预览背景高度（PreviewHeight）、预览背景宽度（PreviewWidth）参数代替。
Picture	String	否	`data:image/png;base64,iVBORw0KGg****mCC`	水印图片字符串，图片最大 2MB，最小 100Bytes，最大分辨率为 1080×1080。图片 Data URL 格式为：`data:[<mediatype>];[base64],<data>`。 `mediatype`：图片类型，支持 png、jpg、jpeg 格式； `data`：base64 编码的图片字符串。
PosX	Float	是	`0`	水平偏移，表示水印左侧边与转码流画面左侧边之间的距离，使用相对比率，取值范围为 [0,1]。
PosY	Float	是	`0`	垂直偏移，表示水印顶部边与转码流画面顶部边之间的距离，使用相对比率，取值范围为 [0,1]。
RelativeWidth	Float	否	`0.1`	水印相对宽度，水印宽度占直播转码流画面宽度的比例，取值范围为 [0,1]，水印高度会随宽度等比缩放。与水印相对高度字段冲突，请选择其中一个传参。
PictureUrl	String	否	`https://test-image.jpg`	水印图片对应的 HTTP 地址。与水印图片字符串字段二选一传入，同时传入时，以水印图片字符串参数为准。
PreviewHeight	Float	否	`1080`	水印图片预览背景高度，单位为 px。
PreviewWidth	Float	否	`1920`	水印图片预览背景宽度，单位为 px。
RelativeHeight	Float	否	`0.1`	水印相对高度，水印高度占直播转码流画面高度的比例，取值范围为 [0,1]，水印宽度会随高度等比缩放。与水印相对宽度字段冲突，请选择其中一个传参。

返回参数

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

请求示例 1

命令行请求示例

picture_path="./example_picture.jpeg"; curl -X POST -H "Content-Type: application/json" -d '{"Vhost":"push.example.com", "App":"live", "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=CreateWatermarkPreset&Version=2023-01-01

返回示例 1

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "CreateWatermarkPreset",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

请求示例 2

POST 请求示例

POST https://live.volcengineapi.com?Action=CreateWatermarkPreset&Version=2023-01-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "Orientation": "vertical",
  "PosX": 0.1,
  "PosY": 0.1,
  "RelativeWidth": 0.185,
  "Picture": "data:image/png;base64,iVBORw0KGgo****SuQmCC"
}

返回示例 2

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "CreateWatermarkPreset",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
400	InvalidParam.Empty	%s is required	参数缺失，请检查错误消息中指定的参数是否传入。
403	RequestForbidden	-	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.AccountIDNotAllow	this AccountID does not have permission to access the corresponding resource, please check the request parameters	请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403	RequestForbidden.BillingStatus	Billing status is not available for the AccountID, please activate the service or recharge.	未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404	ResourceNotFound	-	未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500	InternalError	an internal error occurred, please contact the administrator.	出现内部错误，请联系技术支持。
500	InternalError.Preset	an internal error related to preset occurred, please contact the administrator.	出现与功能配置相关的内部错误，请联系技术支持。
502	InternalServiceError	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
502	InternalServiceError.BadResponse	an internal error occurred, please contact the administrator.	服务间出现错误，请联系技术支持。
504	InternalServiceTimeout	Internal Service is timeout. please contact the administrator.	内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。