1. 接口描述
接口请求域名: lcic.tencentcloudapi.com 。
设置跑马灯参数设置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SetMarquee。 |
Version | 是 | String | 公共参数,本接口取值:2022-08-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | Integer | 学校ID 示例值:3290189 |
RoomId | 是 | Integer | 房间号 示例值:1123 |
MarqueeType | 是 | Integer | 跑马灯类型:1为固定值,2为用户昵称,3为固定值+用户昵称,4为用户ID,5为originId+固定值,6为用户昵称(originId) 示例值:1 |
DisplayMode | 是 | Integer | 显示方式:1为滚动,2为闪烁 示例值:1 |
Content | 否 | String | 固定值内容(当MarqueeType=1或5,则展示固定值内容) 示例值:直播课堂 |
FontSize | 否 | Integer | 字体大小(数字,像素单位,范围:10到24)。 示例值:10 |
FontWeight | 否 | Integer | 字体粗细:1为粗体,0为细体 示例值:1 |
FontColor | 否 | String | 字体颜色(十六进制颜色值,例如:#00FF00(绿色)) 示例值:#00FF00 |
FontOpacity | 否 | Float | 字体透明度(数字,范围 0.0 到 1.0) 示例值:0.3 |
BackgroundColor | 否 | String | 背景颜色(十六进制颜色值,例如:#FFFF00(黄色)) 示例值:#FFFF00 |
BackgroundOpacity | 否 | Float | 背景透明度(数字,范围 0.0 到 1.0) 示例值:0.1 |
Duration | 否 | Integer | 跑马灯文字移动/闪烁指定像素所需时间,范围:1-10;数值越小,跑马灯滚动/闪烁速度越快 示例值:1 |
MarqueeCount | 否 | Integer | 跑马灯个数:目前仅支持1或2, 对应显示单排或双排 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置跑马灯参数设置
输入示例
输出示例
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ClassStarted | 课堂状态错误,课堂已开始。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.SdkAppId | SdkAppId参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
UnknownParameter | 未知参数错误。 |