Launch a Classroom

This page introduces how to quickly launch a flexible classroom.

Understand the tech

The following figure shows the workflow to join a flexible classroom.

When an app client requests to join a flexible classroom, the app client and your app server interact with the Agora server in the following steps:

1. Your app client sends a request to your app server to apply for an RTM token.
2. Your app server generates an RTM token using the Agora App ID, App Certificate, and a user ID. For details, see Generate an RTM Token.
3. Your app client calls an API to join a flexible classroom with the following parameters:
   • The user ID: The unique identifier of a user. A string generated by your security system. Must be the same as the user ID that you use for generating an RTM token.
   • The room ID: A string for identifying a classroom. When your app user joins a flexible classroom, Agora automatically creates a classroom with the room ID.
   • The RTM token: A credential for verifying the identity of the user when your app user joins a flexible classroom.

Prerequisites

• An Agora project with anAgora App ID, App Certificate, and enable the Flexible Classroom service.
• Java Development Kit .
• Android Studio 4.0 or later.
• Android 5.0 or later.
• An Android device. You may encounter unexpected issues on simulators, so Agora recommends using a physical device.

Launch a flexible classroom

Follow these steps to launch a flexible classroom:

1. Run the following command to clone the CloudClass-Android project and check out the latest release branch.

   git clone https://github.com/AgoraIO-Community/CloudClass-Android.git

   git checkout release/apaas/x.y.z

   Replace x.y.z with the version number. To get the latest version number, see the release notes.

2. Open the CloudClass-Android project in Android Studio.

3. Replace the Agora App ID and Agora App Certificate in the app/src/normal/res/values/string_config.xml file with your App ID and App Certificate. Leave Agora API Host and Report API Host as is.

   <?xml version="1.0" encoding="utf-8"?>
   <resources>
           <string name="agora_app_id" translatable="false">Agora App ID</string>
           <string name="agora_app_cert" translatable="false">Agora App Certificate</string>
           <string name="agora_api_host" translatable="false">Agora API Host</string>
           <string name="agora_report_host" translatable="false">Report API Host</string>
   </resources>

   To facilitate your testing, the CloudClass-Android project contains an RTM Token generator, which can generate a temporary RTM Token with the App ID and App Certificate you pass in. When your project goes live, to ensure security, you must deploy the RTM Token generator on your server.

4. Open the CloudClass-Android project in Android Studio, and run it on a physical mobile device. You can see the following page:

   

5. To join a classroom, pass in a room name and user name, select a room type, and click Enter. You can see the following page:

   

Next steps

Satisfied with the features of Flexible Classroom and want to explore more? Next, you can integrate Flexible Classroom into your own project.