1.12.5 update (#58)

dist/types/event-callback.d.ts

@@ -1733,6 +1733,7 @@ export declare function event_meeting_query_change(payload: {
 /**
  * Occurs when the user is invited to back to the main session.
  * @param payload
+ * @event
  * @category Subsession
  */
 export declare function event_subsession_invite_to_back_to_main_session(payload: {
@@ -1752,6 +1753,7 @@ export declare function event_subsession_invite_to_back_to_main_session(payload:
 /**
  * Occurs when there is a change in the status of users in the subsession.
  * @param payload
+ * @event
  * @category Subsession
  */
 export declare function event_subsession_user_update(payload: {
@@ -1799,6 +1801,7 @@ export declare function event_subsession_user_update(payload: {
 /**
  * Occurs when the broadcasted voice's status changes.
  * @param payload
+ * @event
  * @category Subsession
  */
 export declare function event_subsession_broadcast_voice(payload: {
@@ -1817,6 +1820,7 @@ export declare function event_subsession_broadcast_voice(payload: {
  * });
  * ```
  * @param payload
+ * @event
  * @category CRC
  */
 export declare function event_crc_device_call_state_change(payload: {
@@ -1840,6 +1844,7 @@ export declare function event_crc_device_call_state_change(payload: {
 /**
  * Occurs when the current audio volume changes.
  * @param payload
+ * @event
  * @category Audio
  */
 export declare function event_current_audio_level_change(payload: {
@@ -1853,7 +1858,24 @@ export declare function event_current_audio_level_change(payload: {
  * Occurs when there is a media internal error, such as an unexpected interruption in media capture or insufficient memory.
  * When receiving this event, we recommend refreshing the page or restarting the browser to resolve the issue.
  * Since the user must do this, we recommend that you provide a popup to guide the user, such as 'We detected an issue with the media stream that we cannot resolve. Please refresh the page to try to fix it.' With two buttons: 'Refresh' and 'Cancel'.
- *
+ * @event
  * @category Media
  */
 export declare function event_media_internal_error(): void;
+/**
+ * Occurs when the host or manager spotlights a user.
+ * ```javascript
+ * client.on('video-spotlight-change', (payload) => {
+ *  console.log(payload.spotlightList);
+ * });
+ * ```
+ * @param payload
+ * @category Video
+ * @event
+ */
+export declare function event_video_spotlight_change(payload: {
+  /**
+   * spotlighted user list
+   */
+  spotlightList: Array<{ userId: number }>;
+}): void;

dist/types/media.d.ts

@@ -1630,6 +1630,45 @@ export declare namespace Stream {
     userId: number,
     element?: string | VideoPlayer,
   ): Promise<VideoPlayer | Array<VideoPlayer>>;
+
+  /**
+   * Spotlight specific user's video. Available to host or manager.
+   *
+   * > ***Note***:Spotlighting a video affects the behavior of the `video-active-change` event. The spotlighted user remains the active user, regardless of whether they are speaking.
+   * > This also impacts the behavior in the recording file; when the 'Record active speaker' option is selected, the recording will always show the spotlighted user's video.
+   *
+   * @param userId Required. Id of user to spotlight.
+   * @param isReplaced Optional. Host can spotlight multiple users, if true, replace all spotlighted users, otherwise, add as a new spotlighted user.
+   *
+   * @returns
+   * - `''`: Success.
+   * - `Error`: Failure. Details in {@link ErrorTypes}.
+   * @category Video
+   */
+  function spotlightVideo(userId: number, isReplaced?: boolean): ExecutedResult;
+
+  /**
+   * Remove a user's video from being spotlighted.
+   *
+   *
+   * @param userId Optional.
+   * - If it is empty, remove the spotlighted tag from the current user's video.
+   * - Otherwise, remove the spotlighted tag from the specific user's video. Available to host or manager.
+   *
+   * @returns
+   * - `''`: Success.
+   * - `Error`: Failure. Details in {@link ErrorTypes}.
+   * @category Video
+   */
+  function removeSpotlightedVideo(userId?: number): ExecutedResult;
+  /**
+   * Remove all spotlighted videos. Available to host.
+   * @returns
+   * - `''`: Success.
+   * - `Error`: Failure. Details in {@link ErrorTypes}.
+   * @category Video
+   */
+  function removeAllSpotlightedVideos(): ExecutedResult;
   /**
    *
    * Gets the `isCapturingVideo` flag status.
@@ -1784,6 +1823,12 @@ export declare namespace Stream {
    * @category Video
    */
   function isVideoMirrored(): boolean;
+  /**
+   * Get a list of spotlighted users.
+   *
+   * @category Video
+   */
+  function getSpotlightedUserList(): Array<Participant>;
 
   // -------------------------------------------------[share]-----------------------------------------------------------
 
@@ -2223,7 +2268,7 @@ export declare namespace Stream {
    * > ***Note***: Due to browser capability limitations, the controlled user must download and install a remote control app to enable remote control.
    * > If the app is installed, we will try to launch it automatically right after the controlled user approves the request for remote control.
    * @param userId userId
-   * @param runAsAdmin  runAsAdmin optional.  For Windows only: If set, enable the Remote Control App control of all applications.
+   * @param runAsAdmin runAsAdmin optional. For Windows only: If set, enable the Remote Control App control of all applications.
    *  @returns
    * - `''`: Success
    * - `Error`: Failure. Details in {@link ErrorTypes}.

dist/types/videoclient.d.ts

@@ -80,6 +80,7 @@ import {
   event_subsession_invite_to_back_to_main_session,
   event_current_audio_level_change,
   event_media_internal_error,
+  event_video_spotlight_change,
 } from './event-callback';
 // import AIClient from '../src/summary';
 
@@ -162,9 +163,13 @@ interface InitOptions {
   webEndpoint?: string;
   /**
    * Optional
-   * Enforces multiple videos (up to 3 videos of others and 1 video of self) on platform without SharedArrayBuffer.
+   * Enforces multiple videos if true (up to 3 videos of others and 1 video of self) on platform without SharedArrayBuffer.
+   * If false, limits the view to one video.
+   * This may result in high CPU and memory usage.
+   * To increase the limit to up to 25 videos, set `disableRenderLimits` to `true`:
+   * `enforceMultipleVideos({ disableRenderLimits: true })`
+   * Note that the video quality may be poor and unreliable.
    * See [browser support](https://developers.zoom.us/docs/video-sdk/web/browser-support/) for details.
-   * Note that this may result in high CPU and memory usage.
    */
   enforceMultipleVideos?:
     | boolean
@@ -859,6 +864,15 @@ export declare namespace VideoClient {
     event: 'active-media-failed',
     listener: typeof event_media_internal_error,
   ): void;
+  /**
+   *
+   * @param event
+   * @param listener Details in {@link event_video_spotlight_change}
+   */
+  function on(
+    event: 'video-spotlight-change',
+    listener: typeof event_video_spotlight_change,
+  ): void;
   /**
    * Removes the event handler.
    * @param event Event name.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoom/videosdk",
-  "version": "1.12.1",
+  "version": "1.12.5",
   "description": "Zoom Web Video SDK",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",