集成 SDK

更新时间: 2025/08/12 17:01:04

本文为您展示通过网易会议组件(NEMeetingKit)实现音视频会议的相关步骤,帮助您在业务中实现创建会议、预约会议、查询会议信息等在线会议场景下的相关能力。

前提条件

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

  1. 网易云信控制台 创建至少一个应用。若无应用,请参考 创建应用并获取 AppKey
  2. 开通 视频会议 解决方案。具体步骤可参考 方案开通

开发环境

在客户端实现音视频会议功能之前,请您准备以下开发环境:

环境类型 具体要求
CPU 架构 支持 ARM64、ARMV7 架构
iOS 系统 10.0 及以上版本的 iOS 设备自 4.14.0 版本起,需 iOS 13 及以上版本。
IDE XCode 10 及以上版本自 4.14.0 版本起,需 XCode 16 及以上版本。
其他 1.9.1 及以上版本的 CocoaPods

SDK 目录结构

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

从 4.12.0 版本起,NEMeetingKit 支持跨平台开发的 XCFramework 框架格式。SDK 目录下的 .framework 文件后缀名修改为 .xcframework。如果您集成 NEMeetingKit 后从低版本升级至 1.36.0 及以上,请重新添加 XCFramework 依赖。详情请参考《常见问题》升级 NEMeetingKit 版本后,Xcode 编译报错文件找不到

文件/文件夹名称 是否必选 说明
NERtcSDK.xcframework 音视频库。
NMCBasicModuleFramework.framework 基础模块库。
NERtcnn.xcframework 神经网络库(自 V3.11.0 起提供,以实现插件化)。
NIMSDK.framework IM 即时通讯基础模块库。
NIMNOS.framework IM NOS 文件存储库。
NERtcBeauty.xcframework 美颜(自 V3.11.0 起提供,以实现插件化)。
NERtcFaceDetect.xcframework 人脸检测(自 V3.11.0 起提供,以实现插件化)。
NERtcPersonSegment.xcframework 背景分割(自 V3.11.0 起提供,以实现插件化)。
NERtcAiDenoise.xcframework AI 降噪(自 V3.11.0 起提供,以实现插件化)。
NERtcAiHowling.xcframework AI 啸叫检测(自 V3.11.0 起提供,以实现插件化)。

集成 SDK

  1. 新建 iOS 工程。

    1. 运行 XCode,依次选择 Create a New XCode Project > Single View App > Next 新建工程。

      image
    2. 配置工程相关信息,单击 Next

      image
    3. 选择合适的工程本地路径,单击 Create 完成工程创建。

  2. 通过 CocoaPods 集成 SDK。

    1. 进入到工程路径,执行 pod 命令,生成 Podfile 文件,注意 CocoaPods 版本使用 1.9.1 以上的,防止因为版本过低导致无法拉取 SDK。

      CocoaPodspod init
      
    2. 打开 Podfile 文件添加如下代码并保存。

      CocoaPodspod 'NEMeetingKit'
      

      您也可根据需要选择依赖的版本,详情可参考网易会议组件 更新日志

    3. 执行 pod 命令,安装 SDK。

      CocoaPodspod install
      

      自 V3.11.0 版本起,NEMeetingKit 支持以插件化的方式按需加载子模块,以便 缩小包体积。集成方法如下:

      方式 1:

      CocoaPods    pod 'NEMeetingKit', '~> 4.7.0', :subspecs => ['Base', 'Beauty', 'Segment', 'Audio']
      

      方式 2:

      CocoaPods    pod 'NEMeetingKit/Base'
          pod 'NEMeetingKit/Beauty'
          pod 'NEMeetingKit/Segment'
          pod 'NEMeetingKit/Audio'
      

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

      功能/插件 subspecs 的值 framework 动态库
      音视频 + 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
  3. 权限处理。NEMeetingKit 正常工作需要应用获取摄像头、麦克风、相册权限。

    1. 若您的 App 需要在退到后台时仍然运行相关功能,请打开后台音频权限。

      Signing & Capabilities 页面,将设置项 Background Modes 设定为 ON,并勾选 Audio,AirPlay and Picture in PictureVoice over IP

      Xnip2022-12-02_16-33-26.jpg

      打开后台音频权限之后,应用在手机后台运行时,SDK 默认在后台也可以继续处理音频流,维持通话。

    2. 若您的 App 需要正常使用 SDK 提供的音视频功能,请给 App 授权麦克风、摄像头、相册和 Wi-Fi 的使用权限。

      编辑 info.plist 文件,添加以下四项。

      • Privacy - Microphone Usage Description,并填入麦克风使用目的提示语。

      • Privacy - Contact Usage Description,并填入摄像头使用目的提示语。

      • Privacy - Camera Usage Description,并填入摄像头使用目的提示语。

      • Privacy - Photo Library Usage Description,并填入相册使用目的提示语。

        Xnip2022-12-02_16-46-19.jpg

修改能力 SDK 版本

底层依赖

网易会议组件中依赖了网易云信的 即时通讯 NIM SDK(简称 NIM SDK)音视频通话 2.0 SDK(简称 NERTC SDK) 的底层能力。您可以在网易会议组件的 更新日志 中,查看到对应组件版本适配的 NIM SDK 和 NERTC SDK 版本。

如果您的项目中已经单独集成了 NIM SDK 和 NERTC SDK,并与 NEMeetingKit 中的版本冲突时,您可以手工指定 NIM SDK 和 NERTC SDK 的版本号。具体实现方式,请参考《功能版本与 SDK 依赖对照》修改能力 SDK 版本 章节。

音视频相关

如果您的应用中同时需要使用网易会议组件(NEMeetingKit)和 NERTC SDK 或呼叫组件时,由于它们都依赖了 NERTC SDK,可能会产生冲突。请参考《功能版本与 SDK 依赖对照》与 NERTC SDK 和呼叫组件共存 了解如何处理音视频相关组件的冲突问题,避免因多组件依赖 NERTC SDK 而产生的冲突问题,确保应用稳定运行。

下一步

调用网易会议组件接口 实现基础功能,例如调用初始化接口,并传入您在网易云信控制台上创建应用时获取的密钥(AppKey)。

此文档是否对你有帮助?
有帮助
去反馈
  • 前提条件
  • 开发环境
  • SDK 目录结构
  • 集成 SDK
  • 修改能力 SDK 版本
  • 底层依赖
  • 音视频相关
  • 下一步