网易云信基于 IM SDK 和 NERTC SDK 为您提供 PK 直播场景的开源示例项目，您可以参考本文档快速跑通示例项目、在本地运行示例 Demo，体验 PK 直播场景的最佳效果。

视频讲解

本视频介绍如何快速跑通示例项目以及体验 PK 直播的基本功能。

前提条件

在开始运行示例项目之前，请确保您已完成以下操作：

• 创建应用并获取App Key。
• 开通音视频通话 2.0 和 IM 服务。
• 集成 SDK（Android）。
• 联系技术支持进行初始化配置。

开发环境

在开始运行示例项目之前，请确保开发环境满足以下要求：

• Android SDK API 等级 18 或以上。

• Android Studio 4.0 或以上版本。

  如果低于此版本，需要调整 build.gradle 和 gradle\wrapper\gradle-wrapper.properties 中匹配的版本。

• Android 系统 4.3 或以上版本的移动设备。

注意事项

示例项目需要在调试模式下使用，此时无需传入 Token。您可以在集成开发阶段使用调试模式进行应用开发与测试。但是出于安全考虑，应用正式上线前，请在控制台中将指定应用的鉴权方式改回安全模式。

示例项目结构

文件/文件夹	名称
app	应用主入口包含外部页面框架。
lib-live	PK 直播模块对外暴露接口。
biz-live	PK 直播具体实现。
lib-user	用户模块对外暴露接口，包含用户信息以及登录。
biz-user	用户模块具体实现。
lib-beauty-faceunity	基于相芯实现的美颜功能模块。
lib-utils	通用工具方法集合。
lib-modularity	应用组件化框架，负责模块调度，无实际业务。
lib-basic	应用基础类以及常量，此工程下 build.gradle 中配置 nertc key 以及 baseUrl。

运行示例源码

在 Demo 体验页面 下载需要体验的示例项目或 Demo 源码工程。

1. 使用 Android Studio 打开项目.

2. 找到 \OnlinePK-master\OnlinePK-Android\lib-basic\build.gradle，将 defaultConfig 中的 set your app key. 改为您自己的appkey。

   要带上反斜杠。

   defaultConfig{
       buildConfigField "String", "APP_KEY", "\"4727023efa99*****3b32e819bd5b\""
       buildConfigField "String", "BASE_URL", "\"https://yiyong.netease.im/\""
   

3. 编译和运行项目工程。

   推荐使用真机调试。