1.8.0 update (#30)

CHANGELOG.md

@@ -1,4 +1,17 @@
 ## CHANGELOG
+## v1.8.0
+### Enhanced
+* Added `leaveOnPageUnload` option to the `client.init` method to support quickly leaving the session when refreshing or closing the page, instead of experiencing session failover.
+* Added `fps` option to the `stream.startVideo` method to set the maximum FPS of the captured video.
+* Added `replacedUserId` parameter to the `stream.stopRenderVideo` method to improve the video experience for the Speaker View scenario.
+* Improved the audio delay on mobile browsers.
+
+### Fixed
+* Fixed audio issues on iOS/iPadOS mobile browsers when starting audio with the `speakerOnly` option.
+* Fixed issues with CORS virtual background images.
+* Fixed audio issues on iOS/iPadOS mobile browsers when switching back from other apps.
+* Fixed issues with live translation not translating other languages to English.
+
 ## v1.7.10
 ### Added
 * `mediaFile` option to `stream.startAudio` and `stream.startVideo` methods to support using media playback files as video or audio input.

dist/types/event-callback.d.ts

@@ -587,14 +587,22 @@ export declare function event_recording_change(payload: {
 }): void;
 
 /**
- * Occurs when individual cloud recording status changes.
- * Ask: when host start individual cloud recording, user will be asked to accept or decline.
- * Accept: when user accepts individual cloud recording.
- * Decline: when user declines individual cloud recording.
+ * Occurs when the individual cloud recording status changes.
+ * - Ask: When the host starts individual cloud recording, ask the user to accept or decline recording.
+ * - Accept: When the user accepts individual cloud recording.
+ * - Decline: When the user declines individual cloud recording.
  * @param payload The individual recording status.
+ * @event
+ * @category Recording
  */
 export declare function event_individual_recording_change(payload: {
+  /**
+   * state
+   */
   state: RecordingStatus;
+  /**
+   * The user ID being recorded.
+   */
   userId?: number;
 }): void;
 
@@ -900,7 +908,9 @@ export declare function event_video_statistic_data_change(payload: {
  * Occurs on video cell statistic data changes.
  * @param payload
  *
- *  @event
+ * @event
+ *
+ * @category Video
  */
 export declare function event_video_cell_detailed_change(payload: {
   /**
@@ -1092,6 +1102,9 @@ export declare function event_bo_main_session_change(payload: any): void;
  * })
  * ```
  * @event
+ *
+ * @category Live Transcription
+ *
  */
 export declare function event_caption_status(payload: {
   /**
@@ -1112,19 +1125,27 @@ export declare function event_caption_status(payload: {
  * })
  * ```
  * @event
+ *
+ * @category Live Transcription
  */
 export declare function event_caption_message(
   payload: LiveTranscriptionMessage,
 ): void;
 /**
  * Occurs if the automatic live transcription enable status changes.
  * @param payload
+ *
+ * @event
+ *
+ * @category Live Transcription
  */
 export declare function event_caption_enable(payload: boolean): void;
 
 /**
  * Occurs when the `requestReadReceipt` option is true in the `startShareScreen` method. The sharer can receive the event if someone can see the shared screen.
- *  @event
+ * @event
+ *
+ * @category Screen share
  */
 export declare function event_share_can_see_screen(): void;
 
@@ -1133,6 +1154,8 @@ export declare function event_share_can_see_screen(): void;
  * @param payload the event detail
  *
  * @event
+ *
+ * @category Camera
  */
 export declare function event_far_end_camera_request(payload: {
   /**
@@ -1157,6 +1180,8 @@ export declare function event_far_end_camera_request(payload: {
  * @param payload The event detail.
  *
  * @event
+ *
+ * @category Camera
  */
 export declare function event_far_end_camera_response(payload: {
   /**
@@ -1181,6 +1206,8 @@ export declare function event_far_end_camera_response(payload: {
  * @param payload The event detail.
  *
  * @event
+ *
+ * @category Camera
  */
 export declare function event_far_end_camera_in_control_change(payload: {
   /**
@@ -1195,6 +1222,9 @@ export declare function event_far_end_camera_in_control_change(payload: {
 /**
  * Occurs when camera capability changes.
  * @param payload
+ *
+ * @event
+ * @category Camera
  */
 export declare function event_far_end_camera_capability_change(payload: {
   /**
@@ -1212,6 +1242,8 @@ export declare function event_far_end_camera_capability_change(payload: {
  * @param payload the network quality
  *
  * @event
+ *
+ * @category Video
  */
 export declare function event_network_quality_change(payload: {
   /**
@@ -1251,6 +1283,8 @@ export declare function event_network_quality_change(payload: {
  *  });
  * ```
  * @event
+ *
+ * @category Screen share
  */
 export declare function event_share_statistic_data_change(payload: {
   /**
@@ -1301,5 +1335,7 @@ export declare function event_share_statistic_data_change(payload: {
  * @param payload boolean
  *
  * @event
+ *
+ * @category Live Transcription
  */
 export declare function event_caption_host_disable(payload: boolean): void;

dist/types/media.d.ts

@@ -189,7 +189,7 @@ interface AudioOption {
   syncButtonsOnHeadset?: boolean;
   /**
    * Specify a media file as the audio input. It can be an audio file or a video file.
-   * - If need to use a video file(mp4) as both video and audio input, make sure the URL is exactly the same,and start video first.
+   *  - If you need to use a video file (mp4) for both video and audio input, make sure the URL is exactly the same and start video first.
    */
   mediaFile?: MediaPlaybackFile;
 }
@@ -269,9 +269,13 @@ export interface CaptureVideoOption {
   ptz?: boolean;
   /**
    * Specify a media file as the video input.
-   * - If use the same playback as audio and video input, when stop video, the audio output will also be paused.
+   * - If you need to use the same playback as audio and video input, when you stop video, the audio output will also be paused.
    */
   mediaFile?: MediaPlaybackFile;
+  /**
+   * Specify the maximum frames per second (FPS) limitation. This is limited to between 10-30 FPS (inclusive). The default is 24 FPS.
+   */
+  fps?: number;
 }
 /**
  * Audio QoS data interface.
@@ -351,8 +355,8 @@ export interface ScreenShareOption {
    */
   displaySurface?: string;
   /**
-   * Specify the sourceId of selected screen, it's used for electron application or nw.js application
-   * See the detail:
+   * Specify the sourceId of the selected screen. This is used for the electron or nw.js application
+   * See for details:
    * electron https://www.electronjs.org/docs/latest/api/desktop-capturer
    * nw.js https://docs.nwjs.io/en/latest/References/Screen/#screenchoosedesktopmedia-sources-callback
    */
@@ -1156,6 +1160,7 @@ export declare namespace Stream {
    * @param additionalUserKey Optional. Must be paired with `renderVideo`.
    * @param underlyingColor Optional. Underlying color when video is stopped. Default is transparent.
    * @param isKeepLastFrame Optional. Determines whether to keep the last frame when stopping the video.
+   * @param replacedUserId Optional. Whether to replace the rendered user at the same coordinate position. The benefit of specifying the next user can reduce the gap time between switching two users' videos. Only one user's video can be preloaded at the same time.
    * @returns
    * - `''`: Success.
    * - `Error`: Failure. Details in {@link ErrorTypes}.
@@ -1167,6 +1172,7 @@ export declare namespace Stream {
     additionalUserKey?: string,
     underlyingColor?: UnderlyingColor | string,
     isKeepLastFrame?: boolean,
+    replacedUserId?: number,
   ): ExecutedResult;
 
   /**

dist/types/videoclient.d.ts

@@ -159,6 +159,13 @@ interface InitOptions {
    * Prevents devices from dimming or locking the screen when in a session.
    */
   stayAwake?: boolean;
+  /**
+   * Quickly leave the session when refreshing or closing the page, instead of experiencing session failover.
+   * Caveat for two scenarios:
+   * - PSTN: Phone user who is bound to the current user. The phone will hang up instead of staying connected.
+   * - Subsession: Users in a subsession need to be assigned again instead of having been assigned and auto-joining the subsession.
+   */
+  leaveOnPageUnload?: boolean;
 }
 /**
  * The video client is the core of the Video SDK.

package.json

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