本文介绍 iOS 端快速集成并初始化网易云信房间组件（NERoom SDK）的操作步骤，帮助您快速集成并初始化 NERoom SDK。

开发环境

在开始运行工程之前，请您准备以下开发环境：

• Xcode 10 及以上版本。
• iOS 12.0 及以上版本的 iOS 设备。

前提条件

根据本文操作前，请确保您已经在 网易云信控制台 上完成了以下设置：

• 创建至少一个应用。详细步骤请参考 创建应用并获取 AppKey。
• 为应用开通一个房间组建模板。详细步骤请参考 开通或试用服务。

目录结构

NERoom SDK 动态库推荐放置在 libs/ 目录。

第一步：集成 NERoom SDK

通过 CocoaPods 集成 NERoom SDK。

1. 安装 CocoaPods。

   在终端窗口中输入如下命令：

   sudo gem install cocoapods
   

2. 创建 Podfile 文件。

   从 Terminal 中进入您所创建项目所在路径，运行以下命令创建 Podfile 文件。

   CocoaPodspod init
   

3. 编辑 Podfile 文件。

   CocoaPods# platform :ios, '10.0'
   target '{YourApp}' do
       pod 'NERoomKit', '~> {version}'
   end
   

   • YourApp：您的 Target 名称。
   • version：待集成的 NERoom SDK 版本号。

   NERoom 1.14.0 版本起，支持以插件化的方式按需加载子模块，以便 缩小包体积。

   包含：基础模块、美颜、音频等。

   方式 1：

   CocoaPodspod 'NERoomKit', '{version}', :subspecs => ['Base', 'Beauty', 'Segment', 'Audio']
   

   方式 2:

   CocoaPodspod 'NERoomKit/Base', '{version}'
   pod 'NERoomKit/Beauty', '{version}'
   pod 'NERoomKit/Segment', '{version}'
   pod 'NERoomKit/Audio', '{version}'
   

   subspecs 中请填入待引入的动态库对应的值，具体说明如下表所示。

   功能/插件	subspecs 的值	xcframework 动态库
   音视频 + IM	Base	必选基础库： NERtcSDK.xcframework NERtcnn.xcframework NIMSDK.framework NIMNOS.framework
   美颜 + 人脸识别	Beauty	美颜库：NERtcBeauty.xcframework 人脸检测库：NERtcFaceDetect.xcframework
   虚拟背景	Segment	背景分割库：NERtcPersonSegment.xcframework
   AI 降噪 + AI 啸叫检测	Audio	AI 降噪库：NERtcAiDenoise.xcframework AI 啸叫检测库：NERtcAiHowling.xcframework

4. 执行以下命令查询本地库版本。

   CocoaPodspod search NERoomKit
   

5. 若不是最新版本，可以执行以下命令更新本地库版本。

   CocoaPodspod repo update
   

6. 执行以下命令安装安装 NERoom SDK。

   CocoaPodspod install
   

   命令执行完毕后，会生成 *.xcworkspace 文件，表示 SDK 集成完成。

第二步：添加媒体设备权限

1. 在 Signing & Capabilities 页面，打开后台音频权限。

   为保障应用进入手机后台之后，SDK 在后台能继续处理音频流，使通话不中断，请打开后台音频权限。

2. 编辑 info.plist 文件，授权麦克风、摄像头。

   使用 SDK 的音视频功能，需要授权麦克风和摄像头的使用权限。请在 App 的 Info.plist 中设置以下两项。

   • Privacy - Microphone Usage Description，并填入麦克风使用目的提示语。
   • Privacy - Camera Usage Description，并填入摄像头使用目的提示语。

第三步：导入 NERoom SDK

在项目需要使用 NERoom API 的文件里引入 NERoom 的头文件。

• Objective-C 代码中，引入 Swift 头文件的示例代码如下：

  #import <NERoomKit/NERoomKit-Swift.h>
  

• Swift 代码中，引入 Swift 头文件的示例代码如下：

  import NERoomKit
  

第四步：初始化 NERoom SDK

公有云部署

若您使用 公有云 环境，则参考以下示例代码进行初始化。

Swiftlet options = NERoomKitOptions(appKey: "appKey")
NERoomKit.shared().initialize(options: options) { code, str, _ in
    if code == 0 {
        // 初始化成功
    } else {
        // 初始化失败
    }
}

Swiftlet options = NERoomKitOptions(appKey: "appKey")
options.extras = ["serverUrl": "https://roomkit-sg.yunxinapi.com"]
let serverConfig = NEServerConfig()
serverConfig.imServerConfig = NEIMServerConfig()
serverConfig.roomKitServerConfig = NERoomKitServerConfig()
serverConfig.roomKitServerConfig?.roomServer = "https://roomkit-sg.netease.im"
serverConfig.imServerConfig?.lbs = "https://lbs.netease.im/lbs/conf.jsp"
serverConfig.imServerConfig?.link = "link-sg.netease.im:7000"
options.serverConfig = serverConfig
NERoomKit.shared().initialize(options: options) { code, str, _ in
    if code == 0 {
        // 初始化成功
    } else {
        // 初始化失败
    }
}

私有化部署

若您使用 私有化 环境，则参考以下步骤进行初始化。

Swiftlet options = NERoomKitOptions(appKey: "appKey")
options.serverUrl = "私有化 NERoom URL"
NERoomKit.shared().initialize(options: options) { code, msg, _ in
    if code == 0 {
    // 初始化成功
    } else {
    // 初始化失败
    }
}

常见问题

自 1.14.0 版本起，如果项目内单独引用了 NERtcSDK、NIMSDK_LITE 库，与 NERoomKit 依赖的库引发冲突，您可以手工指定 NERtcSDK、NIMSDK_LITE 的版本号。

示例代码如下：

CocoaPods// 使用方式 1
pod 'NERoomKit', '~> 1.14.0', :subspecs => ['Base_Special', 'Beauty_Special', 'Segment_Special', 'Audio_Special']
// 使用方式 2
pod 'NERoomKit/Base_Special', '~> 1.14.0'
pod 'NERoomKit/Beauty_Special', '~> 1.14.0'
pod 'NERoomKit/Segment_Special', '~> 1.14.0'
pod 'NERoomKit/Audio_Special', '~> 1.14.0'

pod 'NERtcSDK', '{指定的版本号}', :subspecs => ['RtcBasic', ...]

pod 'NIMSDK_LITE', '{指定的版本号}'