API
通过 Client API,用您自己的软件控制房间。
API 附加组件会开放房间的 WebSocket Client API。您的软件会像手持演示遥控器的演讲者一样加入房间:它可以切换幻灯片、运行演讲者计时器、移动激光点,并向主持人发送消息。


您将获得的功能
幻灯片控制
下一张和上一张;在演示应用支持的情况下,还可跳到第一张、最后一张或指定幻灯片,以及黑屏。
计时器控制
开始、停止、重置,增加或减少 1、2 或 5 分钟,使用 5 到 20 分钟的预设,或设置最长 999 分钟的任意时间。
激光点
在主持人的共享屏幕上移动激光点。
发送给主持人的消息
发送最多 1000 个字符的备注。
套餐
| 套餐 | API |
|---|---|
| Presenter、Studio HD、Studio 4K | 购买附加组件 |
| Studio 8K、Enterprise | 已包含 |
它没有应用界面。您需要在自己的代码中使用它。
购买
使用
检查许可证
主持人的许可证需要包含 API 附加组件,或者为 Studio 8K 或 Enterprise。
连接
按照 WebSocket 中的说明连接到房间。
发送命令
发送幻灯片、计时器、指针和消息命令。对于计时器命令,主持人必须允许来自您连接的点击。
https://cliqer.io/dash/team/api-keys 上的团队 API 密钥是 Studio 8K 和 Enterprise 的另一项独立功能,用于 REST 端点。它们不会连接到房间套接字。
没有 API 时,套接字会拒绝命令,并返回错误
api_not_in_plan。限制
| 项目 | 限制 |
|---|---|
| 幻灯片和计时器命令 | 每秒 10 条 |
| 消息 | 每 10 秒 5 条 |
| 指针移动 | 每秒 30 次 |
| 消息长度 | 1000 个字符 |
超出限制时,套接字会回复 rate_limited。
常见问题
以主持人的许可证为准。您的软件只需要该房间的会话令牌。
不可以。团队 API 密钥仅适用于 REST 端点。
主持人必须允许来自您连接的点击,并且主持人的许可证必须包含 API。