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 次/秒。

请求说明

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

请求参数

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

Query

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

Body

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

返回参数

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

参数类型示例值描述
PresetObject of Preset-水印模板

Preset

参数类型示例值描述
IDString****1水印模版 ID
AccountIDString****1火山引擎账号 ID
VhostStringlive.example.com域名空间名称
AppStringlive应用名称
PictureStringdata:image/png;base64,iVBORw0KG\*\*\*\*SuQmCC水印图片链接
PictureKeyStringtesttesttest.png水印图片文件名

Orientation

String

horizontal

直播画面方向。

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

示例

请求示例

POST https://live.volcengineapi.com?Action=ListWatermarkPreset&Version=2020-08-01
{
  "Vhost": "live.example.com",
  "App": "live"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "2021072818053901022706413520787",
        "Action": "ListWatermarkPreset",
        "Version": "2020-08-01",
        "Service": "live",
        "Region": "cn-north-1"
    }
    "Result": {
        "Preset": {
            "ID": "****1",
            "AccountID": "****1",
            "Vhost":"live.example.com",
            "App":"live",
            "Orientation": "horizontal", 
            "PosX": 0.1, 
            "PosY": 0.1, 
            "RelativeWidth": 0.185,
            "PictureKey": "testtesttest.png",
            "Picture": "data:image/png;base64,iVBORw0KG****SuQmCC"
        }
    }
}

错误码

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