1. 接口描述
接口请求域名: live.tencentcloudapi.com 。
添加水印,成功返回水印 ID 后,需要调用CreateLiveWatermarkRule接口将水印 ID 绑定到流使用。 水印数量上限 100,超过后需要先删除,再添加。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:AddLiveWatermark。 |
Version | 是 | String | 公共参数,本接口取值:2018-08-01。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
PictureUrl | 是 | String | 水印图片 URL。 URL中禁止包含的字符: ;(){}$>`#"'| 示例值:http://watermark-101.cos.myqcloud.com/1251830167/imglogo.png |
WatermarkName | 是 | String | 水印名称。 最长30字节。 示例值:logo |
XPosition | 否 | Integer | 显示位置,X轴偏移,单位是百分比,默认 0。 示例值:80 |
YPosition | 否 | Integer | 显示位置,Y轴偏移,单位是百分比,默认 0。 示例值:10 |
Width | 否 | Integer | 水印宽度,占直播原始画面宽度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始宽度。 示例值:100 |
Height | 否 | Integer | 水印高度,占直播原始画面高度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始高度。 示例值:100 |
BackgroundWidth | 否 | Integer | 背景水印宽度。默认宽度1920。 示例值:1920 |
BackgroundHeight | 否 | Integer | 背景水印高度。默认高度1080。 示例值:1080 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
WatermarkId | Integer | 水印ID。 示例值:123 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求示例
添加水印
输入示例
https://live.tencentcloudapi.com/?Action=AddLiveWatermark
&PictureUrl=http://watermark-10005041.cos.myqcloud.com/1251830167/watermark_img_Alogo.png
&XPosition=80
&YPosition=10
&WatermarkName=logo
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
"WatermarkId": 123
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError.ConfOutLimit | 模版数量超过限制。 |
InternalError.DBError | DB执行错误。 |
InternalError.WatermarkAddError | 添加直播水印失败。 |
InvalidParameter | 参数错误。 |
ResourceNotFound.ForbidService | 用户被禁用。 |
ResourceNotFound.FreezeService | 用户服务被冻结。 |
ResourceNotFound.StopService | 账号停服,请先冲正开通服务后再操作。 |
ResourceNotFound.UserDisableService | 用户主动停服。 |
ResourceNotFound.UserNotFount | 用户不存在。 |