集成 SDK
更新时间: 2023/06/29 03:39:26
本文为您展示通过 NEMeetingKit 实现音视频会议的相关步骤,帮助您在业务中实现创建会议、预约会议、查询会议信息等在线会议场景下的相关能力。
前提条件
在客户端实现音视频会议功能之前,请确保您已完成以下操作:
-
已创建应用,并开通 NERoom 房间组件能力。
-
在网易云信控制台的应用列表中获取指定应用的 App Key。
开发环境
在客户端实现音视频会议功能之前,请您准备以下开发环境:
环境类型 | 具体要求 |
---|---|
iOS 系统 | 10.0 及以上版本的 iOS 设备 |
CPU 架构 | 支持 ARM64、ARMV7 架构 |
IDE | XCode 10 及以上版本 |
其他 | 1.9.1 及以上版本的 CocoaPods |
SDK 目录结构
SDK 动态库推荐放置在 libs/ 目录。
文件/文件夹名称 | 是否必选 | 说明 |
---|---|---|
NERtcSDK.framework | 是 | 音视频库。 |
NMCBasicModuleFramework.framework | 是 | 基础模块库。 |
NERtcnn.framework | 是 | 神经网络库(自 V3.11.0 起提供,以实现插件化)。 |
NIMSDK.framework | 是 | IM 即时通讯基础模块库。 |
NIMNOS.framework | 是 | IM NOS 文件存储库。 |
NERtcBeauty.framework | 否 | 美颜(自 V3.11.0 起提供,以实现插件化)。 |
NERtcFaceDetect.framework | 否 | 人脸检测(自 V3.11.0 起提供,以实现插件化)。 |
NERtcPersonSegment.framework | 否 | 背景分割(自V3.11.0 起提供,以实现插件化)。 |
NERtcAiDenoise.framework | 否 | AI 降噪(自 V3.11.0 起提供,以实现插件化)。 |
NERtcAiHowling.framework | 否 | AI 啸叫检测(自 V3.11.0 起提供,以实现插件化)。 |
集成 SDK
-
新建 iOS 工程。
- 运行 XCode,依次选择 Create a New XCode Project > Single View App > Next 新建工程。
- 配置工程相关信息,单击 Next。
- 选择合适的工程本地路径,单击 Create 完成工程创建。
-
通过 CocoaPods 集成 SDK。
- 进入到工程路径,执行 pod 命令,生成
Podfile
文件,注意 CocoaPods 版本使用 1.9.1 以上的,防止因为版本过低导致无法拉取 SDK。
pod init
- 打开
Podfile
文件添加如下代码并保存。
pod 'NEMeetingKit'
开发者可根据需要选择依赖的版本,详情可参考会议组件更新日志
- 执行 pod 命令,安装 SDK。
pod install
自 V3.11.0 版本起,NEMeetingKit 支持以插件化的方式按需加载子模块,以便缩小包体积。集成方法如下:
方式1:
pod 'NEMeetingKit', '~> 3.11.0', :subspecs => ['Base', 'Beauty', 'Segment', 'Audio']
方式2:
pod 'NEMeetingKit/Base' pod 'NEMeetingKit/Beauty' pod 'NEMeetingKit/Segment' pod 'NEMeetingKit/Audio'
subspecs
中请填入待引入的动态库对应的值,具体说明如下表所示。功能/插件 subspecs
的值framework
动态库音视频 + IM Base
必选基础库: NERtcSDK.framework
NMCBasicModuleFramework.framework
NERtcnn.framework
NIMSDK.framework
NIMNOS.framework
NMCBasicModuleFramework.framework
美颜 + 人脸识别 Beauty
- 美颜库:
NERtcBeauty.framework
- 人脸检测库:
NERtcFaceDetect.framework
虚拟背景 Segment
背景分割库: NERtcPersonSegment.framework
AI降噪 + AI 啸叫检测 Audio
- AI降噪库:
NERtcAiDenoise.framework
- AI 啸叫检测库:
NERtcAiHowling.framework
- 进入到工程路径,执行 pod 命令,生成
-
权限处理。
NEMeetingKit 正常工作需要应用获取摄像头、麦克风、相册权限,如下图所示。
常见问题
自 V3.11.0版本起,如果项目中单独集成了 NERtcSDK 与 NIMSDK_LITE ,并与 NEMeetingKit 中的版本冲突时,您可以手工指定NERtcSDK、NIMSDK_LITE的版本号。
示例代码如下:
// 方式1
pod 'NEMeetingKit', '~> 3.11.0', :subspecs => ['Base_Special', 'Segment_Special', 'Beauty_Special', 'Audio_Special']
// 方式2
pod 'NEMeetingKit/Base_Special'
pod 'NEMeetingKit/Segment_Special'
pod 'NEMeetingKit/Beauty_Special'
pod 'NEMeetingKit/Audio_Special'
pod 'NERtcSDK', '{指定使用的版本}'
// NIMSDK_LITE版本 必须
pod 'NIMSDK_LITE', '{指定使用的版本}'
此文档是否对你有帮助?