API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > 实时互动-教育版 > 应用配置相关接口 > 设置水印

设置水印

最近更新时间：2024-03-12 01:37:35

我的收藏

本页目录：

1. 接口描述

接口请求域名： lcic.tencentcloudapi.com 。

设置水印

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SetWatermark。
Version 是 String 公共参数，本接口取值：2022-08-17。
Region 否 String 公共参数，此参数为可选参数。
SdkAppId 是 Integer 低代码互动课堂的SdkAppId。

示例值：12333
TeacherUrl 否 String 老师视频区域的水印参数地址，设置为空字符串表示删除
示例值：https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/teacher-02_219090_210001.png
BoardUrl 否 String 白板视频区域的水印参数地址，设置为空字符串表示删除
示例值：https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/board-02_219090_210001.png
VideoUrl 否 String 视频默认图片（在没有视频流的时候显示），设置为空字符串表示删除
示例值：https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/video-02_219090_210001.png
BoardW 否 Float 白板区域水印的宽度，取值:0-100，默认为0，表示区域X方向的百分比
示例值：0
BoardH 否 Float 白板区域水印的高度，取值:0-100，默认为0, 表示区域Y方向的百分比
示例值：0
BoardX 否 Float 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
示例值：50
BoardY 否 Float 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
示例值：50
TeacherW 否 Float 老师视频区域水印的宽度，取值:0-100，默认为0，表示区域X方向的百分比
示例值：0
TeacherH 否 Float 老师视频区域水印的高度，取值:0-100，默认为0, 表示区域Y方向的百分比
示例值：0
TeacherX 否 Float 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
示例值：50
TeacherY 否 Float 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50，则表示位于X轴中间
示例值：50
Text 否 String 文字水印内容，设置为空字符串表示删除
示例值：文本内容
TextColor 否 String 文字水印颜色
示例值：黑

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

设置水印

输入示例

POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetWatermark
<公共请求参数>

{
    "SdkAppId": 123333,
    "TeacherUrl": "https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/teacher-02_219090_210001.png",
    "BoardUrl": "https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/board-02_219090_210001.png",
    "VideoUrl": "https://tcic-backend-record-22112222.cos.ap-beujing.myqcloud.com/video-02_219090_210001.png",
    "BoardW": 0,
    "BoardH": 0,
    "BoardX": 50,
    "BoardY": 50,
    "TeacherW": 0,
    "TeacherH": 0,
    "TeacherX": 50,
    "TeacherY": 50,
    "Text": "文本内容",
    "TextColor": "黑"
}

输出示例

{
    "Response": {
        "RequestId": "e574aae1-lp02-4225-a2f8-9032h7199f5f0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.Content 内容包含非法信息（如色情，恐暴，政治等）。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
中国站