文档中心
互动直播大班课
Console 官网 社区 技术支持
简体中文
search-icon

灵动课堂前提条件

更新时间 2021/06/21 10:23:47

本页列出你使用灵动课堂的前提条件。

1. 创建 Agora 项目并获取 App ID 和 App 证书

在开始使用 Agora 服务之前，你需要注册一个 Agora 开发者账号。成功注册后，按照以下步骤，在 Agora 控制台创建一个 Agora 项目并获取该项目的 App ID 和 App 证书。

  1. 登录 Agora 控制台，点击左侧导航栏项目管理按钮进入项目管理页面。

  2. 在项目管理页面，点击创建按钮。

    创建项目

  3. 在弹出的对话框内输入项目名称，鉴权机制必须为 APP ID + Token。

  4. 点击提交，新建的项目就会显示在项目管理页中。

  5. Agora 会给每个项目自动分配一个 App ID 作为项目唯一标识。在项目管理页面，找到你刚刚创建的项目，点击 App ID 右侧的眼睛图标就可以直接复制此项目的 App ID。你需要保存此 App ID，后续生成 RTM Token 以及调用 API 时都需要用到。

    获取appid

  6. 点击该项目的编辑按钮进入项目编辑页面，点击主要证书右侧的眼睛图标就可以直接复制此项目的 App 证书。你需要保存此 App 证书，后续生成 RTM Token 进行鉴权时需要用到。

    获取app证书

2. 获取 Agora 互动白板服务的 App Identifier 和 SDK Token

灵动课堂集成了 Agora 互动白板 SDK 以实现互动白板功能。因此，你需要进行以下操作：

  1. 登录 Agora 控制台，为你先前创建的 Agora 项目开启互动白板服务。
  2. 获取互动白板服务的 App Identifier。你需要自行保存此 App Identifier，后续配置灵动课堂时会用到。
  3. 获取互动白板服务的 SDK Token。你需要自行保存此 SDK Token，后续配置灵动课堂时会用到。

3. 开通第三方云存储账号

灵动课堂中的互动白板和云端录制功能都需要使用第三方云存储用于储存课堂文件和录制文件。因此，在使用灵动课堂前，你需要开通一个第三方云存储账号。Agora 建议使用阿里云 OSS，请参考阿里云官方文档开通阿里云 OSS 服务。

4. 在 Agora 控制台配置灵动课堂

参考以下步骤在 Agora 控制台对灵动课堂的白板和云端录制功能进行配置。

  1. 登录 Agora 控制台，进入项目管理页面，找到你刚刚创建的项目，点击该项目的编辑按钮进入项目编辑页面，然后点击 aPaaS 配置按钮。

    项目管理页面

  2. 进入 aPaaS 配置页面，勾选白板和云端录制以开通这两个功能，然后参考下文分别传入相应的 JSON 配置对象，点击更新。返回项目管理页面后，再点击保存以确保 aPaaS 配置生效。

    apaas配置

互动白板

互动白板的 JSON 配置对象包含以下字段：

字段 类型 描述
appId String （必填）你获取到的互动白板 App Identifier。如不设置，则无法进入灵动课堂。
token String （必填）你获取到的互动白板 SDK Token。如不设置，则无法进入灵动课堂。
oss Object （选填）阿里云 OSS 配置，用于储存你在课堂中上传的课件。如不设置，则无法使用白板中的课件上传功能。

注意事项：当前白板只支持阿里云 OSS。

JSON 对象包含以下字段：

  • region: String 型，阿里云 OSS 指定的地区信息，例如 "oss-cn-shanghai"。
  • bucket: String 型，阿里云 OSS 的 Bucket 名称，例如 "agora-whiteboard"。
  • folder: String 型，阿里云 OSS 中的资源路径，例如 "whiteboard"。
  • accessKey：String 型，阿里云访问密钥 AccessKey 中的 AccessKeyId，详见阿里云文档。仅适用于灵动课堂 1.1.0 之前版本。
  • secretKey：String 型，阿里云访问密钥 AccessKey 中的 AccessKeySecret，详见阿里云文档。仅适用于灵动课堂 1.1.0 之前版本。
  • endpoint: String 型，阿里云 OSS 访问域名，例如 "oss-cn-shanghai.aliyuncs.com"。
  • ramAccessKey: String 型，阿里云临时访问密钥 STS AK 的 AccessKeyId。详见阿里云文档。仅适用于灵动课堂 1.1.0 及之后版本。
  • ramAccessSecret: String 型，阿里云临时访问密钥 STS AK 的 AccessKeySecret，详见阿里云文档。仅适用于灵动课堂 1.1.0 及之后版本。
  • roleArn: String 型，阿里云 OSS 临时授权访问的角色 ARN，详见阿里云文档。仅适用于灵动课堂 1.1.0 及之后版本。
  • roleSessionName: （必填）String 型，阿里云 OSS 标识临时访问凭证的名称，详见阿里云文档。仅适用于灵动课堂 1.1.0 及之后版本。

白板 JSON 示例：

{
        "appId": "<your_whiteboard_app_id>",
        "token": "<your_whiteboard_sdk_token>",
        "oss": {
            "region": "oss-cn-shanghai",
            "bucket": "<your_bucket_name>",
            "folder": "whiteboard",
            "accessKey": "<your_access_key>",
            "secretKey": "<your_secret_key>",
            "endpoint": "oss-cn-shanghai.aliyuncs.com"
        }
 }

云端录制

云端录制的 JSON 配置对象包含以下字段：

字段 类型 描述
recordingConfig Object （选填）录制设置。如不设置，则使用合流录制模式且只录制老师的音视频。如需更改录制行为，请参考云端录制设置。
storageConfig Object （选填）云存储设置，用于储存你的录制文件。如不设置，你的录制文件会存储在 Agora 的阿里云 OSS 账号中。如需使用你自己的云存储，请参考云存储设置进行配置。

注意事项：storageConfig 中的 endpoint 字段为由阿里云 Bucket 名称和访问域名拼成的完整路径。假设你的 Bucket 名称为 "agora-whiteboard"，阿里云 OSS 访问域名为 "oss-cn-shanghai.aliyuncs.com"，则 endpoint 字段设为 "https://agora-whiteboard.oss-cn-shanghai.aliyuncs.com"。

云端录制 JSON 示例

{
        "recordingConfig": {},
        "storageConfig": {
            "vendor": 2,
            "region": 1,
            "bucket": "<your_bucket_name>",
            "accessKey": "<your_access_key>",
            "secretKey": "<your_secret_key>",
            "fileNamePrefix": ["directory1","directory2"],
            "endpoint": "https://xxx.oss-cn-shanghai.aliyuncs.com"
        }
}

5. 生成 RTM Token

灵动课堂使用 RTM Token 进行鉴权。 RTM Token 是一种动态密钥，通过 Agora App ID、App 证书、用户 ID 生成，安全性较高。

  • 在项目测试阶段，你可以使用 Agora 提供的临时 RTM Token 生成器，传入你在获取到的 App ID 和 App 证书，然后自行填入一个用户 ID，快速生成一个临时 RTM Token，有效期为 24 小时。
    用户 ID 为一个不超过 64 字节的字符串。以下为支持的字符集范围:
    • 26 个小写英文字母 a-z
    • 26 个大写英文字母 A-Z
    • 10 个数字
    • 0-9
    • 空格
    • "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ","
  • 正式生产环境中，你需要在你的服务端部署一个 RTM Token 生成器。用户进入课堂时，客户端需要向服务端申请 RTM Token；服务端生成 RTM Token 后，再将其传给客户端。详情请参考生成 RTM Token 文档。