@byteplus/rtc 4.47.6 → 4.47.8

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 {};