修复
- 修复了移动浏览器中的设备选择优先级问题,该问题导致选择了“Headset earpiece”(耳机听筒)而不是扬声器。
- 修复了参与者离开会议后音频活动报告器仍在运行的资源泄漏问题。
- 修复了等候名单中的参与者重新连接后,其请求从主持人等候名单中消失的问题。
增强功能
- 当信令 WebSocket 断开但媒体连接仍然正常时,音频、视频和屏幕共享将继续进行而无需重新启动。这样可以避免媒体中断,并将重连时间从 20–30 秒缩短到不到一秒。
- SDK 现在会并行建立信令连接和获取参与者详细信息,从而缩短会议初始化时间。
- Web Core 的 API、信令、日志记录和通话统计流量现在使用
api.realtime.cloudflare.com。使用 Web Core 2.0.3 时,您不再需要单独将api-silos.realtime.cloudflare.com、da-collector.realtime.cloudflare.com或socket-edge.realtime.cloudflare.com加入允许列表。所有必需的域名请参阅网络允许列表。 - 参与者顺序、置顶参与者、所选视图、分页和手动媒体订阅现在会在重连期间保留。
修复
- 修复了参与者重新连接后听不到或看不到其他人音频或视频的问题。
- 修复了暂时性信令故障中断 SDK 初始化或会议加入的问题。现在即使初始信令尝试失败也会创建会议对象,并且加入请求会自动重试。
- 修复了画中画在临时断开连接期间关闭的问题。现在画中画在重连期间会保持活动状态,并且其置顶和举手图标会使用配置的设计系统颜色。
- 修复了客户为某个 SDK 事件设置的回调抛出错误时会导致其他监听器无法运行的问题。SDK 现在会独立调用某个 SDK 事件的每个监听器。如果客户的回调抛出错误,其余监听器仍会运行。
- 修复了大规模重连期间参与者网格闪烁、暂时显示为空或显示重复/过时图块的问题。
增强功能
- 生成的 API 文档现在能正确识别类名,为 TypeScript 用户提供更准确的类型提示。
- 启动一个已在进行中的录制现在会返回错误代码
1005,而不是通用错误代码1000。如果您的onError回调针对这种情况处理的是错误代码1000,请将其更新为处理1005。
修复
- 修复了使用包含
RequestError的 ES2015 构建时可能出现的 Babel 转译错误。 - 修复了 SFU 超时后的会话恢复问题。现在在 SFU API 暂时超时后,参与者仍可以继续听到和看到其他人。
- 修复了批量创建媒体消费者的分批逻辑,使参与者网格每页最多支持 100 名参与者(此前为每页 24 名)。
修复
- 修复了 ES5 构建的包中包含
VERSION_PLACEHOLDER而不是实际 SDK 版本的问题。 - 修复了初始 socket 连接尝试失败时 SDK 初始化失败的问题,该问题还会导致无法创建插件存储。SDK 现在会根据 socket 连接状态重试创建存储。
兼容性: 与 RealtimeKit Web UI Kit 2.0.0 或更高版本搭配使用效果最佳。
这是一个包含重大破坏性变更的版本。多个已弃用的 API 已被移除,插件 API 也已全面重新设计。升级前请仔细阅读下面的迁移指南。
插件 API — 全面重新设计
插件不再自动从服务器获取。现在您需要在 SDK 初始化时通过 defaults.plugins 提供插件配置。
之前(v1.x):
// plugins were loaded via API in SDK internally
const meeting = await RealtimeKitClient.init({
authToken,
});
// Server-hosted plugins were auto-populated
const plugin = meeting.plugins.all.get(pluginId);
// Plugin rendered in an iframe managed by the SDK
plugin.addPluginView(iframeElement, 'plugin-main');
// Permissions checked via meeting.self.permissions.plugins.canStart / canClose
之后(v2.0):
插件组件可以是任何 HTMLElement。您可以使用自定义元素、挂载到容器上的框架组件或 iframe。以下示例将一个协作文本编辑器嵌入为插件:
const editor = document.createElement('iframe');
editor.src = 'https://rustpad.io/#WKLJaD';
editor.style.width = '100%';
editor.style.height = '100%';
editor.style.border = 'none';
const meeting = await RealtimeKitClient.init({
authToken,
defaults: {
plugins: [
{
id: 'collaborative-editor', // SDK prefixes this with {meetingId}: to create the namespaced plugin.id
name: 'Collaborative Editor',
icon: 'https://example.com/editor.png',
permissions: {
canActivate: true,
canDeactivate: true,
},
component: editor,
},
],
},
});
// Plugin is registered and available
const plugin = meeting.plugins.all.get(pluginId);
// Activate — state is synced across all participants
await plugin.activate();
有关构建自定义插件的完整指南,请参阅构建您自己的插件。如果需要录制插件内容,您必须构建自定义录制应用。
主要变更:
- 新的类型导出:
ClientPluginConfig、ClientPluginPermissions。 - 插件
id现在带有命名空间:SDK 会在您提供的id前添加{meetingId}:前缀,以创建内部的pluginId。 - 插件的激活和停用状态现在通过协作存储(
__rtk_plugins__)同步,而不是通过专用的 socket 消息。 - 插件现在具有
component属性(任何HTMLElement),取代了通过addPluginView进行的基于 iframe 的渲染。 - 每个插件的权限(
plugin.permissions.canActivate/plugin.permissions.canDeactivate)取代了旧的全局meeting.self.permissions.plugins.canStart/meeting.self.permissions.plugins.canClose。
已移除的插件 API:
plugin.addPluginView(iframe, viewId)— 请改为在ClientPluginConfig中将HTMLElement作为component传入。plugin.removePluginView(viewId)— 由 UI Kit 自动处理。plugin.enable()— 请使用plugin.activate()。plugin.disable()— 请使用plugin.deactivate()。plugin.sendIframeEvent()— 已移除。请直接与您的组件通信。plugin.baseURL— 已移除。插件不再由服务器托管。plugin.picture— 请使用plugin.icon。plugin.description、plugin.organizationId、plugin.tags、plugin.type、plugin.staggered、plugin.private、plugin.published、plugin.createdAt、plugin.updatedAt— 已移除,不再适用。plugin.config(PluginConfig)— 已移除。不再有插件清单的概念。meeting.self.permissions.plugins.canStart— 请使用plugin.permissions.canActivate。meeting.self.permissions.plugins.canClose— 请使用plugin.permissions.canDeactivate。modules.devTools.plugins(本地开发插件配置)— 请使用defaults.plugins,并将component指向您的本地元素。
已移除的弃用 API
客户端:
meeting.joinRoom()— 请使用meeting.join()。meeting.leaveRoom()— 请使用meeting.leave()。
聊天:
meeting.chat.getMessagesByUser(userId)— 请使用带有适当筛选条件的meeting.chat.fetchPublicMessages()。meeting.chat.getMessagesByType(type)— 请使用带有适当筛选条件的meeting.chat.fetchPublicMessages()。meeting.chat.getMessages(timestamp, size, reversed)— 请使用meeting.chat.fetchPublicMessages()或meeting.chat.fetchPrivateMessages()。meeting.chat.searchMessages(query, filters)— 请使用meeting.chat.fetchPublicMessages()或meeting.chat.fetchPrivateMessages()。meeting.chat.pinned(getter)— 请使用meeting.chat.fetchPinnedMessages()。
权限(meeting.self.permissions):
permissions.produceVideo— 请使用permissions.canProduceVideo。permissions.produceAudio— 请使用permissions.canProduceAudio。permissions.produceScreenshare— 请使用permissions.canProduceScreenshare。permissions.waitingRoomType— 请使用permissions.waitingRoomBehaviour。permissions.canChangeParticipantRole— 请使用permissions.canChangeParticipantPermissions。permissions.canChangeTheme— 已移除(始终返回false)。permissions.canPresent— 请分别检查canProduceAudio、canProduceVideo、canProduceScreenshare。permissions.requestProduce— 请检查各项媒体权限是否为CAN_REQUEST值。permissions.acceptPresentRequests— 请使用permissions.acceptStageRequests。permissions.maxScreenShareCount— 请使用meeting.self.config.maxScreenShareCount。PermissionPreset.fromResponse()— 请使用PermissionPreset.init()。PermissionPreset.default()— 请使用PermissionPreset.init()。
参与者:
meeting.participants.disableAudio(participantId)— 请使用meeting.participants.joined.get(participantId).disableAudio()。meeting.participants.disableVideo(participantId)— 请使用meeting.participants.joined.get(participantId).disableVideo()。meeting.participants.kick(participantId)— 请直接对参与者调用 kick。participant.clientSpecificId— 请使用participant.customParticipantId。
关联会议:
meeting.connectedMeetings.supportsConnectedMeetings— 已移除。现在通过meeting.self.permissions.connectedMeetings进行细粒度的权限检查。
增强功能
- 更快的重连:仅 socket 断开(WebRTC 传输仍然正常)时,现在会跳过完整的传输重新设置。生产者会被重新注册,现有消费者会被重新映射,从而显著缩短重连时间。
- 参与者在重连期间保持可见:在 socket 短暂中断期间,参与者图块会保留在网格中,而不会消失后再重新出现,从而提供无缝体验。
- 双重音频修复:修复了由于过时的生产者未被清理,导致其他参与者可能听到重新连接的参与者的双重音频的问题。
- socket 重连弹性:socket 现在支持最多 50 次重连尝试(此前为 10 次),采用指数退避和抖动,在网络中断时可提供大约四分钟的重试覆盖。
- 存储改进:
StoreManager现在支持refresh(name),可从服务器重新获取存储数据,并且保留的存储名称(__rtk_plugins__)受到保护,用户无法创建。
修复
- 修复了断开连接 30 秒后 socket 无法重连的问题。
兼容性: 与 RealtimeKit Web UI Kit 1.2.0 或更高版本搭配使用效果最佳。
新功能
- 为加入会议室期间的媒体(WebRTC)连接失败新增专用错误代码
0014,便于将媒体故障与 socket 和信令故障区分开来。
增强功能
Client.init()和meeting.join()的初始化和加入失败现在会给出具体的错误代码和描述性消息,而不是通用错误或层层叠加的错误。- 当浏览器支持
CompressionStreamAPI 时,遥测日志现在会使用 gzip 压缩,压缩比约为 10:1。较旧的浏览器和 React Native 会回退为使用较小批次大小的未压缩 JSON。
修复
- 修复了一个基于正则表达式的问题:Safari 视频中间件标志被错误移除,可能导致 Safari 上的视频处理失效。
- 修复了 SDK 重试失败的 API 请求时
ClientError对象被相互嵌套包装的问题。该问题会导致错误消息嵌套、onError回调重复以及多余的window错误事件。
已移除的 API
- 移除了第三方标志服务。
meeting.__internals__.features现已弃用,并将在未来的版本中移除。
兼容性: 与 RealtimeKit Android Core 2.0.0+ 和 RealtimeKit iOS Core 2.0.0+ 搭配使用效果最佳。
新功能
- 新增
meeting.__internals__.authToken以公开身份验证令牌,为将来的功能和增强改进 Web Core 与 UI Kit 之间的集成。
修复
- 主动修复了一个问题:在 Chrome 148 及更高版本中,开启 simulcast 的参与者会因 SDP 故障而无法打开摄像头或麦克风。
增强功能
- SDK 现在在内部使用
*.realtime.cloudflare.com基础 URI,而不是旧版的dyte.io基础 URI。 - 重构了错误处理,以正确捕获并显示 SDK 初始化失败、会议室加入失败及其他错误的错误代码。
新功能
- Simulcast 支持现已向所有 RealtimeKit 客户端开放。可以通过 RealtimeKit 仪表板、使用
config.media.video.simulcast字段的 Preset API,或在初始化 SDK 时,在预设中按参与者进行配置。 - 在媒体生产中新增 4K UHD 视频支持(可在预设和 API 中配置)。如果摄像头不支持 4K,则回退到支持的最高分辨率。
兼容性: 与 RealtimeKit Web UI Kit 1.1.1 或更高版本搭配使用效果最佳。
增强功能
- 为 ICE 连接失败实施了重试次数限制,以防止无限期的连接尝试并提高可靠性。
- 改进了会议室加入操作的错误处理,以提供更具描述性且可据以采取行动的错误消息。
- 当网络连接被防火墙阻止或 TURN 服务器无法访问时,现在会一致地抛出会议室加入错误。
修复
- 修复了关联会议中在会议室之间切换时未重新生成对等方 ID 的问题。现在会按会议室会话正确分配对等方 ID。
兼容性: 与 RealtimeKit Web UI Kit 1.1.0 或更高版本搭配使用效果最佳。
新 API
通过以下方法新增聊天分页支持:
meeting.chat.fetchPinnedMessages- 从服务器获取置顶消息。meeting.chat.fetchPublicMessages- 从服务器获取公开消息。meeting.chat.fetchPrivateMessages- 从服务器获取私人消息。
增强功能
- 为所有面向公众的方法和类添加了 JSDoc 注释,以改进开发者的代码提示。
- 聊天消息操作(编辑、删除、置顶)现在无需额外配置即可供所有 RealtimeKit 客户端使用。
meeting.chat上的pinMessage和unpinMessage事件现在可以可靠地触发。- 消息置顶(
meeting.chat.pin和meeting.chat.unpin)现在对所有参与者开放。
已移除的 API
移除了不可用的聊天频道 API,以精简 RealtimeKit SDK。会议聊天(meeting.chat)仍可完全正常使用。
- 移除了
meeting.self.permissions.chatChannel。 - 移除了
meeting.self.permissions.chatMessage。请改用meeting.self.permissions.chatPublic和meeting.self.permissions.chatPrivate。 - 移除了
meeting.chat.channels。 - 移除了
meeting.chat.sendMessageToChannel。 - 移除了
meeting.chat.markLastReadMessage。 - 从
meeting.chat中移除了以下事件:channelMessageUpdate、channelCreate和channelUpdate。
API 变更
- 以下方法不再接受可选的第三个参数
channelId:meeting.chat.editTextMessage(messageId, message)meeting.chat.editImageMessage(messageId, imageFile)meeting.chat.editFileMessage(messageId, file)meeting.chat.editMessage(messageId, messagePayload)meeting.chat.deleteMessage(messageId)
弃用
由于可扩展性限制(仅限最近 1,000 条消息),以下方法已弃用:
meeting.chat.messages- 仅获取最近的消息以及加入后的新消息。meeting.chat.getMessagesByUser- 请使用新的 fetch 方法以可扩展的方式获取消息。meeting.chat.getMessagesByType- 请使用新的 fetch 方法以可扩展的方式获取消息。meeting.chat.getMessages- 请改用meeting.chat.fetchPublicMessages或meeting.chat.fetchPrivateMessages。meeting.chat.pinned- 请改用meeting.chat.fetchPinnedMessages。meeting.chat.searchMessages- 请改用meeting.chat.fetchPublicMessages或meeting.chat.fetchPrivateMessages。
已知限制
- 私人聊天不支持置顶消息。
修复
修复了以下问题:在禁用音频和视频的情况下加入会议、随后发起标签页屏幕共享的用户,在停止屏幕共享时会遇到 SDP 损坏,导致无法执行启用音频或视频等后续操作。
抛出的错误:
InvalidAccessError: Failed to execute 'setRemoteDescription' on 'RTCPeerConnection': Failed to set remote answer sdp: Failed to set remote audio description send parameters for m-section with mid='<N>'修复了 await
RealtimeKitClient.initMedia时不返回媒体轨道的问题用法示例:
const media = await RealtimeKitClient.initMedia({ video : true, audio: true, }); const { videoTrack, audioTrack } = media;修复了由于竞态条件导致未定义变量在媒体获取过程中引发
TypeError: Cannot read properties of undefined (reading 'getValue')的问题。
修复
- 修复了在 Android 设备上无法在前置和后置摄像头之间切换的问题
- 修复了设备选择逻辑,以更有效地对媒体设备进行优先级排序
- 为 Reactions 新增画中画支持
修复
- 解决了导致无法选择默认媒体设备的问题。
- 修复了 SDK 包,使其包含
browser.js,而不是像 1.2.0 中那样错误地发布index.iife.js。
增强功能
- 在未设置首选设备时,外部媒体设备现在优先于内部设备。
新功能
新增通过
initMeeting配置 simulcast 的支持:initMeeting({ overrides: { simulcastConfig: { disable: false, encodings: [{ scaleResolutionDownBy: 2 }], }, }, });
修复
- 解决了在某些极端情况下,网格分页期间远程参与者的视频画面不可见的问题。
- 修复了当列表中的第一个麦克风无法工作时,参与者无法切换麦克风的问题。
破坏性变更
- 已移除对旧版媒体引擎的支持。如果您的组织是在 2025 年 3 月 1 日之前创建的,并且您要升级到此 SDK 版本或更高版本,可能会遇到录制问题。请联系支持团队迁移到新的 Cloudflare SFU 媒体引擎,以确保录制功能继续正常工作。
修复
- 当活跃发言人未发生变化时,不再触发发言人变更事件。
- 应对了最近版本的 Google Chrome 中麦克风切换的行为变化。
- 添加了
deviceInfo日志,以改进 React Native 的调试能力。 - 修复了为同一对等方排队多个媒体消费者的问题,优化了资源使用。
修复
- 通过正确的音频采样改进了 React Native 对
AudioActivityReporter的支持。 - 解决了导致用户无法创建投票的问题。
- 修复了离开会议耗时超过 20 秒的问题。
修复
- 直播功能现已向所有 Beta 用户开放。
- 修复了直播舞台功能中参与者加入舞台时主持人未消费对等方视频的问题。
- 解决了直播舞台中观众加入和离开的相关问题。
新功能
- 新增用于切换自己图块可见性的方法。
- 在关联会议(分组讨论室)之间引入了广播功能。
新 API
跨会议广播消息:
meeting.participants.broadcastMessage("<message_type>", { message: "Hi" }, { meetingIds: ["<connected_meeting_id>"], });
增强功能
- 缩短了批量加入时显示新加入参与者视频的时间。
- 在 RealtimeKit Core SDK 中新增对同一页面上多个会议的支持。