Skip to main content

Configure Flexible Classroom

This page introduces how to enable and configure Flexible Classroom in Agora Console.

Prerequisites

In order to follow this procedure you must have:

  • An Agora account and project.

  • The whiteboard feature in Flexible Classroom requires third-party cloud storage. Currently, Flexible Classroom supports Amazon S3.

Enable Flexible Classroom

Follow these steps to enable the Flexible Classroom service in Agora Console:

  1. Log into Agora Console and navigate to the Project Management page.

  2. On the Project Management page, find the project for which you want to enable the Flexible Classroom service, and click Edit.

  3. Under Extensions, find Flexible Classroom and click Enable.

  4. Read the pop-up prompt carefully, and click Enable.

  5. After you successfully enable the Flexible Classroom service, the status changes to Enabled:

Configure classroom storage and recording

To setup and configure storage and recording in for your classrooms:

  1. Setup third-party cloud storage

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

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

    3. 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.
  2. Configure your classroom

    1. Find the cloud recording module on the Flexible Classroom configuration page in Agora Console:

    2. Configure storage

      Pass in the storageConfig JSON object for storing recorded files. For example:


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

      For parameter descriptions, see storageConfig.

    3. Configure recording.

      By default, you record teacher audio and video in composite recording mode. Your recorded files are stored in Agora's Amazon S3 account. To change the default behavior, Pass in the recordingConfig JSON object:


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

      For parameter descriptions, see recordingConfig.

Considerations

To ensure that Agora can access files in your third-party cloud storage space, you should enable public access or higher permissions for third-party storage spaces.

AWS S3 account configuration

Configure your AWS S3 account as follows:

  • Bucket policy


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

  • Cross-origin resource sharing


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

Next steps

After enabling the Flexible Classroom service, see how to quickly launch a classroom.

Page Content