跑通示例项目

本文介绍如何获取灵动课堂 Android 端 GitHub 源码并运行项目，快速启动并体验灵动课堂。

技术原理

下图展示了启动灵动课堂的基本流程。

当你的 App 客户端请求加入灵动课堂时：

1. 你的 App 客户端向 App 服务端申请 Token。
2. 你的 App 服务端使用声网 App ID、App 证书和用户 UUID 生成一个 Token，返回给 App 客户端。
3. 你的 App 客户端调用 API 并传入用户 ID、房间 ID 和 Token 启动灵动课堂。灵动课堂云服务会根据你传入的房间 ID 为该课堂自动创建一个房间。

注意

示例项目中使用了临时 Token，仅适用于运行 App 模块快速测试。在正式环境中，为确保安全，你必须参考使用 Token 鉴权文档，在服务端部署并生成 Token。生成的 token 传入的 userId 需要和 launch 方法中传入的参数 userUuid 保持一致，否则生成的 token 无效。

前提条件

开始前，请确保满足如下要求：

• 在声网控制台获取 App ID 和 App 证书。
• 在声网控制台开通灵动课堂服务。
• 一台 Android 设备。模拟机可能出现功能缺失或者性能问题，所以声网推荐使用真机。此外，灵动课堂 Android 端要求运行在 Android 5.0 或以上版本。

开发环境

在你的设备上运行灵动课堂依赖于 Git（用于下载源码）、Android Studio、Java Development Kit。

你可参考以下步骤准备开发环境：

1. 点击链接前往下载 Git。
2. 点击链接前往下载 Android Studio。要求 Android Studio 4.1 以上版本，建议使用最新版本。
3. 点击链接前往下载 Java Development Kit。

获取源码

灵动课堂 Android 端的源码位于 GitHub CloudClass-Android 仓库，你可参考以下步骤获取源码：

1. 运行以下命令克隆仓库到本地：

   Shell

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

2. 运行以下命令进入 CloudClass-Android 目录并切换分支至指定版本。将 {VERSION} 替换为要切换的版本号：

   Shell

   cd CloudClass-Android

   Shell

   git checkout release/{VERSION}

   例如要切换到 2.8.20 版本分支，执行以下命令：

   Shell

   git checkout release/2.8.20

   声网建议你切换到最新发版分支。参考下图在 GitHub 仓库中查看最新发版分支：

   

启动灵动课堂

参照以下步骤启动灵动课堂：

1. 在 Android Studio 中导入 CloudClass-Android 项目。

   
   信息

   如果获取依赖包失败，可以通过 Android Studio gradle sync 拉取。

2. 将一部 Android 设备连接至电脑，点击 Run，运行项目。

   运行成功后，你可以在 Android 设备上看到以下画面：

   

3. 输入房间名、用户名，选择一种班型，然后点击加入，即可进入灵动课堂，看到以下画面：

   

后续步骤

现在你已经初步体验了灵动课堂的功能，接下来可将灵动课堂集成到你自己的项目中。

如果你想要升级灵动课堂代码的版本，参考升级指南。