To use Agora Flexible Classroom, you need to enable and configure the aPaaS service in Agora Console.
Before configuring the aPaaS service, ensure that you meet the following requirements:
Configure the aPaaS service in Agora Console, as follows:
Log in to Agora Console and enter the project management page. In your Agora project, click edit. In Edit, click the Configure aPaaS button.
On the aPaaS Configuration page, select the tickbox next to Whiteboard and Cloud recording to enable these two functions.
To configure the whiteboard and cloud recording service, paste the configuration parameters into the Configuration page as a JSON object, and click Update to apply the configuration.
For example:
Interactive Whiteboard
{
"appId": "<your_whiteboard_app_id>",
"token": "<your_whiteboard_sdk_token>",
"oss": {
"vendor": 1,
"region": "",
"endpoint": "",
"bucket": "",
"folder": "",
"accessKey": "",
"secretKey": ""
}
}
Cloud Recording
{
"recordingConfig": {},
"storageConfig": {
"vendor": 1,
"region": 1,
"bucket": "<your_bucket_name>",
"accessKey": "<your_access_key>",
"secretKey": "<your_secret_key>",
"fileNamePrefix": ["directory1","directory2"],
"endpoint": ""
}
}
After returning to the project management page, click Save to ensure the aPaaS configuration takes effect.
After configuring the aPaaS service, refer to the following documents to launch a flexible classroom using the Agora Classroom SDK as it is:
The JSON object for Interactive Whiteboard contains the following fields:
Field Name | Type | Description |
---|---|---|
appId |
String | (Required) The App Identifier of the Interactive Whiteboard service that you get in the previous step. If you do not set this parameter, you cannot enter a classroom. |
token |
String | (Required) The SDK Token of the Interactive Whiteboard service that you get in the previous step. If you do not set this parameter, you cannot enter a classroom. |
oss |
Object | (Optional) The configuration of Amazon S3 for storing the files you upload in a classroom. If you do not set this parameter, you cannot upload any file in the classroom. The JSON object for the whiteboard contains the following fields:
Note: To get the above information about a third-party storage service, see the documentation of Amazon S3. |
The JSON object for Cloud Recording contains the following fields:
Field Name | Type | Description |
---|---|---|
recordingConfig |
Object | (Optional) Recording configuration. If you do not set this parameter, Agora records the audio and video of teachers in a classroom in composite recording mode by default. To change the recording configuration, see the cloud recording configuration. |
storageConfig |
Object | (Optional) Cloud storage configuration, used for storing your recorded files. If you do not set this parameter, your recorded files will be stored in Agora's Amazon S3 account. To use your own cloud storage, see the cloud storage configuration. |