2.0版本升级指引

最近更新时间:2024-10-14 17:03:41

我的收藏
多人音视频能力(TUIRoomKit)2.0版本更新属于重大升级:全方位提升 SDK 能力、调整 SDK 服务端架构、新增全功能服务端 REST API。发布时间、1.x和2.0版本功能对比、变更影响等更多内容详见文档:多人音视频能力(TUIRoomKit)发布2.0版本 SDK 和推荐升级公告
注意:
本文主要帮助已接入1.x版本 SDK 的客户更快的升级至2.0版本,体验更强大的服务和功能。
如果您已付费购买多人音视频能力(TUIRoomKit),为了避免您的线上业务出现问题,请尽快参见下述步骤完成升级。
如果您之前没有接入过1.x版本的 SDK,或者您的应用目前仅在开发阶段,尚未上线,我们推荐您直接升级并使用2.0版本,功能更强大,更稳定。

升级步骤

1.关注事项

UIKit 已自适配2.0逻辑,您无需关心 UIKit 层面的修改。
部分接口变更:
RoomInfo 废弃了 SpeechModel,使用 enableSeat 和 seatMode 来替代。
废弃了 sendMessage、sendCustomMessage 接口。
服务端接口变更:
提供的 V2 版本的 REST API,全面覆盖房间管理,用户管理,会控管理等功能。
更多功能变更详情参见 功能说明

2.获取最新版本 SDK

您只需下载升级最新的 RoomEngine SDK,即可升级到2.0版本。各开发平台的升级参考代码如下:
Android
iOS
Web
Flutter
Electron
小程序
将 RoomEngine Maven 版本依赖修改如下:
implement "com.tencent.liteav:LiteAVSDK_TRTC:11.5.0.13312"
implement "com.tencent.liteav.tuikit:tuiroomengine:2.0.0.100"
implement "com.tencent.imsdk:imsdk-plus:7.7.5282"
在 Podfile 中,将依赖修改如下:
说明:
RoomKit和RoomEngine不必同时集成,您之前使用的是哪个,升级哪个即可,如果您之前修改过Roomkit的源码,现在仅需要升级RoomEngine,请在腾讯云实时音视频 TRTC 技术交流群平台联系我们,我们将给您提供帮助。
使用 RoomKit:
pod 'TUIRoomKit', '~> 2.0.0'
使用 RoomEngine:
pod 'TUIRoomEngine', '~> 2.0.0'
在您的项目根目录下,命令行中执行:
npm install @tencentcloud/tuiroom-engine-js@2
在 pubspec.yaml 文件中修改依赖的版本号,如下:
说明:
版本号按需修改,根据之前依赖的 package,修改对应的版本号即可。
dependencies:
# RoomKit 依赖
rtc_conference_tui_kit: ^2.0.0
# RoomEngine 依赖
rtc_room_engine: ^2.0.0
在项目的根目录下,在命令行执行:
flutter pub get
在您的项目根目录下,命令行中执行:
npm install @tencentcloud/tuiroom-engine-electron@2
在您的项目根目录下,命令行中执行:
# RoomKit 升级
npm install @tencentcloud/tui-roomkit-uniapp@2
# RoomEngine 升级
npm install @tencentcloud/tuiroom-engine-wx@2
注意:
如果您之前没有接入过1.x版本的 SDK,可直接前往 SDK 下载 文档下载最新版本 SDK;
如果您参考上述代码未成功升级,请在 腾讯云实时音视频 TRTC 技术交流群 联系我们,我们将为您提供帮助;

3.线上升级

线上推送新版本,灰度100%,完成线上升级,确保您的客户都升级到已包含2.0版本 SDK 的应用。
注意:
因服务端架构重大升级,1.x和2.0版本的房间无法直接互通,请务必完成线上升级,避免业务混用新旧版本 SDK。

4.开通2.0后台服务

如果您是2024年1月3日正式发布前已付费的多人音视频(TUIRoomKit)客户,在完成前3个步骤后,请加入 - 腾讯云实时音视频 TRTC 技术交流群,联系我们开通2.0后台服务,点击立即加入