发布日期:2024-04-09
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 支持伪直播场景 | 在大房间场景下,支持老师采用 云端播放器 推流,学生拉取该条流达到伪直播的效果。 | 请联系 ZEGO 技术支持。 |
发布日期:2023-02-09
问题修复
该版本修复了如下问题:
发布日期:2022-10-12
问题修复
该版本修复了如下问题:
问题修复
该版本修复了如下问题:
发布日期:2022-07-11
功能优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 接入方式优化 | 改善 SDK 接入方式,优化弱网环境,提升海外环境接入质量。 | - |
问题修复
修复了 Web 端与手机端提示文本不一致等的 UI 问题。
发布日期:2021-11-12
功能优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| SDK UI 层拆分 | RoomKit SDK 拆分为 RoomKitUI(UI 层) 和 RoomKitCore(数据层) 两个 SDK。 | - |
发布日期:2021-09-06
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| SDK 内部结构 | 优化 SDK 内部技术优化,对接口及功能无影响。 | - |
问题修复
该版本修复了如下问题:
问题修复
该版本修复了如下问题:
发布日期:2021-08-12
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 小房间场景新增助教角色 | 小房间场景下,支持助理主持进房功能。房间开始后助理主持与主持人拥有同样的权限和功能,包括对成员的权限操作和共享区域的操作,暂不支持助理主持发起教学工具。 | - |
| 小房间场景新增未开始上课状态 | 小房间场景下未开始上课时,主持显示课程未开始提示和开始上课按钮,成员显示课程开始倒计时,无法看到其他人的音视频画面和共享内容,但可以进行文字聊天。 | - |
| 支持实现字幕功能 | 通过新增的原始音频数据监听回调事件获取音频数据,开发者自行转换为字幕后可通过发送自定义消息接口实现字幕功能。 | 详见接口变更 |
接口变更
| 新增接口 | 接口描述 |
|---|---|
| capturedAudioData | 新增 capturedAudioData 原始音频数据监听回调事件。 |
| sendCustomMessage | 新增发送自定义消息接口, 可通过监听 receiveCustomMessage 事件接收自定义消息。 |
问题修复
该版本修复了如下问题:
问题修复
该版本修复了如下问题:
发布日期:2021-08-02
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增消息交互事件通知 | 当发生消息交互事件时 RoomKit 会向外通知 ZegoMessageEvent 类型的事件。 | onMessageEventNotify |
| 新增开启笔锋功能 | 用户可以在进入房间时配置 ZegoJoinRoomUIConfig 的 enableHandwriting 属性来开启白板笔锋功能。 | ZegoJoinRoomUIConfig |
| 新增大房间服务支持配置直接上台无需弹窗确认 | 大房间服务支持配置学生被邀请上台后直接上台,无需点击弹窗确认。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 消息UI调整 | 调整了头像和图标位置。 | — |
| 优化挤下线提示 | 当多端登录被挤下线时,会提示“离开课堂,帐号在其他地方登录,你已被迫下线”。 | — |
问题修复
该版本修复了如下问题:
发布日期:2021-07-15
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间场景新增纯视频模式 | 大房间场景在纯视频模式下将不显示白板课件等共享,创建共享将切换为共享模式,结束所有共享将切换为视频模式。 | - |
| 大房间场景新增支持共享第三方直播 | 大房间场景支持播放第三方直播的拉流地址,并发起共享推送给其他端。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 举手提醒优化 | 老师和助教端在学生举手时会有红点提醒,新增举手学生列表展示。 | — |
| 自定义消息优化 | 支持在当前页面打开自定义消息的链接。 | — |
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间场景支持展示纯视频模式 | 大房间场景在纯视频模式下将不显示白板课件等共享。 | - |
| 大房间场景支持展示第三方直播 | 大房间场景支持展示其他端发起的第三方直播共享。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 自定义消息优化 | 支持在当前页面打开自定义消息的链接。 | — |
发布日期:2021-07-05
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 加入房间支持传入成员头像 | 支持在加入房间时传入成员头像。 | setUserParameter |
| 支持配置是否固定展示进退房消息 | 支持配置在固定位置展示进退房消息。 | setUIConfig |
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 支持配置是否固定展示进退房消息 | 支持配置在固定位置展示进退房消息。 | setUIConfig |
发布日期:2021-06-24
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间场景支持设置学生进房是否需要设备检测 | 大房间场景中,可以设置学生进房后不进行设备检测流程。 | setUIConfig |
| 小房间场景支持隐藏未开启摄像头、麦克风成员画面 | 小房间场景中,可以设置隐藏未开启摄像头、麦克风成员画面 | setUIConfig |
| 成员进退房消息是否显示支持配置 | 大量的成员进退房消息可能对房间造成干扰,支持隐藏进退房消息。 | setUIConfig |
| 小房间场景新增参会成员是否允许自己打开麦克风、摄像头可配置项 | 小房间场景支持在 OSS 管理后台设置参会成员是否允许自己打开麦克风、摄像头可配置项。 | - |
| 共享白板和课件支持大小自适应 | 当浏览器窗口大小发生变化时,共享白板和课件会根据窗口变化进行自适应 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| SDK 接口优化 | 优化 SDK 对外接口,删除不必要的接口,方便开发者快速接入 | 参考接口变更 |
接口变更
| 新增接口 | 接口描述 |
|---|---|
| ZegoRoomKitRole | 加入房间的成员角色,不同角色加入房间权限不同。 |
| ZegoRoomParameter | 新增房间自定义参数接口,支持外部自定义房间信息。 |
| setAdvancedConfig | 设置 SDK 的私有参数, 具体的参数请咨询 ZEGO 技术支持。 |
| setRoomParameter | 新增设置房间自定义参数的方法,支持外部自定义房间信息。 |
| setUIConfig | 新增设置房间自定义UI的方法,支持外部自定义房间UI。 |
| 删除接口 | 接口描述 |
|---|---|
| ZegoAuthenticationService | 删除 ZegoAuthenticationService 类,移除登录逻辑。 |
| ZegoOutRoomService | 删除房间外服务接口类,相关功能可直接调用 Server API 实现。 |
| ZegoRoomBaseInfo | 删除房间基础信息类。 |
| ZegoRoomAdvancedConfig | 删除安排房间高级设置类。 |
| ZegoRoomDetailInfo | 删除房间详细信息类。 |
| 变更接口 | 接口描述 |
|---|---|
| ZegoInitConfig | 删除其中的非必要属性:appName、domain。 |
| ZegoJoinRoomConfig | 删除 uiConfig 属性。 新增字段:productID、token、roomID、userName、userID、role。 |
| ZegoJoinRoomUIConfig |
|
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 成员进退房消息是否显示支持配置 | 大量的成员进退房消息可能对房间造成干扰,支持隐藏进退房消息。 | setUIConfig |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| SDK 接口优化 | 优化 SDK 对外接口,删除不必要的接口,方便开发者快速接入 | 参考接口变更 |
接口变更
| 新增接口 | 接口描述 |
|---|---|
| ZegoRoomKitRole | 加入房间的成员角色,不同角色加入房间权限不同。 |
| ZegoRoomParameter | 新增房间自定义参数接口,支持外部自定义房间信息。 |
| setAdvancedConfig | 设置 SDK 的私有参数, 具体的参数请咨询 ZEGO 技术支持。 |
| setRoomParameter | 新增设置房间自定义参数的方法,支持外部自定义房间信息。 |
| setUIConfig | 新增设置房间自定义UI的方法,支持外部自定义房间UI。 |
| 删除接口 | 接口描述 |
|---|---|
| ZegoRoomBaseInfo | 删除房间基础信息类。 |
| ZegoRoomDetailInfo | 删除房间详细信息类。 |
| 变更接口 | 接口描述 |
|---|---|
| ZegoInitConfig | 删除其中的非必要属性:appName、domain。 |
| ZegoJoinRoomConfig | 删除 uiConfig 属性。 新增字段:productID、token、roomID、userName、userID、role。 |
| ZegoJoinRoomUIConfig |
|
发布日期:2021-06-04
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间服务新增消息撤回功能 | 大房间服务下,支持消息撤回功能。主持人/助理主持 IM 消息列表中,自己发送和收到的消息增加更多菜单,支持撤回此条消息和将发送此条消息的人移出房间。 | - |
| 大房间服务新增撤回成员全部消息功能 | 大房间服务下,支持撤回成员全部消息功能。主持人/助理主持移出成员时,支持勾选是否撤回成员全部消息,勾选后,成员被移出房间且消息都会被删除。 | - |
| 1V1 服务新增助理主持进房功能 | 1V1 服务下,支持助理主持进房功能。房间开始后助理主持与主持人拥有同样的权限和功能,包括对成员的权限操作和共享区域的操作,暂不支持助理主持开、关自己的摄像头和麦克风,不支持发起教学工具。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 新增错误码 | 新增如下错误码:
|
ZegoRoomKitError |
| 错误码命名更新 | 更新如下错误码:
|
ZegoRoomKitError |
问题修复
该版本修复了英文浏览器下教学工具插件文案仍显示为中文的问题。
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| IM 消息支持显示成员消息被撤回提示 | 大房间服务下,IM 消息支持显示成员消息被撤回提示。主持人/助理主持撤回成员消息,成员会收到该消息被撤回提示。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 新增错误码 | 新增如下错误码:
|
ZegoRoomKitError |
| 错误码命名更新 | 更新如下错误码:
|
ZegoRoomKitError |
发布日期:2021-05-31
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间服务新增低延迟直播场景 | 大房间服务新增低延迟直播场景,区别于传统直播,延迟降低至 1 秒内,直播观看体验更佳。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 画笔粗细优化 | 画笔粗细更新为 2 px、4 px、6 px、8 px。 | - |
接口变更
| 新增接口 | 接口描述 |
|---|---|
| receiveCustomMessageCallBack | 监听自定义消息接口。 |
问题修复
该版本修复了如下问题:
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间服务新增低延迟直播场景 | 大房间服务新增低延迟直播场景,区别于传统直播,延迟降低至 1 秒内,直播观看体验更佳。 | - |
发布日期:2021-05-27
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间服务新增支持语音直播场景 | 大房间服务下,支持开通语音直播场景。语音直播中主持人支持录制、发送和接收语音,支持互动白板、共享屏幕和文件、录制功能。成员支持接收语音消息、收发文本消息和查看共享区域内容。 | - |
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 支持加入语音直播房间 | 成员支持接收语音消息、收发文本消息和查看共享区域内容。 | - |
发布日期:2021-05-20
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 大房间支持对单个成员禁言 | 大房间场景下,主持人/助理主持成员列表中更多菜单新增禁言/解除禁言按钮,可对单个成员进行禁言/解除禁言操作。 | - |
| 大房间支持将成员移出房间 | 大房间场景下,主持人/助理主持成员列表中更多菜单新增移出按钮,可将该成员移出房间。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 英文文案根据单词分行 | 在弹窗和 IM 消息中,英文文案由根据长度分行改为根据单词分行,不会切断单词,更利于阅读。 | - |
| IM 消息中自己发送的消息的对齐方式 | IM 消息中自己发送的消息由右对齐调整为左对齐,更符合阅读习惯。 | - |
| 视频用缺省页代替白屏 | 视频未拉到流时会出现白屏,新增缺省页替代白屏。 | - |
接口变更
| 新增接口 | 接口描述 |
|---|---|
| endRoomCallBack | 监听房间结束接口。 |
| kickedOutOfRoomCallBack | 监听被移出房间接口。 |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 体验优化 | 房间开始后视频未推流时不展示播放按钮和白板。 | - |
接口变更
| 新增接口 | 接口描述 |
|---|---|
| endRoomCallBack | 监听房间结束接口。 |
| kickedOutOfRoomCallBack | 监听被移出房间接口。 |
发布日期:2021-05-17
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增共享辅助摄像头 | 大房间场景工具箱新增支持共享辅助摄像头。 | - |
问题修复
该版本修复了如下问题:
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 支持展示辅助摄像头共享画面 | - | - |
发布日期:2021-04-28
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增小房间场景 | 新增支持小房间场景,包含视频通话、文件共享、实时消息、成员管理等模块化功能。 | - |
发布日期:2021-04-16
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增设置隐藏主持人结束房间按钮功能 | ZegoJoinRoomUIConfig 新增 isEndRoomButtonHidden 属性,支持设置隐藏主持人结束房间按钮。 | joinRoomWithConfig |
| 新增设置成员隐藏房间人数展示功能 | ZegoJoinRoomUIConfig 新增 isMemberNumberHidden 属性,支持设置成员隐藏房间人数展示。 | joinRoomWithConfig |
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 支持展示自定义消息 | 支持展示接收到的卡片消息。 | - |
| 新增设置成员隐藏房间人数展示功能 | ZegoJoinRoomUIConfig 新增 isMemberNumberHidden 属性,支持设置成员隐藏房间人数展示。 | joinRoomWithConfig |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 显示优化 | 聊天记录支持显示助理主持人标签 | - |
发布日期:2021-04-13
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增设置房间标题功能 | ZegoJoinRoomConfig 新增 uiConfig 属性,支持设置房间标题。 | joinRoomWithConfig |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 聊天记录支持显示自己的昵称 | 1V1 和大房间场景的聊天消息支持显示自己的昵称。 | - |
问题修复
该版本修复了观众端无法看到企业云盘的问题。
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增设置房间标题功能 | ZegoJoinRoomConfig 新增 uiConfig 属性,支持设置房间标题。 | joinRoomWithConfig |
发布日期:2021-04-02
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增助理主持人角色 | 大房间场景支持助理主持人角色进入房间。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 统一 Token 获取方式 | 保持和其它端一致的鉴权方式,采用从服务端 API 获取 Token 进行鉴权。相关 API 请参考 服务端 API。 原有 SDK 采用的 Token 获取方式在新版本上不兼容,新的 Token 获取方式的实现可参考 快速启动房间 中获取 Token。更新新版本后需要同步更新 Token 鉴权方式,否则将出现登录失败、服务无法正常使用等情况。 |
- |
| 支持浏览器 | 支持 360 极速浏览器和 Edge 浏览器。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 统一 Token 获取方式 | 保持和其它端一致的鉴权方式,采用从服务端 API 获取 Token 进行鉴权。相关 API 请参考 服务端 API。 原有 SDK 采用的 Token 获取方式在新版本上不兼容,新的 Token 获取方式的实现可参考 快速启动房间 中获取 Token。更新新版本后需要同步更新 Token 鉴权方式,否则将出现登录失败、服务无法正常使用等情况。 |
- |
发布日期:2021-03-29
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增成员举手功能 | 大房间场景支持台下成员举手。 | - |
| 新增发送 IM 自定义消息功能 | 1V1 和大房间场景支持使用 sendMessage 接口发送 IM 自定义消息。 | sendMessage |
| 新增白板支持实时轨迹功能 | 优化白板功能,支持实时展示白板操作轨迹。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 优化接口 | 移除 ZegoJoinRoomConfig 中的属性 server | ZegoJoinRoomConfig |
问题修复
该版本修复了海外账户日志上报失败的问题。
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增连麦成员展示功能 | 大房间场景支持展示连麦成员。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 优化拉流体验 | 优化拉流交互。 | ----- |
发布日期:2021-03-16
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 新增未开始房间倒计时功能 | 1V1 和大房间场景支持未开始时展示开始倒计时。 | - |
| 新增展示房间已开始时间功能 | 1V1 和大房间场景支持展示房间已开始时间。 | - |
| 支持触发动态 PPT 动画、动态效果 | 支持用户共享动态 PPT 时展示动画效果,支持播放 PPT 内嵌视频、音频。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 优化 UI 展示 | 优化撤销、重做、清空 UI 展示方式。 | - |
问题修复
该版本修复了 CDN 录制偶尔不触发回调的问题。
发布日期:2021-03-05
新增功能
| 功能项 | 功能描述 | 相关接口 |
|---|---|---|
| 1V1 场景新增教学工具 | 1V1 场景下,在教学工具箱中新增计时器和答题器工具。 | - |
| 大房间场景新增台上成员共享功能 | 大房间场景下,观众被主持人邀请上台后,可以使用共享功能。主持人端可以对台上观众的共享功能进行给予/取消设置。 | - |
| 大房间场景新增成员本地搜索功能 | 大房间场景下,可以搜索群成员,目前只支持前缀匹配(不区分大小写)。 | - |
改进优化
| 优化项 | 优化描述 | 相关接口 |
|---|---|---|
| 优化录制功能 | 新增配置项,配置录制按钮的展示、录制方式、录制开启方式。 | - |
| 优化默认语言设置 | 根据浏览器语言判断加入房间默认为中文还是英文。 | - |
| 接口优化 | 移除 ZegoInitConfig 中的属性 isTestEnv。 | ZegoInitConfig |
问题修复
该版本修复了 joinRoomWithConfig 方法传 password 无效的问题。
发布日期:2021-02-26
新增功能
首次发布,包含音视频通话、文件共享、实时消息、成员管理、布局 UI 等模块化功能。

联系我们
文档反馈