跑通示例项目
更新时间: 2024/12/12 16:37:55
网易云信为您提供开源的示例项目,您可以参考本文快速跑通示例项目,体验语聊房效果。
开发环境
在开始运行示例项目之前,请确保开发环境满足以下要求:
环境要求 | 说明 |
---|---|
JDK 版本 | 1.8.0 及以上版本 |
Android API 版本 | API 21 及以上版本 |
Android Studio 版本 | Android Studio 5.0 及以上版本 |
CPU 架构 | ARM 64、ARM V7 |
IDE | Android Studio |
其他 | 依赖 Androidx,不支持 support 库。 Android 系统 4.3 及以上版本的真机。 |
前提条件
在开始运行示例项目之前,请确保您已完成以下操作:
-
配置 NERoom 的消息抄送地址,设置为
http://yiyong.netease.im/nemo/entertainmentLive/nim/notify
。
运行源码
语聊房的示例源码仅供开发者接入参考,实际应用开发场景中,请结合具体业务需求修改使用。
若您计划将源码用于生产环境,请确保应用正式上线前已经过全面测试,以免因兼容性等问题造成损失。
-
克隆示例项目源码仓库至您本地工程。
-
开启 Android 设备的开发者选项,通过 USB 连接线将 Android 设备接入电脑。
-
通过 Android Studio 打开项目,配置应用的 AppKey。
在
AppConfig.java
文件中配置应用的 AppKey 和 AppSecret。Java
private static final String APP_KEY = "your AppKey"; // 请填写应用对应的 AppKey,可在 [网易云信控制台](https://app.yunxin.163.com/global/home) 的**AppKey 管理**页面获取 public static final String APP_SECRET = "your AppSecret"; // 请填写应用对应的 AppSecret,可在 [网易云信控制台](https://app.yunxin.163.com/global/home) 的**AppKey 管理**页面获取 public static final boolean IS_OVERSEA = false; // 如果您的 AppKey 为海外,填 true。如果您的 AppKey 为中国国内,填 false /** * 默认的 BASE_URL 地址仅用于跑通体验 Demo,请勿用于正式产品上线。在产品上线前,请换为您自己实际的服务端地址 */ public static final String BASE_URL = "https://yiyong.netease.im/"; //网易云信派对服务端国内的体验地址 public static final String BASE_URL_OVERSEA = "https://yiyong-sg.netease.im/"; //网易云信派对服务端海外的体验地址
- 获取 App Key 和 App Secret 的方法请参考 获取 App Key。
- BASE_URL 地址
https://yiyong.netease.im
和 BASE_URL_OVERSEA 地址https://yiyong-sg.netease.im
为网易云信派对服务端体验地址,该地址仅用于体验 Demo,单次最大体验时长为 1 小时,请勿用于生产环境。 - 如果您的应用的 AppKey 为海外,设置
IS_OVERSEA
的值为true
,并 提交工单 联系网易云信技术支持工程师或商务经理配置抄送地址。
-
在 Android Studio 中,单击 Sync Project with Gradle Files 按钮,同步工程依赖。
-
运行工程。
-
开启 Android 设备的 开发者模式 和 USB 调试 功能。将 Android 设备连接到开发电脑,在弹出的授予调试权限对话框中,授予调试权限,具体步骤请参考 在硬件设备上运行应用。
Android Studio 菜单栏中的 Running Devices 下拉列表选项,由 No Devices 变为对应的设备名称。
此时表示设备已成功连接到 Android Studio。
-
单击 Run 按钮
,编译并运行示例源码。
建议在真机上运行,不支持模拟器调试。
-
项目结构
-
语聊房示例项目结构
Android ├─ app // App 壳工程,首页、房间列表等 UI ├─ entertainment // 公共 UI 和工具 ├─ ordersong // 点歌相关业务 ├─ voiceroomkit-ui // 语聊房 UI └─ voiceroomkit // 语聊房核心业务逻辑
-
一起听示例项目结构
Android ├─ app // App 壳工程,首页、房间列表等 UI ├─ entertainment // 公共 UI 和工具 ├─ ordersong // 点歌相关业务 ├─ listentogether-ui // 一起听 UI └─ voiceroomkit // 语聊房核心业务逻辑
-
游戏房示例项目结构
Android ├─ app // App 壳工程,首页、房间列表等 UI ├─ entertainment // 公共 UI 和工具 ├─ game-ui // 游戏房 UI ├─ gamekit // 游戏房核心业务逻辑 └─ voiceroomkit // 语聊房核心业务逻辑