迁移指南

更新时间: 2024/08/07 16:14:03

NEMeetingKit 是基于 NERoom 开发的一个全新的会议组件 SDK,可以帮助您将实时音视频会议功能集成至您的应用中。

本文介绍如何将旧版网易会议 SDK 升级至 v3.2.0 及以上版本的会议组件 SDK 的迁移步骤及主要变更。

迁移步骤

步骤一 集成 SDK

参考集成 SDK,将 v3.2.0 及以上版本的会议组件 SDK 集成至您的项目中。

步骤二 修改全局挂载引用变量名

引用变量名修改:由原来的 NEMeeting 改为 NEMeetingKit。

步骤三 更新 App 代码

V3.2.0 会议组件 Kit 进行了架构重构和升级,从而导致与旧版本的 SDK 不兼容,为了继续使用 App 中已有的网易云信提供的功能,请根据变更介绍更新 App 中的代码。

变更介绍

v3.2.0 及以上版本的会议组件 Kit 相比 v1.0.x(旧版网易会议 SDK 的最新版本)的主要变更如下:

  • 私有化部署

删除 isPrivatization字段,直接根据私有化字段 neRtcServerAddressesimPrivateConf 判断是否开启私有化配置。

  • 初始化参数:

删除 tags 字段,在 joinRoom 方法中以 chatroomTag 字段传入。

  • 登录:

删除密码登录接口 loginWithAccount

  • 加入房间:

    • 增加 role 字段,默认为 member ,小程序暂时仅支持 member 角色入会。
    • roomId 字段更改为 meetingId 字段。
    • 增加 initialProperties 参数,暂时仅支持以对象的形式传入 tagchatroomTag
    • 加入失败后增加了不同 errorCode 的中文提示。
  • 离开房间:

leaveRoomlogout 放在此方法里进行调用。

  • 断开连接:

onDisconnect 方法在组件内部已做销毁等操作,故外层仅做通知,不调用任何方法。

  • 页面销毁:

小程序组件的 onUnload 生命周期里,删除调用 logout 方法,改为调用 destroy 方法。

此文档是否对你有帮助?
有帮助
去反馈
  • 迁移步骤
  • 步骤一 集成 SDK
  • 步骤二 修改全局挂载引用变量名
  • 步骤三 更新 App 代码
  • 变更介绍