文档

查询水印模板列表

调用DescribeLiveStreamWatermarks查询水印模板列表。

使用说明

本接口支持指定分⻚参数查询水印模板列表信息,调用时请保证参数设置符合要求。

QPS限制

本接口的单用户QPS限制为60次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeLiveStreamWatermarks

系统规定参数。取值:DescribeLiveStreamWatermarks

Domain String live.yourdomain.com

主播流域名。

KeyWord String 445409ec-7eaa-461d-8f29-4bec2eb9****

搜索关键词。模板ID或名称,名称支持模糊搜索。

PageNumber Integer 1

分页的页数。不传默认为1。

PageSize Integer 100

每⻚模板数值,不传默认为100。

返回数据

名称

类型

示例值

描述

Total Integer 100

符合条件的总个数。

RequestId String 5c6a2a0df228-4a64- af62-20e91b9676b3

请求ID。

WatermarkList Array of Watermark

水印模板列表。

Watermark
Type Integer 0

水印类型。

  • 0:图片(目前只支持图片)。
  • 1:文字。
XOffset Float 50.0

⽔印X轴偏移,单位:px。

说明 相对于参考背景宽RefWidth, 如果选择的是TopLeft,那么XOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置X。其中坐标指向背景视频中⼼的⽅向为正⽅向,即X轴的正⽅向是向右。
RefWidth Integer 1920

参考背景视频宽,单位:px。

YOffset Float 100.0

⽔印Y轴偏移,单位:px。

说明 相对于参考背景⾼RefHeight,如果选择的是TopLeft,那么YOffset是指⽔印图⽚的左上⻆和背景视频的左上⻆的相对位置Y。其中坐标指向背景视频中⼼的⽅向为正⽅向,即Y轴的正⽅向是向下。
Height Integer 200

水印图片高度,单位:px。

RefHeight Integer 1080

参考背景视频高,单位:px。

PictureUrl String http://example.com

水印图片链接。

Transparency Integer 255

水印透明度,数值越小越透明。取值:0~255。

Description String my watermark

自定义水印描述信息。

OffsetCorner String TopRight

水印位置。

  • TopLeft:左上。
  • TopRight:右上。
  • BottomLeft:左下。
  • BottomRight:右下。
RuleCount Integer 12

Domain下配置的水印规则数量

Name String livewatermark****

水印名称。

TemplateId String 445409ec-7eaa-4 61d-8f29-4bec2eb9 ****

水印模板ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DescribeLiveStreamWatermarks
&PageNumber=1
&PageSize=100
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamWatermarksResponse>
    <Total>100</Total>
    <RequestId>5c6a2a0df228-4a64- af62-20e91b9676b3</RequestId>
    <WatermarkList>
        <Type>0</Type>
        <XOffset>50</XOffset>
        <RefWidth>1920</RefWidth>
        <YOffset>100</YOffset>
        <Height>200</Height>
        <RefHeight>1080</RefHeight>
        <PictureUrl>http://example.com</PictureUrl>
        <Transparency>255</Transparency>
        <Description>my watermark</Description>
        <OffsetCorner>TopRight</OffsetCorner>
        <RuleCount>12</RuleCount>
        <Name>livewatermark****</Name>
        <TemplateId>445409ec-7eaa-4 61d-8f29-4bec2eb9 ****</TemplateId>
    </WatermarkList>
</DescribeLiveStreamWatermarksResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Total" : 100,
  "RequestId" : "5c6a2a0df228-4a64- af62-20e91b9676b3",
  "WatermarkList" : {
    "Type" : 0,
    "XOffset" : 50,
    "RefWidth" : 1920,
    "YOffset" : 100,
    "Height" : 200,
    "RefHeight" : 1080,
    "PictureUrl" : "http://example.com",
    "Transparency" : 255,
    "Description" : "my watermark",
    "OffsetCorner" : "TopRight",
    "RuleCount" : 12,
    "Name" : "livewatermark****",
    "TemplateId" : "445409ec-7eaa-4 61d-8f29-4bec2eb9 ****"
  }
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)