基本概念
本文介绍使用互动白板服务前需要了解的基本概念。
声网控制台
声网提供给开发者管理声网各项服务的工具。控制台提供直观的界面,方便开发者在使用声网各项服务时进行充值、查询、管理等操作,详见开启和配置互动白板服务。控制台-项目配置-白板服务配置中可以获取 AppIdentifier、AK 和 SK,以及直接生成 SDK Token。
AppIdentifier
项目的唯一标识,也可以称为 App ID。初始化白板 SDK 时需要传入 AppIdentifier。
AK 和 SK
访问密钥对,用于生成互动白板 Token。
SDK Token
声网控制台生成的 SDK Token(动态密钥),一般用于项目测试。在生产环境中,你需要调用服务端 API 或使用示例代码在自己的 App 服务端生成 SDK Token。
Token
声网互动白板 Token 按照级别由高至低分为 SDK Token、Room Token 和 Task Token,每个级别的 Token 均可设置 admin
、writer
或 reader
角色。Token 的级别越高,包含的权限越多。
三种 Token 均可通过以下两种方式生成:
- 使用示例代码在 App 服务端生成 Token,详见在 App 服务端生成 Token。(推荐)
- 调用互动白板服务端 API 生成 Token,详见生成 SDK Token(POST)、生成 Room Token(POST) 和生成 Task Token(POST)。
SDK Token
SDK Token 与特定的互动白板项目绑定,是级别最高的 Token。持有 SDK Token 用户可操作绑定的项目下的所有房间和文档转换任务。不同角色的 SDK Token 具有的权限如下:
权限 | admin(管理员) | writer(读写) | reader(只读) |
---|---|---|---|
创建房间 | ✔ | ✔ | ✘ |
以互动模式加入房间 | ✔ | ✔ | ✘ |
以只读模式加入房间 | ✘ | ✘ | ✔ |
获取房间列表 | ✔ | ✔ | ✘ |
获取房间信息 | ✔ | ✔ | ✘ |
封禁房间 | ✔ | ✘ | ✘ |
对指定场景进行截图 | ✔ | ✔ | ✘ |
对场景组下的所有场景进行截图 | ✔ | ✔ | ✘ |
获取房间的场景地址列表 | ✔ | ✔ | ✘ |
插入新场景 | ✔ | ✔ | ✘ |
场景跳转 | ✔ | ✔ | ✘ |
发起文档转换任务 | ✔ | ✔ | ✘ |
生成同等或以下角色的 Room Token (例如,admin 角色的 SDK Token 可以生成 admin 、writer 或 reader 角色的 Room Token) | ✔ | ✔ | ✔ |
生成同等或以下角色的 Task Token (例如,admin 角色的 SDK Token 可以生成 admin 、writer 或 reader 角色的 Task Token) | ✔ | ✔ | ✔ |
SDK Token 的权限级别很高,如果泄漏,会危害你的业务安全。因此,声网建议:
- 不要将 SDK Token 暴露给客户端、存入数据库或写入配置文件,而是在需要时从业务服务端签出 SDK Token。
- 不要签出永不过期的 SDK Token,而是根据业务需要,设置 SDK Token 的有效时长。
Room Token
Room Token 与特定互动白板项目下的特定房间绑定。持有 Room Token 的用户可操作绑定的房间。不同角色的 Room Token 具有的权限如下:
权限 | admin(管理员) | writer(读写) | reader(只读) |
---|---|---|---|
以互动模式加入特定房间 | ✔ | ✔ | ✘ |
以订阅模式加入特定房间 | ✘ | ✘ | ✔ |
获取特定房间信息 | ✔ | ✔ | ✘ |
封禁特定房间 | ✔ | ✘ | ✘ |
对指定场景进行截图 | ✔ | ✔ | ✘ |
对场景组下的所有场景进行截图 | ✔ | ✔ | ✘ |
获取特定房间的场景地址列表 | ✔ | ✔ | ✘ |
在特定房间内插入新场景 | ✔ | ✔ | ✘ |
特定房间内的场景跳转 | ✔ | ✔ | ✘ |
Task Token
Task Token 与特定项目下的特定文档转换任务绑定。持有 Task Token 的用户可操作绑定的文档转换任务。不同角色的 Task Token 具有的权限如下:
权限 | admin(管理员) | writer(读写) | reader(只读) |
---|---|---|---|
查询特定文档转换任务的进度 | ✔ | ✔ | ✔ |
UUID
房间 UUID
互动白板房间的唯一标识符。调用创建房间成功后会返回房间 UUID。
Task UUID
文档转换任务的唯一标识符。调用发起文档转换成功后会返回 Task UUID。
互动模式
以互动模式加入白板房间的用户具有读写权限,可以对白板进行编辑。持有 writer
或 admin
角色 Room Token 的用户能够以互动模式加入房间。
订阅模式
以订阅模式加入白板房间的用户具有只读权限,只能观看白板内容。持有 reader
角色 Room Token 的用户能够以订阅模式加入房间。
在用户数量较多的房间中,限制房间中处于互动模式的用户数量可以有效提高白板房间连接的稳定性和房间可承载人数上限。
文档转换
声网互动白板提供文档转换服务,支持将 PPT、PPTX、DOC、DOCX 和 PDF 格式的文件转换成静态图片,将 PPT 和 PPTX 的文件转换为动态 HTML 网页,转换后的图片或网页可作为演示资料在互动白板中展示。详见使用文档转换服务。
静态文档转换
将 PPT、PPTX、DOC、DOCX、PDF 格式的文件转换成 PNG、JPG 或 JPEG 格式的静态图片。转换后的文件不保留源文件的动画效果。
动态文档转换
将用 Microsoft Office 编辑的 PPT 和 PPTX 格式的文件,转换成 HTML 网页。转换后的文件会保留源文件里的动画效果。
多窗口模式
多窗口模式是互动白板的一种展示方式,支持在一个白板页面上同时展示多个窗口。这些窗口将悬浮于主白板页面上,各自展示不同的内容,你可以自由拖动、最大化、最小化这些窗口。
互动白板 Fastboard SDK 默认开启多窗口模式;Whiteboard SDK 可通过集成 window-manger
实现多窗口模式。
小窗应用
在多窗口模式下,互动白板支持以新建窗口的方式插入 PPT 或白板插件,它们统称为小窗应用。