跑通示例项目

声网在 GitHub 上提供一个开源的互动直播示例项目 API-Examples。本文介绍如何快速跑通该示例项目，体验声网音频或视频互动直播效果。

前提条件

• 开发环境要求：
  • Java Development Kit
  • Android Studio 3.0 及以上
• 如果你的网络环境部署了防火墙，请根据应用企业防火墙限制打开相关端口。
• 一台真实的 Android 设备。部分模拟机可能存在功能缺失或者性能问题，所以推荐使用真机。
• 有效的声网开发者账号。

操作步骤

1. 创建声网项目

参考以下步骤创建一个声网项目：

1. 进入声网控制台的项目管理页面。
2. 在项目管理页面，点击创建按钮。
3. 在弹出的对话框内输入项目名称、使用场景，依次选择场景标签和鉴权机制。其中鉴权机制推荐选择安全模式，调试模式的安全性较低。
4. 点击提交按钮。新建的项目会显示在项目管理页中。

2. 获取 App ID

声网会给每个项目自动分配一个 App ID 作为项目唯一标识。

在声网控制台的项目管理页面，找到你的项目，点击 App ID 右侧的 图标，即可获取项目的 App ID。

3. 生成临时 Token

为提高项目的安全性，声网推荐使用 Token 对即将加入频道的用户进行鉴权。

为了方便测试，声网控制台提供生成 RTC 临时 Token 的功能。参考以下步骤获取 RTC 临时 Token：

1. 在控制台的项目管理页面，找到你的项目，点击配置。
   
2. 在主要证书下面，点击生成临时音视频 token。
   
3. 输入一个频道名，例如 testroom，然后点击生成。后续调用 API 加入频道时，请确保填入的频道名与这里的频道名一致。
   
4. 点击复制图标，即可复制生成的临时 token。

4. 配置示例项目

参考以下步骤配置示例项目：

1. 克隆 API-Examples 仓库至本地，找到 API-Examples-master/Android/APIExample 示例项目文件夹。

   建议你将 APIExample 示例项目文件夹移到工作磁盘的根目录下。否则，编译项目时可能会因项目路径过长而失败。

2. 在 APIExample/app/src/main/res/values/string_config.xml 文件中填写你从声网控制台获取到的 App ID 和临时 Token。

   // 把 YOUR APP ID 替换成你的 App ID
   <string name="agora_app_id" translatable="false">YOUR APP ID</string>
   // 把 YOUR ACCESS TOKEN 替换成你的临时 Token
   <string name="agora_access_token" translatable="false">YOUR ACCESS TOKEN</string>

5. 编译并运行示例项目

1. 开启 Android 设备的开发者选项，打开 USB 调试，通过 USB 连接线将 Android 设备接入电脑。

2. 用 Android Studio 打开 APIExample 示例项目。Android Studio 会自动开始项目与 Gradle 文件的同步。

3. 待同步成功后，点击 Run 'app'。片刻后，声网 API Example 应用便会安装到你的 Android 设备上。

4. 打开应用，点击音频互动直播或视频互动直播，阅读提示，点击下一步。

5. 填入你之前生成 Token 时使用的频道名，例如 test，点击加入，便可以加入频道。

6. 你可以邀请一位朋友加入你所在的直播频道：克隆 API-Examples-Web 项目到本地，在浏览器中打开 Demo/index.html 文件，并输入相同的 App ID、频道名、临时 Token。你们可以听到彼此的声音，或看到彼此。