跑通示例项目

概览

声网在 GitHub 上提供一个开源的示例项目 API-Example-Unity。本文介绍如何快速跑通该示例项目，体验声网视频通话效果。你也可以直接观看下面的视频教程。

前提条件

• Unity 2017 或以上版本（本文 Unity 的界面描述以 Unity 2018.4.28f1 为例）

• Unity Hub 1.0.0 或以上版本（本文 Unity Hub 的界面描述以 Unity Hub 2.4.3 为例）

• 操作系统与集成开发环境要求：

  开发平台	操作系统版本	集成开发环境版本
  Android	Android 4.1 或以上	Android Studio 3.0 或以上
  iOS	iOS 9.0 或以上	Xcode 9.0 或以上
  macOS	macOS 10.10 或以上	Xcode 9.0 或以上
  Windows	Windows 7 或以上	Microsoft Visual Studio 2017 或以上

• 有效的声网账户

操作步骤

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. 集成声网 SDK

按照以下步骤将声网 Unity SDK 集成到示例项目中。

1. 克隆 Agora-Unity-Quickstart 仓库至本地。
2. 打开 Unity Hub，进入安装面板。点击安装，选择你所需要的 Unity 版本和模块，并点击完成。
3. 安装完成后，进入项目面板，点击添加，添加 Agora-Unity-Quickstart/API-Example-Unity 示例项目。
4. 在项目列表中选择 Unity 版本，点击 API-Example-Unity，仔细阅读弹出对话框的内容，并点击确认。系统会通过 Unity 打开该示例项目。
5. 在 Unity 中，进入 Asset Store 面板，找到视频 SDK for Unity 并点击 Download 下载。
6. 下载成功后，点击 Import 按钮打开 Import Unity Package 窗口。
7. 点击 Import Unity Package 窗口上的 Import 按钮导入 SDK。导入完成后，你可以在 Project 面板中看到 AgoraEngine 文件夹。

5. 配置示例项目

1. 在 Unity 的 Project 面板上，打开 Assets/API-Example/video-sample 文件夹。
2. 双击 MainScene，并点击 Hierarchy 面板上的 VideoCanvas。
3. 在 Inspector 面板上，找到 Hello Video Agora 脚本。输入你从声网控制台获取到的 App ID、临时 Token 和生成临时 Token 时使用的频道名。

6. 编译并运行示例项目

连接你的设备，然后运行示例项目。

以 macOS 设备为例，运行成功后，你会看到如下画面。

如果想体验一对一通话效果，你可以邀请一位朋友克隆 API-Examples-Web 项目到本地，在浏览器中打开 Demo/index.html 文件，并输入相同的 App ID、频道名和临时 Token，加入同一频道与 macOS 端互通。

示例项目结构

你可以参考示例项目中的主要功能代码，根据自己的需求进行调整。