You need to enable JavaScript to run this app.
导航
添加水印模板
最近更新时间:2024.08.27 16:36:33首次发布时间:2024.08.27 16:36:33

调用 CreateWatermarkPresetV2 接口,添加水印模板。添加完成后您需要在推流时将直播流与水印模板绑定,在完成水印模板绑定后,当前直播流的所有转码流都会携带该水印。

使用说明

在推流时绑定水印模板,需要在推流地址中携带 wm 参数(取值 1 表示开启水印,取值 0 表示关闭水印)和 任一模板标识(wmid 表示模板 ID,wmname 表示模板名称)。
例如,推流时您可以使用 rtmp://push.example.com/live/stream?wm=1&wmid=12344567rtmp://push.example.com/live/stream?wm=1&wmname=example 地址实现直播流和水印模板的绑定。

注意事项

  • 请求频率:单用户请求频率限制为 5 次/秒
  • 生效说明:新增、变更、删除水印模板,均需在新增、变更、删除操作后(3-5 分钟)重新进行推拉流才会使用变更后的配置。

请求说明

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

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringCreateWatermarkPresetV2接口名称。当前 API 的名称为 CreateWatermarkPresetV2
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
PresetNameStringwatermark001水印模板的名称标识,不可重复,默认传空将由系统为您自动生成。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_) 和短横线(-)组成,长度为 1 到 20 个字符。

Picture

String

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

水印图片字符串,图片最大 2MB,最小 100Bytes,最大分辨率为 1080×1080。图片 Data URL 格式为:data:image/[<mediatype>];[base64],<data>

  • mediatype:图片类型,支持 png、jpg、jpeg 格式;
  • data:base64 编码的图片字符串。

说明

Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。

PictureUrl

String

https://example.com/watermark-image.jpg

水印图片对应的 HTTP 地址。

说明

Picture 与 PictureUrl 字段二选一必传,同时传入时,以 Picture 参数为准。

PosXFloat0水平偏移,表示水印左侧边与转码流画面左侧边之间的距离,使用相对比率,取值范围为 [0,1],默认为 0。
PosYFloat0垂直偏移,表示水印顶部边与转码流画面顶部边之间的距离,使用相对比率,取值范围为 [0,1],默认为 0。

RelativeWidth

Float

0.1

水印相对宽度,水印宽度占直播转码流画面宽度的比例,取值范围为 [0,1],水印高度会随宽度等比缩放。

说明

RelativeWidth 与 RelativeHeight 二选一必传。

RelativeHeight

Float

0.1

水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。

说明

RelativeWidth 与 RelativeHeight 二选一必传。

PreviewWidthFloat1920水印图片预览背景宽度,单位为 px。
PreviewHeightFloat1080水印图片预览背景高度,单位为 px。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
IDInteger12344567水印模板的 ID。
PresetNameStringwatermark001水印模板的名称标识。

请求示例

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"
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。

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