通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

快速跑通示例项目

更新时间 2023/01/12 08:27:56

概览

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

前提条件

  • Unity 2017 或更高版本。
  • Android、iOS、Windows、macOS 设备或模拟器。
  • 有效的声网开发者账号。
  • 如果你的网络环境部署了防火墙，请根据应用企业防火墙限制打开相关端口。

操作步骤

1. 创建声网项目

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

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

2. 获取 App ID

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

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

3. 获取 App 证书

参考以下步骤获取 App 证书：

  1. 在声网控制台的项目管理页面，找到你的项目，点击配置。
    编辑项目

  2. 点击主要证书下面的复制图标，即可获取项目的 App 证书。
    获取app证书

4. 生成 Token

为提高项目的安全性，声网推荐使用 Token 对即将登录 RTM 系统的用户进行鉴权。

为了方便测试，声网服务器提供部署签发 RTM Token 的功能。参考以下步骤获取 RTM Token：

  1. 访问 Token-Builder。
  2. 输入 App ID、App 证书和用于登录 RTM 系统的用户 ID，其中用户 ID 需要你自行设置，例如 test。输入后，生成的 RTM Token 会直接显示在界面上，选中复制即可。后续调用 login 时，请确保填入的用户 ID 与生成 RTM Token 时填入的用户 ID 一致。
通过以上步骤获取的 RTM Token 仅作为演示和测试用途，有效期为 24 小时。在生产环境中，为保障通信安全，你需要自行部署服务器签发 Token，详见生成 RTM Token。

5. 配置示例项目

方法一：通过资源包配置

  1. 打开 Unity，点击 New，创建一个新的 Unity 项目。
  2. 前往 GitHub 下载最新版本的声网 RTM Unity 资源包。
  3. 在 Unity Editor 中，选择 Assets > Import Package > Custom Package。
  4. 选择声网 RTM Unity 资源包，点击打开。
  5. 取消勾选不需要的插件（默认勾选资源包包含的所有插件）。然后点击 Import。
  6. 在 Unity 的 Hierarchy 列表中，点击 MainScene > ChatManager。
  7. 在 Inspector 列表找到 Agora Properties，在 App Id 和 Token 文本框内填写你获取到的 App ID 和临时 Token。

方法二：通过 SDK 配置

  1. 前往 SDK 下载页面，在云信令 (原 RTM) SDK 中下载最新版本的声网 RTM SDK，然后解压。
  2. 在 Unity 中打开 SDK 包内的示例项目，即 ./samples/Unity-RTM-Demo 文件夹。
  3. 将 SDK 包内 libs 下的 Rtm-Scripts 文件夹拷贝到示例项目路径的 Assets 文件夹下。
  4. 将 SDK 包内 libs/Plugins 路径下的如下文件，拷贝到示例项目的对应路径下：
    开发平台 文件或文件夹 项目路径
    Android Plugins/Android /Assets/Plugins/Android/
    iOS Plugins/iOS /Assets/Plugins/iOS
    macOS Plugins/macOS /Assets/Plugins/macOS
    Windows Plugins/x86 /Assets/Plugins/x86
    Windows Plugins/x86_64 /Assets/Plugins/x86_64
  5. 在 Unity 的 Hierarchy 列表中，点击 MainScene > ChatManager。
  6. 在 Inspector 列表找到 Agora Properties，在 App Id 和 Token 文本框内填写你获取到的 App ID 和临时 RTM Token。

6. 运行示例项目

按照以下步骤运行示例项目。

  1. 点击 File 菜单栏，通过 Build Settings 设置你需要运行的设备。
  2. 点击 Unity 主界面上方的 Play 按钮直接运行示例项目，或点击菜单栏 File > Build And Run 编译运行示例项目。你会在设备上看到如下画面。

    现在你就可以开始体验云信令了。你可以通过声网的 RTM Web 端示例应用，输入相同的 App ID、频道名和临时 Token，加入同一频道与你的设备端互通。