使用 Agora 灵动课堂前,你需要先在 Agora 控制台配置 aPaaS 服务。
配置 aPaaS 服务前,请确保已经具备以下条件:
创建一个 Agora 开发者账号。
在 Agora 控制台创建一个 Agora 项目。
在你的 Agora 项目中开启互动白板服务,并获取白板的 App Identifier 和 SDK Token。
在 Agora 控制台生成一组客户 ID 和客户密钥,用于访问 RESTful API。详见生成客户 ID 和密钥。
第三方云存储账号。灵动课堂中的以下功能需要使用第三方云存储:
参照以下步骤在 Agora 控制台配置 aPaaS 服务。
登录 Agora 控制台,进入项目管理页面。点击 Agora 项目的编辑按钮进入项目编辑页面,然后点击 aPaaS 配置按钮。
在 aPaaS 配置页面,勾选白板、云端录制和环信 IM 选择框,将下文的 JSON 对象示例分别粘贴至编辑框并替换相应参数,然后点击更新。
白板 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": {},
"storageConfig": {}
}
环信 IM JSON 示例
{
"apiHost": "",
"orgName": "",
"appName": "",
"superAdmin": "",
"appKey": "",
"clientId": "",
"clientSecret": ""
}
配置成功后,你可以看到以下页面:
在 Agora 控制台配置 aPaaS 服务后,你可参考《启动课堂》文档使用 Agora Classroom SDK 加入一个灵动课堂。
白板的 JSON 配置对象包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
appId |
String | (必填)你的白板 App Identifier。如不设置,则无法进入灵动课堂。 |
token |
String | (必填)你的白板 SDK Token。如不设置,则无法进入灵动课堂。 |
oss |
Object | (选填)阿里云 OSS 配置,用于储存你在课堂中上传的课件。如不设置,则无法使用白板中的课件上传功能。 注意事项:当前白板只支持阿里云 OSS。 JSON 对象包含以下字段:
|
录制的 JSON 配置对象包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
recordingConfig |
Object | (选填)录制设置。如不设置,则使用合流录制模式且只录制老师的音视频。如需更改录制行为,请参考云端录制设置。 |
storageConfig |
Object | (选填)云存储设置,用于储存你的录制文件。如不设置,你的录制文件会存储在 Agora 的阿里云 OSS 账号中。如需使用你自己的云存储,请参考云存储设置进行配置。请注意以下字段的设置:endpoint : (必填)String 类型,由阿里云 Bucket 名称和访问域名拼成的完整路径。假设你的 Bucket 名称为 "agora-recording" ,阿里云 OSS 访问域名为 "oss-cn-shanghai.aliyuncs.com" ,则 endpoint 字段设为 "https://agora-recording.oss-cn-shanghai.aliyuncs.com" 。fileNamePrefix : (选填)String 数组,指定录制文件在第三方云存储中的存储位置。你可使用变量来指定一个动态路径。你发起录制时,灵动课堂云服务会用真实的值替换变量。详见如何指定动态存储路径。 |
环信 IM 的 JSON 配置对象包含以下字段:
字段 | 类型 | 描述 |
---|---|---|
apiHost |
String | (必填)环信 REST API 访问地址,a1.easemob.com 或 a1.easecdn.com。 |
orgName |
String | (必填)企业的唯一标识,你在环信开发者管理后台注册账号时填写的企业 ID。 |
appName |
String | (必填)企业下 App 的唯一标识,你在环信开发者管理后台创建应用时填写的应用名称。 |
superAdmin |
String | (必填)你在环信开发者管理后台注册时填写的用户名。 |
appKey |
String | (必填)App 的唯一标识,由环信开发者管理后台基于 ${org_name}#${app_name} 的规则生成。 |
clientId |
String | (必填)开发者 Client ID,由环信开发者管理后台生成。 |
clientSecret |
String | (必填)开发者密钥,由环信开发者管理后台生成。 |
你可参考下图在环信开发者管理后台获取上述参数。