@byteplus/rtc 4.47.6 → 4.47.7

package/extension-beauty/index.d.ts

@@ -1,15 +1,53 @@
-// Generated by dts-bundle-generator v6.4.0
+// Generated by dts-bundle-generator v6.13.0
 
+
+/** {en}
+ * @brief Basic beauty effect mode.
+ */
 export declare enum EffectBeautyMode {
+	
+	/** {en}
+	 * @brief Brightness.
+	 */
 	EFFECT_WHITE_MODE = 0,
+	
+	/** {en}
+	 * @brief Smoothness.
+	 */
 	EFFECT_SMOOTH_MODE = 1,
+	
+	/** {en}
+	 * @brief Sharpness.
+	 */
 	EFFECT_SHARPEN_MODE = 2
 }
 export declare class IRTCBeautyExtension {
+	
+	/** {en}
+	 * @brief Enables basic beauty effects.
+	 * @notes + Call [setBeautyIntensity](#setbeautyintensity) to set the beauty effect intensity. If you do not set the intensity, the brightness, smoothness, and sharpness intensity will default to 0.5.
+	 *        + Call [disable](#disable) to turn off basic beauty effects.
+	 *        + This API is not applicable to screen capturing.
+	 */
 	enable: () => void;
+	
+	/** {en}
+	 * @brief Disables basic beauty effects.
+	 */
 	disable: () => void;
+	
+	/** {en}
+	 * @brief Sets the beauty effect intensity.
+	 * @param beautyMode Basic beauty effect.
+	 * @param intensity Beauty effect intensity in range of [0,1], default to 0.5. When you set it to 0, the beauty effect will be turned off.
+	 * @notes + If you call this API before calling [enable](#enable), the default settings of beauty effect intensity will adjust accordingly.
+	 *        + If you destroy the engine, the beauty effect settings will be invalid.
+	 */
 	setBeautyIntensity: (beautyMode: EffectBeautyMode, intensity: number) => void;
 }
-export default IRTCBeautyExtension;
+
+export {
+	IRTCBeautyExtension as default,
+};
 
 export {};

package/index.d.ts

@@ -2586,7 +2586,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @notes + Streams are not published automatically in multi-room mode by default, you need to call this API to publish streams manually.
 	 *        + An invisible user cannot publish media streams. Call [setUserVisibility](#setuservisibility) to change your visibility in the room.
 	 *        + Call [publishScreen](#publishscreen) to start screen sharing.
-	 *        + After you call this API, the other users in the room will receive [onUserPublishStream](104479#onuserpublishstream). Those who successfully received your streams will receive [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) at the same time.
+	 *        + After you call this API, the other users in the room will receive [onUserPublishStream](104479#onuserpublishstream).
 	 *        + Call [unpublishStream](#unpublishstream) to stop publishing streams.
 	 * @region Room Management
 	 */
@@ -2605,7 +2605,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 * @brief Publishes local screen sharing streams in the current room.
 	 * @param mediaType Media stream type, used for specifying whether to publish audio stream or video stream.
 	 * @notes + An invisible user cannot publish media streams. Call [setUserVisibility](#setuservisibility) to change your visibility in the room.
-	 *        + After you called this API, the other users in the room will receive [onUserPublishScreen](104479#onuserpublishscreen). Those who successfully received your streams will receive [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) at the same time.
+	 *        + After you called this API, the other users in the room will receive [onUserPublishScreen](104479#onuserpublishscreen).
 	 *        + Call [unpublishScreen](#unpublishscreen) to stop publishing screen sharing streams.
 	 * @region Screen Sharing
 	 */
@@ -2645,8 +2645,7 @@ export interface IRTCEngine extends EnhancedEventEmitter<IEngineEvents> {
 	 *        You can call this API in both automatic subscription mode and manual subscription mode.
 	 * @param userId The ID of the remote user who published the target screen audio/video stream.
 	 * @param mediaType Media stream type, used for specifying whether to subscribe to the audio stream or the video stream.
-	 * @notes + You must first get the remote stream information through [onUserPublishScreen](104479#onuserpublishscreen) before calling this API to subscribe to streams accordingly.
-	 *        + The [onAudioFirstFrameDecoded](104479#onaudiofirstframedecoded)/[onVideoFirstFrameDecoded](104479#onvideofirstframedecoded) callback will be triggered after calling this API to indicate that the audio/video stream was successfully received.
+	 * @notes You must first get the remote stream information through [onUserPublishScreen](104479#onuserpublishscreen) before calling this API to subscribe to streams accordingly.
 	 * @region Room Management
 	 */
 	subscribeScreen: (userId: string, mediaType: MediaType) => Promise<void>;