@byteplus/rtc 4.51.2 → 4.52.0

package/extension-beauty/index.d.ts

@@ -21,10 +21,81 @@ export declare enum EffectBeautyMode {
 	 */
 	EFFECT_SHARPEN_MODE = 2
 }
+
+/** {en}
+ * @brief Virtual background mode.
+ */
+export declare enum BackgroundMode {
+	
+	/** {en}
+	 * @brief Blur background.
+	 */
+	BACKGROUND_BLUR = "blur",
+	
+	/** {en}
+	 * @brief Image background.
+	 */
+	BACKGROUND_IMAGE = "image"
+}
+
+/** {en}
+ * @brief The priority of the facial recognition AI algorithm.
+ */
+export declare enum BackgroundAIModelType {
+	
+	/** {en}
+	 * @brief Performance mode.
+	 */
+	PERFORMANCE = 0,
+	
+	/** {en}
+	 * @brief Quality mode.
+	 */
+	QUALITY = 1
+}
+
+/** {en}
+ * @brief Compatibility check result.
+ */
+export interface CompatibilityCheckResult {
+	
+	/** {en}
+	 * @brief Whether the system is compatible.
+	 *          `true`: The system meets the requirements.
+	 *          `false`: Incompatible.
+	 */
+	isCompatible: boolean;
+	
+	/** {en}
+	 * @brief Incompatible reasons.</br>
+	 *        &ensp; + 0: Other unknown reasons.
+	 *        &ensp; + 1: Browser does not support getUserMedia API.
+	 *        &ensp; + 2: Browser does not support WebAssembly.
+	 *        &ensp; + 3: Browser cannot get video input devices.
+	 *        &ensp; + 100: Failed to load WebAR SDK.
+	 */
+	reasons: number[];
+}
 export declare class IRTCBeautyExtension {
 	
 	/** {en}
-	 * @brief Enables basic beauty effects.
+	 * @brief Check the compatibility of current browser.
+	 * @return Compatibility check result.
+	 */
+	checkCompatibility: () => Promise<CompatibilityCheckResult>;
+	
+	/** {en}
+	 * @brief Enable 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.
+	 */
+	enableBeauty: () => void;
+	
+	/** {en}
+	 * @hidden
+	 * @deprecated since 4.52, use enableBeauty instead.
+	 * @brief Enable 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.
@@ -32,18 +103,67 @@ export declare class IRTCBeautyExtension {
 	enable: () => void;
 	
 	/** {en}
-	 * @brief Disables basic beauty effects.
+	 * @brief Disable basic beauty effects.
+	 */
+	disableBeauty: () => void;
+	
+	/** {en}
+	 * @hidden
+	 * @deprecated since 4.52, use disableBeauty instead.
+	 * @brief Disable basic beauty effects.
 	 */
 	disable: () => void;
 	
 	/** {en}
-	 * @brief Sets the beauty effect intensity.
+	 * @brief Set 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;
+	
+	/** {en}
+	 * @brief Enable virtual background.
+	 * @notes + Call [setBackgroundMode](#setbackgroundmode) to set the virtual background mode. If you do not set the mode, the blur background will be enabled.
+	 *        + Call [disableVirtualBackground](#disablevirtualbackground) to turn off virtual background.
+	 *        + This API is not applicable to screen capturing.
+	 */
+	enableVirtualBackground: () => void;
+	
+	/** {en}
+	 * @brief Disable virtual background.
+	 */
+	disableVirtualBackground: () => void;
+	
+	/** {en}
+	 * @brief Set the virtual background mode.
+	 * @param mode Virtual background mode.
+	 * @notes After turning on the virtual background, you can call this API to switch the used virtual background mode.
+	 */
+	setBackgroundMode: (mode: BackgroundMode) => void;
+	
+	/** {en}
+	 * @brief Get the current virtual background image.
+	 * @return The URL of the current virtual background image.
+	 */
+	getBackgroundImage: () => string;
+	
+	/** {en}
+	 * @brief Set the virtual 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.
+	 */
+	loadBackgroundImage: (url: string) => Promise<void>;
+	
+	/** {en}
+	 * @brief Set the priority of the facial recognition AI algorithm.
+	 * @param type The priority of the facial recognition AI algorithm.
+	 */
+	setAIModelType: (type: BackgroundAIModelType) => void;
 }
 
 export {