@zoom/videosdk-ui-toolkit 2.3.5-1 → 2.3.15-1

package/README.md

@@ -1,5 +1,8 @@
 # Zoom Video SDK UI toolkit
 
+> **⚠️ Action Required:**
+> We recommend that you upgrade to 2.3.15-1 or above if you use WebRTC video to prevent issues with future Chrome versions.
+
 The [Zoom Video SDK UI toolkit](https://developers.zoom.us/docs/video-sdk/web/ui-toolkit/) is a prebuilt video chat user interface powered by the Zoom Video SDK.
 
 ![Zoom Video SDK UI toolkit web](https://github.com/zoom/videosdk-ui-toolkit-web/blob/main/uitoolkitgalleryview.png?raw=true)
@@ -111,7 +114,7 @@ After configuring your session, call the `uitoolkit.joinSession` function, passi
 ```js
 var sessionContainer = document.getElementById("sessionContainer");
 // const newConfig = uitoolkit.migrateConfig(config); if use migrate config from old version(<2.1.10)
-uitoolkit.joinSession(sessionContainer, newConfig);
+await uitoolkit.joinSession(sessionContainer, newConfig);
 ```
 
 ### Leave Session
@@ -121,7 +124,7 @@ To leave a Video SDK session, the user can click the red leave button. The host
 You can also leave a session programmatically by calling the `uitoolkit.closeSession` function:
 
 ```js
-uitoolkit.closeSession(sessionContainer);
+await uitoolkit.closeSession(sessionContainer);
 ```
 
 ### Event Listeners
@@ -281,11 +284,11 @@ uitoolkit.hideSettingsComponent(settingsContainer);
 Once your session has ended, we recommend properly cleaning up the UI Toolkit so users can join subsequent sessions. You can easily do this by using the `onSessionClosed` event listener. Simply call each component's respective hide function to properly remove each component from the DOM. See the following code snippet for an example:
 
 ```js
-  uitoolkit.onSessionClosed(sessionClosed)
+uitoolkit.onSessionClosed(sessionClosed);
 
-  function sessionClosed() {
-    // Your code here
-  }
+function sessionClosed() {
+  // Your code here
+}
 ```
 
 ## Sample Apps