Documentation
Documentation
Demo APP
SDK 中心
API 中心
FAQ
代码市场
Console
Sign Up
Log In
中文站 English
RoomKit
Product

ZEGO UIKits

  • In-app Chat Kit
  • Call Kit
  • Live Streaming Kit
  • Video Conference Kit
  • Live Audio Room Kit New

Cloud Communications Products

  • Video Call
  • Voice Call
  • Live Streaming
  • In-app Chat

Low-Code Products

  • RoomKit

AIGC

  • Virtual Avatar
  • Digital Human PaaS New

Supporting Services

  • Super Board
  • AI Effects
  • Cloud Recording
  • Admin Console
  • Mini Game Engine New
  • iOS : Objective-C
  • Android
  • Web
  • Flutter
Expand All
  • Introduction
  • Demo app
  • Sample codes
  • Client SDKs
    • SDK downloads
    • Release notes
  • Getting started
    • Integration
    • Start a room
  • Guides
    • Customize room parameters
    • Customize the room UI
    • Listen for room callbacks
    • Screen rotation support
    • Screen sharing
    • Manage rooms with Education Cloud Service
    • Use server event callbacks
  • Server APIs
  • Error codes
  • Documentation
  • RoomKit
  • Client SDKs
  • Release notes

Release notes

Last updated：2022-03-22 13:07

Version 2.0.5

Release date: 2021-09-28

Enhancements

Enhancement Description Related API
SDK internal optimization Optimization on the SDK internal structure. No impact on the SDK's APIs and features. None

Version 2.0.0

Release date: 2021-09-06

Enhancements

Enhancement Description Related API
SDK internal optimization Optimization on the SDK internal structure. No impact on the SDK's APIs and features. None

Bug fixes

Fixed the following issues:

  1. The SDK gives incorrect prompts when the current login is kicked out because the same user account logs in to multiple rooms of the same type.
  2. Potential warnings and risks.

Version 1.21.0

Release date: 2021-08-12

New features

New feature Description Related API
Captioning interface By listening for the new callback onCapturedAudioData, you can obtain the captured raw audio data for captioning process (which needs to be implemented by yourself), and then you can use the new method sendCustomMessage to send the generated captions. See API changes below

API changes

  • New APIs
New API Description
onCapturedAudioData This is a new callback added to the ZegoInRoomServiceDelegate class. You can listen for this callback to obtain the audio data of the stream being published. If the current user's microphone is off, the SDK won't trigger this callback.
sendCustomMessage This is a new method added to the ZegoInRoomService class. You can call this API to send custom messages to all or specified users.

Enhancements

Enhancement Description Related APIs
For Small Room: Enhancements for the room status that the session has not yet started When a Small Room session has not yet started:

The Host will be prompted with the room status and provided with a Start button to start the session.

The Assistants and Attendees will be shown with a pre-session countdown. In this status, they can't see other room members' video or any shared content, but they can use text chat.		 None
Support for using local images for profile images in messages Added the support for loading profile images in messages from the main bundle, sandbox, or URL. None

Version 1.20.0

Release date: 2021-08-02

New features

New feature Description Related API
New callback for events related to message interactions When message interactions happen in the room, the RoomKit SDK sends out event notifications through the callback onMessageEventNotify. onMessageEventNotify
Support for enabling the whiteboard's handwriting effect when joining a room When joining a room, you can enable the whiteboard's handwriting effect by setting the enableHandwriting property of ZegoJoinRoomUIConfig. ZegoJoinRoomUIConfig
For Large Room: Support for putting invited Attendees to the speaker stage without prior confirmation With this new feature, you can configure a Large Room to put invited Attendees to the speaker stage without having to wait for the Attendees to confirm in a pop-up window. None

Enhancements

Enhancement Description Related APIs
Message UI adjustment Adjusted the position of the profile image and icon. None
Optimization on the default images of Small Window mode When in Small Window mode, show different images to differentiate the status when the Host's microphone is off and the status when the Host hasn't entered the room yet. None

Version 1.19.0

Release date: 2021-07-15

New features

New feature Description Related API
For Large Room: Video-Only mode When a Large Room is in Video-Only mode, no whiteboard or file-sharing windows will be displayed in the room. None
For Large Room: Support for third-party live streams With this new feature, users in a Large Room can play a third-party live stream and share it with other room members. None

Enhancements

Enhancement Description Related APIs
For Large Room: Optimization on the Raise Hand feature In a Large Room, when Attendees click the Raise Hand button, the Host and Assistants will be notified with a red dot on the UI. A list of Attendees who are raising their hand is also added. None

Version 1.18.5

Release date: 2021-07-05

New features

New feature Description Related API
Support for setting profile image Added the support for setting the user's profile image when joining a room. setUserParameter
Support for displaying messages related to users entering/leaving the room at a fixed position Added the support for configuring the room to display messages related to users entering/leaving the room at a fixed position in the window. setUIConfig
Support for changing video mirror mode while in the room With this new feature, users can change the video mirror mode of their video preview while they are in the room. None

Version 1.18.0

Release date: 2021-06-24

New features

New feature Description Related API
For Large Room: Support for putting all Attendees on mute With this new feature, the Host and Assistants in a Large Room can mute all Attendees in the room. None
For Large Room: Support for removing a room member from the room With this new feature, the Host and Assistants in a Large Room can remove a room member from the room. None
Support for configuring whether to display messages related to room members entering/leaving the room A large number of messages related to room members entering/leaving the room might be interrupting. With this new setting, you can configure a room whether to display such messages. ZegoJoinRoomUIConfig

Enhancements

Enhancement Description Related API
API optimizations Deleted some unnecessary APIs and improved the integration process. See API changes below

API changes

  • New APIs
New API Description
setAdvancedConfig Sets private parameters of the SDK. Check with ZEGO Technical Support for details.
ZegoRoomKitRole Room members' roles in a room. Users of different roles in a room have different permissions in that room.
ZegoRoomParameter Room parameters for setting up custom room information.
ZegoScreenShareConfig Screen sharing configuration, which can be set by calling the addShareScreenModule method.
addShareScreenModule Adds the screen sharing feature to a room. If not set, the screen sharing feature will not be available in the room.
  • Deleted APIs
Deleted API Description
ZegoAuthenticationService Deleted the ZegoAuthenticationService class and removed the login logic.
ZegoUnloginedUserJoinRoomConfig Deleted the ZegoUnloginedUserJoinRoomConfig class and remove the related login logic.
ZegoOutRoomService Deleted the class related to out-of-room services. The related feature now can be realized by calling corresponding Server APIs.
ZegoListRoomCommand Deleted the class for room list query commands. The related feature now can be realized by calling corresponding Server APIs.
ZegoRoomBaseInfo Deleted the class for basic room information. The related feature now can be realized by calling corresponding Server APIs.
ZegoRoomAdvancedConfig Deleted the class for advanced room scheduling settings. The related feature now can be realized by calling corresponding Server APIs.
  • Updated APIs
Updated API Interface description
ZegoInitConfig Deleted unnecessary attributes: appName, dataFolder, logFolder, appGroupID, appExtensionBundleID. Only secretID is retained.
ZegoJoinRoomConfig New attribute names: productID, token, roomID, userName, userID, and role.
ZegoRoomDetailInfo Modified the room detail information class.
ZegoRoomTypeLargeRoom Changed the enumeration name ZegoRoomTypeLargeClass to ZegoRoomTypeLargeRoom.
ZegoJoinRoomUIConfig Deleted the customTitle attribute.
Added the isCompanyFilesHidden attribute to support the setting for whether to hide enterprise cloud storage.

Version 1.16.0

Release date: 2021-06-04

New features

New feature Description Related API
For Large Room: Support for playing the second video stream With this new feature, users in a Large Room can play the second video stream from the auxiliary channel. This feature can be used for dual-camera use cases. None
For Large Room: Notification of IM message recall In a Large Room, when IM messages from Attendees are recalled by the Host or Assistants, the related Attendees will be notified of the recall. None
For One-on-One Room: New user role Assistant With this new feature, users with the Assistant role can enter a One-on-One room to assist the Host in managing the room. None
Support for receiving custom signaling messages After a user sends a custom signaling message, the message recipients can receive the message from the callback receiveCustomMessage. receiveCustomMessage

Enhancements

Enhancement Description Related API
New error codes Added the following error codes:

  • 4020008: The room is full.
  • 4020009: No more Assistants can be added to the room.
ZegoRoomKitError
Error code optimization Optimized the enumeration name of the error code 4020004. ZegoRoomKitError
Support for user-defined log file names Added the support for uploading logs to the RoomKit server using custom-defined log file names. uploadLog

API changes

  • New APIs
New API Description
getCurrentRoomVC You can use this API to get the room container and add your own views to the room.

Version 1.15.0

Release date: 2021-05-20

Enhancements

Enhancement Description Related API
Enhanced Small Room to support switching between landscape and portrait mode. In the previous versions, Small Room is displayed in landscape mode by default and cannot be switched to portrait mode, which is not friendly to mobile users. With this enhancement, the viewing mode of Small Room switches automatically according to the screen orientation of the phone. None

Version 1.14.0

Release date: 2021-04-13

New features

New feature Description Related API
For Large Room: Raise Hand In a Large Room, Attendees can use the Raise Hand feature to request to speak. None
For Large Room: New user role Assistant In a Large Room, users with the Assistant role can assist the Host in managing the room. None

Enhancements

Enhancement Description Related API
Dynamic library file update

Replaced the ZegoAppDC.framework library with RoomkitDC.framework. Developers need to modify the library reference accordingly in the project when integrating this new version of the SDK.

For more details, see Integrate the RoomKit SDK.

 None
Stream encryption key field name change Renamed ZegoJoinRoomConfig.secretKey to ZegoJoinRoomConfig.streamEncryptKey to avoid ambiguity. ZegoJoinRoomConfig
Error code enumeration name change Renamed ZegoRoomKitErrorSecretKeyError to ZegoRoomKitErrorEncryptKeyError to avoid ambiguity. ZegoRoomKitError

Version 1.13.5

Release date: 2021-04-02

New features

New feature Description Related API
Small Window mode for mobile clients

In Small Window mode, the room window shrinks to a small window in the corner of the screen so the user can work on other tasks while keeping the meeting or live stream running. Whenever the user clicks the small window of the room, it returns to Full Screen mode.

When Small Window mode is activated for the room, the client receives a ZegoRoomEventMinimize message. Upon receiving this message, the client can perform the necessary steps to shrink down the room window. Call the displayRoomView method to get a room in Small Window mode back to Full Screen mode, which requires a View Controller to display the room.
New room UI configuration attribute for hiding the Small Window mode button Added a new attribute isMinimizeHidden to the ZegoJoinRoomUIConfig class to control whether the Small Window mode button should be hidden in the room UI. joinRoomWithConfig
New API for getting the basic information of a room After joining a room, you can get the basic information of the room by calling the getCurrentRoomInfo method. getCurrentRoomInfo
New API for getting the current video view After joining a room, you can get the current video view. For example, when the room is in Small Window mode, you can call the getCurrentVideoView method to get the current video view and display it somewhere outside the room window. getCurrentVideoView

Enhancements

Enhancement Description Related API
Removal of third-party library dependency Removed the dependency on the third-party library IQKeyboardManager. None

Version 1.13.0

Release date: 2021-03-29

New features

New feature Description Related API
Whiteboard real-time stroke synchronizaton With this new feature, participants can see each other's pen stroke trajectories on the whiteboard in real time. None

Enhancements

Enhancement Description Related API
Removal of third-party library dependency Removed the dependency on the third-party library Lottie. None

Bug fixes

Fixed the app crash issue caused by KeyWindow.

Version 1.12.0

Release date: 2021-03-16

New features

New feature Description Related API
Pre-session countdown Added the support for displaying the pre-session countdown for One-on-One Rooms and Large Rooms. None
Support for animated PPTs With this new feature, users can show animation effects, play embedded video and audio in PPTs when sharing animated PPTs. None

Enhancements

Enhancement Description Related API
UI optimization Optimized the UI display for Undo, Redo, and Clear. None

Bug fixes

Fixed the issue that the language setting sometimes does not take effect.

Other notes

Disabled the Bitcode support. Bitcode support is temporarily disabled for RoomKit because of the use of a third-party SDK that cannot support Bitcode for the moment.

Version 1.11.0

Release date: 2021-03-05

New features

New feature Description Related API
For One-on-One Room: New online teaching tools Added new online teaching tools such as Timer and Quiz Clicker for One-on-One Rooms. None
For Large Room: Support for room members on the stage to use whiteboard sharing and file sharing With this new feature, room members who have been invited to the stage in a Large Room can use whiteboard sharing and file sharing, and the room Host can grant/revoke sharing permissions to/from the room members. None
For Large Room: Support for local searching for room members With this new feature, users can perform local searching for room members in a Large Room. Currently, the search feature only supports prefix searching (case insensitive). None
Bitcode support Added Bitcode support for the RoomKit SDK and the dynamic libraries it depends on, including ZegoAppDC, ZegoDocsView, ZegoExpressEngine, ZegoGateway, and ZegoWhiteboardView. None

Enhancements

Enhancement Description Related API
API optimization Removed the isTestEnv property from the ZegoInitConfig class. ZegoInitConfig.

Version 1.10.0

Release date: 2021-02-26

New features

The initial release of the RoomKit SDK. This version provides various modular features, including real-time audio and video, file sharing, real-time messaging, room member management, and UI layout.

Page Directory
  • Free trial