// Generated by dts-bundle-generator v8.1.2

export declare class IRTCBeautyExtension {
	constructor(options?: IRTCBeautyExtensionConfig);
	/** 
	 * @brief 测试当前浏览器兼容性情况。
	 * @return 兼容性测试结果。
	 */
	
	checkCompatibility: () => Promise<CompatibilityCheckResult>;
	/** 
	 * @brief 开启基础美颜。
	 * @notes + 调用 [setBeautyIntensity](#setbeautyintensity) 设置基础美颜强度。若在调用本方法前没有设置美颜强度，则初始美白、磨皮、锐化强度均为 0.5。
	 *        + 调用 [disable](#disable) 关闭基础美颜。
	 *        + 本方法仅适用于视频源，不适用于屏幕源。
	 */
	
	enableBeauty: () => Promise<void>;
	/** 
	 * @hidden
	 * @deprecated since 4.52, use enableBeauty instead.
	 * @brief 开启基础美颜。
	 * @notes + 调用 [setBeautyIntensity](#setbeautyintensity) 设置基础美颜强度。若在调用本方法前没有设置美颜强度，则初始美白、磨皮、锐化强度均为 0.5。
	 *        + 调用 [disable](#disable) 关闭基础美颜。
	 *        + 本方法仅适用于视频源，不适用于屏幕源。
	 */
	
	enable: () => Promise<void>;
	/** 
	 * @brief 关闭基础美颜。
	 */
	
	disableBeauty: () => Promise<void>;
	/** 
	 * @hidden
	 * @deprecated since 4.52, use disableBeauty instead.
	 * @brief 关闭基础美颜。
	 */
	
	disable: () => Promise<void>;
	/** 
	 * @brief 设置基础美颜强度。
	 * @param beautyMode 基础美颜模式。
	 * @param intensity 美颜强度，取值范围为 [0,1]。强度为 0 表示关闭，默认强度为 0.5。
	 * @notes + 若在调用 [enable](#enable) 前设置美颜强度，则对应美颜功能的强度初始值会根据设置更新。
	 *        + 销毁引擎后，美颜功能强度恢复默认值。
	 */
	
	setBeautyIntensity: (beautyMode: EffectBeautyMode, intensity: number) => void;
	/** 
	 * @brief 开启虚拟背景。
	 * @notes + 调用 [setBackgroundMode](#setbackgroundmode) 设置虚拟背景模式。若在调用本方法前没有设置虚拟背景模式，则默认开启背景模糊。
	 *        + 调用 [disableVirtualBackground](#disablevirtualbackground) 关闭虚拟背景。
	 *        + 本方法仅适用于视频源，不适用于屏幕源。
	 */
	
	enableVirtualBackground: () => Promise<void>;
	/** 
	 * @brief 关闭虚拟背景。
	 */
	
	disableVirtualBackground: () => Promise<void>;
	/** 
	 * @brief 设置虚拟背景模式。
	 * @param mode 虚拟背景模式。
	 * @notes 开启虚拟背景后，可调用本方法动态切换使用的虚拟背景模式。
	 */
	
	setBackgroundMode: (mode: BackgroundMode) => void;
	/** 
	 * @brief 获取当前虚拟背景图片。背景模式为 `BACKGROUND_IMAGE` 时有效。
	 * @return 当前虚拟背景图片 URL。
	 */
	
	getBackgroundImage: () => string;
	/** 
	 * @brief 设置虚拟背景图片。背景模式为 `BACKGROUND_IMAGE` 时有效。
	 * @param url 虚拟背景图片 URL。
	 * @return
	 * @notes + 支持的图片格式为 jpg、jpeg、png。
	 *  + 图片和视频长宽比不一致时，为保证图片内容不变形，图片按短边缩放至与视频帧一致，使图片填满视频帧，对多出的高或宽进行剪裁。
	 * + 自定义图片带有局部透明效果时，透明部分由黑色代替。
	 * + 设置在插件的生命周期内有效。
	 */
	
	loadBackgroundImage: (url: string) => Promise<void>;
	/** 
	 * @brief 设置虚拟背景使用的人像识别 AI 算法效果。
	 * @param type 人像识别 AI 算法效果。
	 */
	
	setAIModelType: (type: BackgroundAIModelType) => void;
	/** 
	 * @brief 设置模糊效果半径。背景模式为 `BACKGROUND_BLUR` 时有效。
	 * @param radius 模糊效果半径。单位为 px。默认模糊半径为 20 px。
	 * [0, ∞)，没有上限，当值超过视频长边一半时模糊效果将不再变化。比如，在 640*480 下，当设置超过 320 时效果不再变化。
	 * @notes 设置在插件的生命周期内有效。
	 */
	
	setBackgroundBlurRadius: (radius: number) => void;
	/** 
	 * @brief 设置虚拟背景颜色，背景模式为 `BACKGROUND_COLOR` 时有效。
	 * @param color RGBA(red, green, blue, alpha) 或 #RRGGBBAA
	 * 比如，`rgba(255, 255, 255, 1)`。alpha 取值范围为 `0`（透明）到 `1`（不透明）。其余字段为0～255。
	 * 比如，#FFFFFFFF。alpha 取值范围为 `0`（透明）到 `1`（不透明）。其余字段为 0～0xFF。
	 * @return + `true`：设置成功。
	 *         + `false`：设置失败。
	 * @notes 设置在插件的生命周期内有效。
	 */
	
	setBackgroundColor: (color: string) => boolean;
	/** 
	 * @brief 设置背景视频。背景模式为 `BACKGROUND_VIDEO` 时有效。
	 * @param url 虚拟背景视频 URL。
	 * @return 视频资源加载异常会通过 promise.reject() 抛出
	 * @notes 设置在插件的生命周期内有效。
	 */
	
	loadBackgroundVideo: (url: string) => Promise<void>;
	/** 
	 * @brief 获取背景视频的点播地址。背景模式为 `BACKGROUND_VIDEO` 时有效。
	 * @return 虚拟背景视频 URL。
	 */
	
	getBackgroundVideo: () => string;
}
/** 
 * @brief 初始化时选择使用 CPU/GPU 模式，默认使用 CPU 模式。
 */

export declare enum BackgroundAIBackend {
	/** 
	 * @brief CPU 模式。
	 */
	
	CPU = "cpu",
	/** 
	 * @brief GPU 模式。SDK 内部会自动判断当前环境是否支持开启 GPU 模式，对于不支持的环境会自动回退为 CPU 模式。
	 */
	
	GPU = "gpu"
}
/** 
 * @brief 人像识别 AI 算法效果。
 */

export declare enum BackgroundAIModelType {
	/** 
	 * @brief 性能优先。
	 */
	
	PERFORMANCE = "fast",
	/** 
	 * @brief 效果优先。
	 */
	
	QUALITY = "accurate"
}
/** 
 * @brief 虚拟背景模式。
 */

export declare enum BackgroundMode {
	/** 
	 * @brief 背景模糊。默认模糊半径为 20 px。可调用 `setBackgroundBlurRadius` 指定模糊半径。
	 */
	
	BACKGROUND_BLUR = "blur",
	/** 
	 * @brief 图片。你还需要调用 `loadBackgroundImage` 指定图片以使设置生效。
	 */
	
	BACKGROUND_IMAGE = "image-url",
	/** 
	 * @brief 纯色背景。你还需要调用 `setBackgroundColor` 指定颜色以使设置生效。
	 */
	
	BACKGROUND_COLOR = "color",
	/** 
	 * @brief 视频。你还需要调用 `loadBackgroundVideo` 指定视频以使设置生效。
	 */
	
	BACKGROUND_VIDEO = "video-url"
}
/** 
 * @brief 基础美颜模式。
 */

export declare enum EffectBeautyMode {
	/** 
	 * @brief 美白。
	 */
	
	EFFECT_WHITE_MODE = 0,
	/** 
	 * @brief 磨皮。
	 */
	
	EFFECT_SMOOTH_MODE = 1,
	/** 
	 * @brief 锐化。
	 */
	
	EFFECT_SHARPEN_MODE = 2
}
/** 
 * @brief 兼容性测试结果。
 */

export interface CompatibilityCheckResult {
	/** 
	 * @brief 是否兼容。</br>
	 *        &ensp; `true`：符合兼容性最低要求，可正常运行。
	 *        &ensp; `false`：不兼容，无法正常运行。
	 */
	
	isCompatible: boolean;
	/** 
	 * @brief 不兼容的原因。</br>
	 *        &ensp; + 0：其他未知原因。
	 *        &ensp; + 1：系统不支持 getUserMedia API。
	 *        &ensp; + 2：系统不支持 WebAssembly。
	 *        &ensp; + 3：系统获取不到 video input 设备。
	 *        &ensp; + 100：WebAR SDK 加载失败。
	 */
	
	reasons: number[];
	/** 
	 * @brief 加载失败时的附加信息
	 */
	
	message?: string;
}
/** 
 * @brief 美颜和虚拟背景插件参数。
 */

export interface IRTCBeautyExtensionConfig {
	/**
	 * @internal
	 */
	sdkUrl?: string;
	/**
	 * @internal
	 */
	sdkSourceUrl?: string;
	/**
	 * @internal
	 */
	sdkHash?: string;
	/**
	 * @internal
	 */
	sdkAuthServer?: string;
	/** 
	 * @brief 鉴权文件地址。
	 */
	
	authFileUrl?: string;
	/** 
	 * @brief 初始化时选择使用 CPU/GPU 模式，默认使用 CPU 模式。
	 */
	
	aiBackend?: BackgroundAIBackend;
	/** 
	 * @brief 人像识别 AI 算法效果。
	 */
	
	aiModelType?: BackgroundAIModelType;
}

export {
	IRTCBeautyExtension as default,
};

export {};