TRTC Web SDKAPI 文档事件错误码类型教程更新日志
En

Tutorial: SDK 升级指引

SDK 升级指引

以下 SDK 版本存在接口变更或 Breaking Change,升级时需要注意。

Version 5.12.0 @2025.07.25

Breaking Changed

  • 移除 SDK 内置的 CDN 地址,并降低虚拟背景插件资源体积。若您属于如下任意情形,在升级版本时,需要重新部署 npm 包中的 assets 资源,在 TRTC.create({ assetsPath }) 传入您的资源路径。
    • 使用了虚拟背景插件。
    • 使用了 AI 降噪插件,但是之前没有部署过 npm 包中的 assets。

Version 5.10.0 @2025.04.17

  • 插件产物格式由 iife 转变为 umd,支持了更多接入环境。
    • 若您通过 import 方式引入插件,则可忽略。
    • 若您通过 script 标签加载插件,升级时需要注意修改插件文件名。
  • npm 包中的 wasm 资源文件统一迁移至 assets 目录,您部署时可以直接部署 assets 目录。

Version 5.6.0 @2024.5.17

【变更】

在 v5.6.0 之前的版本,SDK 默认开启自动视频拉流(当远端推视频流后,SDK 会自动拉远端视频流),但是有时候您的业务场景是按需拉取的,此时自动拉流会造成额外的带宽消耗。

在 v5.6.0 之后的版本,SDK 关闭默认自动视频拉流(当远端视频推流,SDK 不会自动拉视频流),即:trtc.enterRoom 的 autoReceiveVideo 参数默认值从 true 变更为 false。由业务侧按需调用 trtc.startRemoteVideo 来拉流播放视频,减少可能存在的不必要带宽占用。

如下场景建议您开启 autoReceiveVideo:

  1. 想要获得更快的“秒开”体验(从进房到看到首帧远端视频画面),您可以打开自动视频拉流。
  2. 远端没有推视频流,而是推了一路黑帧视频,用于发送 SEI 消息。此时对于接收端来说,黑帧视频流是不需要 trtc.startRemoteVideo 渲染出来的。因此你也可以打开自动视频拉流,以确保正常收到 SEI 消息。

Version 5.1.0 @2023.08.11

【背景】

  1. TRTC 数字类型和字符串类型房间号不互通。
  2. 在 v5.1.0 之前的版本,trtc.enterRoom 接口的 roomId 参数支持传入 number 和 string 两种类型。很容易出现因房间号类型不同,导致多端无法互通的情况。例如:TRTC Web 端使用了字符串类型 roomId "123",而 TRTC Android 使用了数字类型的 roomId 123。

【变更】

为防止出现上述情况,自 v5.1.0 版本开始,限制 trtc.enterRoom 接口的 roomId 参数为 number 类型,不再支持传入 string 类型。若要使用字符串房间号,请使用 strRoomId 参数。

从 4.x 升级到 5.x

TRTC Web SDK 5.0.0 于 2023 年 5 月 26 日正式发布。

TRTC Web SDK 5.x 版本是 Web 端全新升级版,提供扁平化接口、大幅简化 API、降低您的接入成本;在多人音视频场景下,具有更好的性能表现及弱网抗性。

5.x 版本的接口与 4.x 版本的接口不兼容,因此您如果升级到 5.x 版本,调用的接口需要做相应的改动。

此部分主要是为有 TRTC Web SDK 4.x 经验的、希望了解 5.x 的新功能和更改的用户而提供的。

如需查看完整的迁移说明,请参见 《TRTC Web SDK v4 升级到 v5 指引》