Configure Flexible Classroom

This page introduces how to configure the whiteboard and recording features in Flexible Classroom in Agora Console.

Configure the whiteboard feature

If you want to upload PPT, Word, or PDF files to a flexible classroom and display these files on the whiteboard, you need to configure the whiteboard feature in Agora Console.

Prerequisites

The whiteboard feature in Flexible Classroom requires a third-party cloud storage service for storing files uploaded in a classroom. Before configuring the whiteboard feature, ensure that you have enabled a third-party cloud storage service. Temporarily, Agora only supports Amazon S3.

Procedure

On the Flexible Classroom configuration page, find the whiteboard module, as shown in the following figure:

You need to do the following:

1. Enable the advanced services. See Enable whiteboard server-side features.

2. Configure a third-party cloud storage service for storing files uploaded in a classroom. Fill in the following information:

   • region: The location of the data center you specified when creating a bucket in Amazon S3.
   • endpoint: The domain name used to access the Amazon S3 service, such as s3.us-east-2.amazonaws.com.
   • Bucket: The bucket name in Amazon S3.
   • folder: The domain name used to access the Amazon S3 service, such as whiteboard.
   • accessKey: The Access Key provided by Amazon S3, which is used to identify visitors.
   • secretKey: The Secret Key provided by Amazon S3, which is used to authenticate signatures.
   For how to get these information, see the document of Amazon S3.

Configure the recording feature

The default recording behavior in Flexible Classroom is: Record the audio and video of teachers in a classroom in composite recording mode. Your recorded files are be stored in Agora's Amazon S3 account.

To change the default behavior, find the cloud recording module on the Flexible Classroom configuration page in Agora Console, and pass in JSON objects:

Recording configuration

Pass in the recordingConfig JSON object. For parameter descriptions, see recordingConfig.

An example of the recordingConfig JSON object:

{
    "maxIdleTime": 30,
    "streamTypes": 2,
    "channelType": 0
}

Storage configuration

Pass in the storageConfig JSON object for storing recorded files. For parameter descriptions, see storageConfig.

An example of the storageConfig JSON object:

{
    "vendor": 2,
    "region": 3,
    "bucket": "xxxxx",
    "accessKey": "xxxxxxf",
    "secretKey": "xxxxx",
    "endpoint": "https://agora-recording.oss-cn-shanghai.aliyuncs.com",
    "fileNamePrefix": [
        "scenario",
        "recording"
    ]
}

Considerations

To ensure that Agora can access files save in your third-party storage space, you should enable public access or higher permission for third-party storage spaces. Taking AWS S3 as an example:

• Bucket policy

  {
      "Version": "2012-10-17",
      "Id": "Policy1622700880591",
      "Statement": [
          {
              "Sid": "Stmt1622700872941",
              "Effect": "Allow",
              "Principal": "*",
              "Action": "s3:GetObject",
              "Resource": "arn:aws-cn:s3:::agora-adc-artifacts/*"
          }
      ]
  }

• Cross-origin resource sharing

  [
      {
          "AllowedHeaders": [
              "*"
          ],
          "AllowedMethods": [
              "PUT",
              "GET"
          ],
          "AllowedOrigins": [
              "*"
          ],
          "ExposeHeaders": []
      }
  ]