@byteplus/rtc 4.62.3 → 4.62.5

package/extension-beauty/index.d.ts

@@ -69,18 +69,19 @@ export declare class IRTCBeautyExtension {
 	setBackgroundMode: (mode: BackgroundMode) => void;
 	
 	/** 
-	 * @brief Get the current virtual background image.
+	 * @brief Get the current virtual background image. Ensure that the background mode is set to `BACKGROUND_IMAGE`.
 	 * @return The URL of the current virtual background image.
 	 */
 	getBackgroundImage: () => string;
 	
 	/** 
-	 * @brief Set the virtual background image.
+	 * @brief Set the virtual background image. Ensure that the background mode is set to `BACKGROUND_IMAGE`.
 	 * @param url URL of the virtual background image.
 	 * @return
 	 * @notes + You can upload a .JPG, .PNG, or .JPEG file.
-	 *        + If the image’s aspect ratio doesn't match the video's, the shortest side (either height or width) of the image will be stretched proportionally to match the video. Then the image will be cropped to fill in the video.
-	 *        + The transparent area in the image will be filled with black.
+	 * + If the image’s aspect ratio doesn't match the video's, the shortest side (either height or width) of the image will be stretched proportionally to match the video. Then the image will be cropped to fill in the video.
+	 * + The transparent area in the image will be filled with black.
+	 * + The setting can be stored and continue to be effective throughout the duration of the extension's lifecycle.
 	 */
 	loadBackgroundImage: (url: string) => Promise<void>;
 	
@@ -89,9 +90,41 @@ export declare class IRTCBeautyExtension {
 	 * @param type The priority of the facial recognition AI algorithm.
 	 */
 	setAIModelType: (type: BackgroundAIModelType) => void;
+	
+	/** 
+	 * @brief Sets the radius of the blur effect, measured in pixels (px). Ensure that the background mode is set to `BACKGROUND_BLUR`.
+	 * @param radius The radius of the blur effect. The blur radius defaults to 20 px.
+	 * The valid range for the radius is [0, ∞). However, note that the blur effect will no longer change beyond the half of the longer side of the video.
+	 * For example, in a video of 640x480, if you set a blur radius greater than 320 pixels, it will have the same effect as setting it to 320 pixels.
+	 * @notes The setting can be stored and continue to be effective throughout the duration of the extension's lifecycle.
+	 */
 	setBackgroundBlurRadius: (radius: number) => void;
+	
+	/** 
+	 * @brief Set the background color. Ensure that the background mode is set to `BACKGROUND_COLOR`.
+	 * @param color Color specified as RGBA(red, green, blue, alpha) or #RRGGBBAA.
+	 * Each component's value ranges from 0 to 255. The alpha component represents the opacity of the color and ranges from `0` (transparent) to `1` (opaque).
+	 * For example, rgba(255, 255, 255, 1) represents the color white with full opacity.
+	 * Alternatively, you can also use the hexadecimal color format #RRGGBBAA, where each pair of digits represents the values for red, green, blue, and alpha components. The alpha component ranges from 00 (transparent) to FF (opaque). For example, #FFFFFFFF represents the color white with full opacity.
+	 * @return + `true`: Success.
+	 *         + `false`: Failure.
+	 * @notes The setting can be stored and continue to be effective throughout the duration of the extension's lifecycle.
+	 */
 	setBackgroundColor: (color: string) => boolean;
+	
+	/** 
+	 * @brief Sets the URL of the virtual background video. Ensure that the background mode is set to `BACKGROUND_VIDEO`.
+	 * @param url URL of the virtual background video.
+	 * @return promise.reject() is used to throw an exception.
+	 * @notes The setting can be stored and continue to be effective throughout the duration of the extension's lifecycle.
+	 */
 	loadBackgroundVideo: (url: string) => Promise<void>;
+	
+	/** 
+	 * @brief Gets the URL of the virtual background video. Ensure that the background mode is set to `BACKGROUND_VIDEO`.
+	 * @return URL of the virtual background video.
+	 * @notes The setting can be stored and continue to be effective throughout the duration of the extension's lifecycle.
+	 */
 	getBackgroundVideo: () => string;
 }
 
@@ -133,15 +166,23 @@ export declare enum BackgroundAIModelType {
 export declare enum BackgroundMode {
 	
 	/** 
-	 * @brief Blur background.
+	 * @brief Blur background. The blur radius defaults to 20 px. You can specify the blur level via `setBackgroundBlurRadius`.
 	 */
 	BACKGROUND_BLUR = "blur",
 	
 	/** 
-	 * @brief Image background.
+	 * @brief Image. You need to specify the image via `loadBackgroundImage` before any visible modification will take effect.
 	 */
 	BACKGROUND_IMAGE = "image-url",
+	
+	/** 
+	 * @brief Solid color. You need to specify the color via `setBackgroundColor` before any visible modification will take effect.
+	 */
 	BACKGROUND_COLOR = "color",
+	
+	/** 
+	 * @brief Video.  Specify the video via `loadBackgroundVideo` before any visible modification will take effect.
+	 */
 	BACKGROUND_VIDEO = "video-url"
 }