trtc-sdk-v5 5.4.0-beta.2 → 5.4.0-beta.3

package/index.d.ts

@@ -80,6 +80,8 @@
 	        fillMode?: 'contain' | 'cover' | 'fill';
 	        mirror?: boolean;
 	        small?: boolean;
+	        receiveWhenViewVisible?: boolean;
+	        viewRoot?: HTMLElement;
 	    };
 	}
 	declare interface StopRemoteVideoConfig {
@@ -856,7 +858,7 @@
 	}
  class TRTC extends EventEmitter<TRTCEventTypes> {
 	    /**
-	     * Create a TRTC object for implementing functions such as entering a room, previewing, pushing, and pulling streams.<br>
+	     * Create a TRTC object for implementing functions such as entering a room, previewing, publishing, and subscribing streams.<br>
 	     *
 	     * **Note:**
 	     * - You must create a TRTC object first and call its methods and listen to its events to implement various functions required by the business.
@@ -912,7 +914,7 @@
 	     * - {@link module:TYPE.ROLE_AUDIENCE TRTC.TYPE.ROLE_AUDIENCE} Audience
 	     * Note: The audience role does not have the permission to publish local audio and video, only the permission to watch remote streams. If the audience wants to interact with the anchor by connecting to the microphone, please switch the role to the anchor through {@link TRTC#switchRole switchRole()} before publishing local audio and video.
 	     * @param {boolean} [options.autoReceiveAudio=true] Whether to automatically receive audio. When a remote user publishes audio, the SDK automatically plays the remote user's audio.
-	     * @param {boolean} [options.autoReceiveVideo=true] Whether to automatically receive video. When a remote user publishes video, the SDK automatically pulls and decodes the remote video. You need to call {@link TRTC#startLocalVideo startLocalVideo} to play the remote video.
+	     * @param {boolean} [options.autoReceiveVideo=true] Whether to automatically receive video. When a remote user publishes video, the SDK automatically subscribes and decodes the remote video. You need to call {@link TRTC#startLocalVideo startLocalVideo} to play the remote video.
 	     * @param {boolean} [options.enableAutoPlayDialog] Whether to enable the SDK's automatic playback failure dialog box, default: true.
 	     * - Enabled by default. When automatic playback fails, the SDK will pop up a dialog box to guide the user to click the page to restore audio and video playback.
 	     * - Can be set to false in order to turn off. Refer to {@tutorial 21-advanced-auto-play-policy}.
@@ -1305,9 +1307,11 @@
 	     * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: Main stream (remote user's camera)
 	     * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: Sub stream (remote user's screen sharing)
 	     * @param {object} [config.option] - Remote video configuration
-	     * @param {boolean} [config.option.small] - Whether to pull small streams
+	     * @param {boolean} [config.option.small] - Whether to subscribe small streams
 	     * @param {boolean} [config.option.mirror] - Whether to enable mirror
 	     * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - Video fill mode. Refer to the {@link https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit CSS object-fit} property.
+	     * @param {boolean} [config.option.receiveWhenViewVisible] - Since v5.4.0 <br>Subscribe video only when view is visible. Refer to: {@tutorial 27-advanced-small-stream}.
+	     * @param {HTMLElement} [config.option.viewRoot=document.body] - Since v5.4.0 <br>The root element is the parent element of the view and is used to calculate whether the view is visible relative to the root. The default value is document.body, and it is recommended that you use the first-level parent of the video view list. Refer to: {@tutorial 27-advanced-small-stream}.
 	     * @throws
 	     * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
 	     * - {@link module:ERROR_CODE.INVALID_OPERATION INVALID_OPERATION}
@@ -1334,9 +1338,11 @@
 	     * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: Main stream (remote user's camera)
 	     * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: Sub stream (remote user's screen sharing)
 	     * @param {object} [config.option] - Remote video configuration
-	     * @param {boolean} [config.option.small] - Whether to pull small streams. Refer to: {@tutorial 27-advanced-small-stream}.
+	     * @param {boolean} [config.option.small] - Whether to subscribe small streams. Refer to: {@tutorial 27-advanced-small-stream}.
 	     * @param {boolean} [config.option.mirror] - Whether to enable mirror
 	     * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - Video fill mode. Refer to the {@link https://developer.mozilla.org/en-US/docs/Web/CSS/object-fit CSS object-fit} property.
+	     * @param {boolean} [config.option.receiveWhenViewVisible] - Since v5.4.0 <br>Subscribe video only when view is visible. Refer to: {@tutorial 27-advanced-small-stream}.
+	     * @param {HTMLElement} [config.option.viewRoot=document.body] - Since v5.4.0 <br>The root element is the parent element of the view and is used to calculate whether the view is visible relative to the root. The default value is document.body, and it is recommended that you use the first-level parent of the video view list. Refer to: {@tutorial 27-advanced-small-stream}.
 	     * @throws
 	     * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
 	     * - {@link module:ERROR_CODE.INVALID_OPERATION INVALID_OPERATION}
@@ -1365,13 +1371,13 @@
 	     */
 	    stopRemoteVideo(config: StopRemoteVideoConfig): Promise<void>;
 	    /**
-	     * Mute a remote user and stop pulling audio data from that user. Only effective for the current user, other users in the room can still hear the muted user's voice.<br>
+	     * Mute a remote user and stop subscribing audio data from that user. Only effective for the current user, other users in the room can still hear the muted user's voice.<br>
 	     *
 	     * Note:
 	     * - By default, after entering the room, the SDK will automatically play remote audio. You can call this interface to mute or unmute remote users.
 	     * - If the parameter autoReceiveAudio = false is passed in when entering the room, remote audio will not be played automatically. When audio playback is required, you need to call this method (mute is passed in false) to play remote audio.
 	     * - This interface is effective before or after entering the room (enterRoom), and the mute state will be reset to false after exiting the room (exitRoom).
-	     * - If you want to continue pulling audio data from the user but not play it, you can call setRemoteAudioVolume(userId, 0)
+	     * - If you want to continue subscribing audio data from the user but not play it, you can call setRemoteAudioVolume(userId, 0)
 	     * @param {string} userId - Remote user ID, '*' represents all users.
 	     * @param {boolean} mute - Whether to mute
 	     * @throws
@@ -1651,7 +1657,7 @@
 	     * <br>
 	     * **Note**
 	     * - This interface does not support use under the http protocol, please use the https protocol to deploy your website. {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Privacy_and_security Privacy and security}
-	     * - Calling this method may temporarily open the camera to ensure that the camera list can be normally obtained, and the SDK will automatically release the camera capture later.
+	     * - Calling this method may temporarily open the camera to ensure that the camera list can be normally obtained, and the SDK will automatically stop the camera capture later.
 	     * - You can call the browser's native interface [getCapabilities](https://developer.mozilla.org/en-US/docs/Web/API/InputDeviceInfo/getCapabilities) to get the maximum resolutions supported by the camera, frame rate, mobile devices to distinguish between front and rear cameras, etc. This interface supports Chrome 67+, Edge 79+, Safari 17+, Opera 54+.
 	     * @example
 	     * const cameraList = await TRTC.getCameraList();
@@ -1674,7 +1680,7 @@
 	     * <br>
 	     * **Note**
 	     * - This interface does not support use under the http protocol, please use the https protocol to deploy your website. {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Privacy_and_security Privacy and security}
-	     * - Calling this method may temporarily open the microphone to ensure that the microphone list can be normally obtained, and the SDK will automatically release the microphone capture later.
+	     * - Calling this method may temporarily open the microphone to ensure that the microphone list can be normally obtained, and the SDK will automatically stop the microphone capture later.
 	     * - You can call the browser's native interface [getCapabilities](https://developer.mozilla.org/en-US/docs/Web/API/InputDeviceInfo/getCapabilities) to get information about the microphone's capabilities, e.g. the maximum number of channels supported, etc. This interface supports Chrome 67+, Edge 79+, Safari 17+, Opera 54+.
 	     * @example
 	     * const microphoneList = await TRTC.getMicrophoneList();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-sdk-v5",
-  "version": "5.4.0-beta.2",
+  "version": "5.4.0-beta.3",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "types": "index.d.ts",