集成组件

更新时间: 2025/07/16 10:41:22

本文介绍实现网易云信在线直播(直播房)所需的开发环境、前提条件、组件集成方式。

开发环境

实现直播房方案的开发环境要求如下:

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

前提条件

根据本文操作前,请确保您已经完成了以下设置:

第一步:集成 NELiveKit 组件

  1. 若您需要创建新项目,在 XCode 里,依次选择 Create a New XCode Project > Single View App > Next 新建工程,再配置工程相关信息和合适的工程本地路径,单击 Create。

    image image
  2. 下载或克隆 Github 源码,然后拷贝 iOS 目录下的 NELiveStreamKit、Party、third_party、UIKit、PodConfigs 等子目录到您当前工程中的 Podfile 文件的上一级目录中,如下图:

    image
  3. 编辑 Podfile 文件。

    Rubyplatform :ios, '13.0'
    
    # 引入配置文件
    require_relative '../PodConfigs/config_third.rb'
    require_relative '../PodConfigs/config_local_common.rb'
    require_relative '../PodConfigs/config_local_core.rb'
    require_relative '../PodConfigs/config_local_im.rb'
    require_relative '../PodConfigs/config_local_room.rb'
    require_relative '../PodConfigs/config_local_social.rb'
    
    target '{YourApp}' do
        use_frameworks!
    
        # 工程的 podspec 引用采用源码的环境变量
        ENV['USE_SOURCE_FILES'] = 'true'
    
        # 本地源码依赖
        pod 'NELiveStreamKit', :path => '../NELiveStreamKit/NELiveStreamKit/NELiveStreamKit.podspec'
        pod 'NELiveStreamUIKit', :path => '../NELiveStreamKit/NELiveStreamUIKit/NELiveStreamUIKit.podspec'
        pod 'NEOrderSong', :path => '../NELiveStreamKit/NEOrderSong/NEOrderSong.podspec'
        pod 'NEUIKit', :path => '../UIKit/NEUIKit/NEUIKit.podspec'
        pod 'LottieSwift', :path => '../third_party/lottie/LottieSwift.podspec'
        pod 'NESocialUIKit', :path => '../Party/NESocialUIKit/NESocialUIKit.podspec'
        pod 'FaceUnity', :path => '../third_party/FaceUnity/FaceUnity.podspec'
    
        # 远端依赖
        pod NERoomKit.Special_All , NERoomKit.version
        pod NECommonKit.name , NECommonKit.version
        pod NECommonUIKit.name , NECommonUIKit.version
        pod IHProgressHUD.name
    
    end
    
  4. 执行以下命令安装 SDK。

    Bashpod install
    

第二步:配置权限

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

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

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

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

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

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

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

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

    • Application uses Wi-Fi,设置为 YES。

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

第三步:初始化组件

在调用 SDK 其他接口之前,您首先需要完成初始化操作。

  1. 配置初始化相关参数。

  2. 调用 initialize 方法完成初始化操作。

    示例代码如下:

    Swift let config = NELiveStreamKitConfig(appKey: appKey)
     config.appKey = appKey // 您的网易云信 appkey
     var liveStreamExtras = extras
     liveStreamExtras["baseUrl"] = "your server url" // 业务服务器地址
     config.extras = liveStreamExtras
    
      NELiveStreamKit.getInstance().initialize(config: config) { code, msg, _ in
      if code == 0 {
        print("NELiveStreamKit init success")
      } else {
        print("NELiveStreamKit init failed. code: \(code)")
      }
      }
    

第四步:登录鉴权

请求 SDK 进行登录鉴权,您只有完成 SDK 登录鉴权才可以创建直播房。

示例代码如下:

Swift    NELiveStreamKit.getInstance().login("your_netease_neroom_account", token: "your_netease_neroom_token") { code, msg, _ in
        if code == 0 {
            print("login success")
        } else {
            print("login failed: \(msg)")
        }
        }

示例代码中的 your_netease_neroom_account 和 your_netease_neroom_token 是您的应用服务器向 NERoom 服务器申请创建账号时,返回的 userUuid 和 userToken 的值,具体请参考 创建账号。

此文档是否对你有帮助?
有帮助
去反馈
  • 开发环境
  • 前提条件
  • 第一步:集成 NELiveKit 组件
  • 第二步:配置权限
  • 第三步:初始化组件
  • 第四步:登录鉴权