You need to enable JavaScript to run this app.
导航
更新水印配置
最近更新时间:2024.05.08 19:20:17首次发布时间:2023.09.25 14:34:06

调用 UpdateWatermarkPreset 接口,更新已添加的水印配置。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 使用限制:
    • 直播水印配置依赖于转码配置,创建直播水印配置时需确认在相同的域名空间下存在转码配置。
    • 非必选参数不填时,表示使用原水印配置取值。
  • 生效说明:新增、变更、删除水印配置,均需在新增、变更、删除操作后(3-5 分钟)重新进行推流才会使用变更后的配置。

请求说明

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

调试

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间,您可以调用 ListVhostWatermarkPreset 接口,查看待更新水印配置的 Vhost 取值。
AppStringlive应用名称,您可以调用 ListVhostWatermarkPreset 接口,查看待更新水印配置的 App 取值。

Orientation

String

vertical

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

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

说明

该参数属于历史版本参数,预计将于未来移除。建议使用预览背景高度(PreviewHeight)、预览背景宽度(PreviewWidth)参数代替。

Picture

String

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

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

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

注意

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

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

PictureUrl

String

https://test-image.jpg

水印图片对应的 HTTP 地址。与水印图片编码字符串字段二选一传入。同时传入时,以水印图片编码字符串参数为准。

注意

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

PreviewHeightFloat1080水印图片预览背景高度,单位为 px。
PreviewWidthFloat1080水印图片预览背景宽度,单位为 px。
RelativeHeightFloat0.1水印相对高度,水印高度占直播转码流画面高度的比例,取值范围为 [0,1],水印宽度会随高度等比缩放。与水印相对宽度字段冲突,请选择其中一个传参。

返回参数

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

请求示例 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=2023-01-01

返回示例 1

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

请求示例 2

POST 请求示例

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

返回示例 2

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

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
400InvalidParam.Length%s should not be longer than %d参数长度错误,请检查错误消息中指定参数的长度是否超过限制。
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-未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持
404ResourceNotFound.PresetNotExistpreset not found未找到配置模版。请检查传入的配置模版与创建好的配置模板是否一致。
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.内部服务超时,请联系技术支持

服务端 SDK

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