网易云信为您提供开源的示例项目，您可以参考本文档快速跑通示例项目，体验在线 K 歌的效果。

开发环境要求

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

环境要求	说明
iOS 版本	11.0 及以上的 iPhone 或者 iPad 真机
CPU 架构	ARM64、ARMV7
IDE	XCode
其他	安装 CocoaPods。

前提条件

请确认您已完成以下操作：

• 已创建应用并获取AppKey

• 已开通IM 即时通讯、聊天室、音视频通话2.0 、 NERoom 房间组件和版权音乐

• 已配置 NERoom 的消息抄送地址（http://yiyong.netease.im/nemo/entertainmentLive/nim/notify）

  

运行示例项目

• 在线K歌 的示例源码仅供开发者接入参考，实际应用开发场景中，请结合具体业务需求修改使用。

• 若您计划将源码用于生产环境，请确保应用正式上线前已经过全面测试，以免因兼容性等问题造成损失。

1. 克隆示例项目源码仓库至您本地工程。

   示例项目源码请存放至全英文的路径下。

2. 打开终端，在 Podfile 所在文件夹中执行如下命令进行安装：

   pod install
   

3. 完成安装后，通过 Xcode 打开 xxx.xcworkspace 工程。

4. 在 KaraokeKit/NEKaraoke/NEKaraoke/AppDelegate.swift 中，替换您自己的 App Key 和 App Secret 。

   // MARK: 请填写您的AppKey和AppSecret
   let APP_KEY: String = "your appkey" // 请填写应用对应的AppKey，可在云信控制台的“AppKey管理”页面获取
   let APP_SECRET: String = "your secret" // 请填写应用对应的AppSecret，可在云信控制台的“AppKey管理”页面获取
   
   // MARK: BASE_URL的默认地址仅用于跑通体验Demo，请勿用于正式产品上线。在产品上线前，请换为您自己实际的服务端地址
   let BASE_URL: String = "https://yiyong.netease.im" //云信派对服务端中国国内的体验地址
   

   • 获取 AppKey 和 AppSecret 的方法请参见创建应用并获取 AppKey。
   • 配置文件中的 BASE_URL 地址 http://yiyong.netease.im为云信派对服务端体验地址，该地址仅用于体验 Demo，单次最大体验时长为1小时，请勿用于生产环境。
   • K歌场景方案暂时不支持海外。

5. 运行工程。

建议在真机上运行，不支持模拟器调试。

示例项目结构

┌
├── NEKaraokeCreateViewController              # 创建K歌房视图控制器
│   ├── NEKaraokeCreateTextField               # 房间名输入框
│   ├── NEKaraokeCreateCheckBox                # 合唱模式选择器
│   └── UIButton                               # 创建房间按钮
│
├── NEKaraokeViewController                    # K歌房视图控制器
│   ├── NEKaraokeHeaderView                    # 头部视图，包含人数、房间名等信息
│   ├── NEKaraokeControlView                   # 控制视图，包含调音、暂停、切歌、原唱按钮
│   ├── NEKaraokeSeatView                      # 麦位信息视图
│   ├── NEKaraokeInputToolBar                  # 底部工具栏，包含输入框等控件
│   ├── NEKaraokeChatView                      # 聊天室视图，显示系统通知消息、普通文本消息以及礼物消息
│   ├── NEKaraokeKeyboardToolbarView           # 聊天室文本输入框
│   ├── NEKaraokeAnimationView                 # 礼物动画视图
│   ├── NEKaraokeRoomInfo                      # 当前K歌房信息
│   ├── NEAudioEffectViewController            # 音效调节界面
│   ├── NEAudioEffectManager                   # 音效管理类
│   ├── NSMutableArray<NEKaraokeSeatItem *>    # 麦位信息
│   ├── NEKaraokeOrderSongModel                # 当前演唱歌曲信息
│   └── NEKaraokeLyricActionView               # 核心控制视图
│       ├── NEKaraokeChooseView                # 核心控制视图 - 点歌视图
│       ├── NEKaraokeChorusWaitView            # 核心控制视图 - 合唱准备视图
│       ├── NEKaraokeLyricView                 # 核心控制视图 - 歌词、打分展示视图
│       ├── NEKaraokeMatchView                 # 核心控制视图 - 合唱匹配视图
│       ├── NEKaraokeNoLyricView               # 核心控制视图 - 无歌词提示视图
│       └── NEKaraokeWaitView                  # 核心控制视图 - 独唱准备视图
|
├── NEKaraokeListViewController                # K歌房列表视图控制器
│   ├── NEKaraokeListEmptyView                 # 空列表提示视图
│   └── NEKaraokeListViewCell                  # K歌房信息预览
│
└── NEKaraokePickSongView                      # 点歌台弹出框