调用 CreateWatermarkPresetV2
接口,添加水印模板。添加完成后您需要在推流时将直播流与水印模板绑定,在完成水印模板绑定后,当前直播流的所有转码流都会携带该水印。
在推流时绑定水印模板,需要在推流地址中携带 wm 参数(取值 1 表示开启水印,取值 0 表示关闭水印)和 任一模板标识(wmid 表示模板 ID,wmname 表示模板名称)。
例如,推流时您可以使用 rtmp://push.example.com/live/stream?wm=1&wmid=12344567
或 rtmp://push.example.com/live/stream?wm=1&wmname=example
地址实现直播流和水印模板的绑定。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateWatermarkPresetV2 | 接口名称。当前 API 的名称为 CreateWatermarkPresetV2 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
PresetName | String | 否 | watermark001 | 水印模板的名称标识,不可重复,默认传空将由系统为您自动生成。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_) 和短横线(-)组成,长度为 1 到 20 个字符。 |
Picture | String | 否 |
| 水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:
说明 Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。 |
PictureUrl | String | 否 |
| 水印图片对应的 HTTP 地址。 说明 Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。 |
PosX | Float | 否 | 0 | 水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1],默认为 0。 |
PosY | Float | 否 | 0 | 垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1],默认为 0。 |
RelativeWidth | Float | 否 |
| 水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。 说明 RelativeWidth 与 RelativeHeight 二选一必传。 |
RelativeHeight | Float | 否 |
| 水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。 说明 RelativeWidth 与 RelativeHeight 二选一必传。 |
PreviewWidth | Float | 否 | 1920 | 水印图片预览背景宽度,单位为 px。 |
PreviewHeight | Float | 否 | 1080 | 水印图片预览背景高度,单位为 px。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ID | Integer | 12344567 | 水印模板的 ID。 |
PresetName | String | watermark001 | 水印模板的名称标识。 |
POST https://live.volcengineapi.com?Action=CreateWatermarkPresetV2&Version=2023-01-01 { "PictureUrl": "https://example.com/watermark-image.jpg", "PreviewWidth": 1920, "PreviewHeight": 1080, "RelativeHeight": 0.1, "PosX": 0, "PosY": 0, "PresetName": "watermark001" }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "CreateWatermarkPresetV2", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "ID": 12344567, "PresetName": "watermark001" } }
您可访问公共错误码,获取更多错误码信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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. | 内部服务超时,请联系技术支持。 |