@byteplus/rtc 4.56.2 → 4.58.0

package/extension-beauty/index.d.ts

@@ -1,88 +1,280 @@
-// Generated by dts-bundle-generator v6.13.0
+// Generated by dts-bundle-generator v8.0.1
 
+import { EventEmitter } from 'eventemitter3';
 
-/** {en}
- * @brief Basic beauty effect mode.
- */
-export declare enum EffectBeautyMode {
+declare abstract class ExtensionBase extends EventEmitter {
+	abstract name: string;
+	abstract type: RTCExtensionType;
+	abstract init(engineParams?: any): Promise<void>;
+	protected abstract _enable: boolean;
+	isOpen(): boolean;
+	abstract destroy(): void;
+	isSupported(): Promise<boolean>;
+	monitor?: any;
+	get _reportName(): string;
+}
+declare abstract class PreProcessingExtension extends ExtensionBase {
+	type: RTCExtensionType;
+	abstract effect(track: ITrack, processTrack: MediaStreamTrack): Promise<MediaStreamTrack>;
+	abstract applyConstraints(streamIndex: StreamIndex, constraints: MediaTrackConstraints): void;
+}
+declare class IRTCBeautyExtension {
+	constructor(options: IRTCBeautyExtensionConfig);
 	
-	/** {en}
-	 * @brief Brightness.
+	/** 
+	 * @brief Check the compatibility of current browser.
+	 * @return Compatibility check result.
 	 */
-	EFFECT_WHITE_MODE = 0,
+	checkCompatibility: () => Promise<CompatibilityCheckResult>;
 	
-	/** {en}
-	 * @brief Smoothness.
+	/** 
+	 * @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.
 	 */
-	EFFECT_SMOOTH_MODE = 1,
+	enableBeauty: () => Promise<void>;
 	
-	/** {en}
-	 * @brief Sharpness.
+	/** 
+	 * @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.
 	 */
-	EFFECT_SHARPEN_MODE = 2
+	enable: () => Promise<void>;
+	
+	/** 
+	 * @brief Disable basic beauty effects.
+	 */
+	disableBeauty: () => Promise<void>;
+	
+	/** 
+	 * @hidden
+	 * @deprecated since 4.52, use disableBeauty instead.
+	 * @brief Disable basic beauty effects.
+	 */
+	disable: () => Promise<void>;
+	
+	/** 
+	 * @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;
+	
+	/** 
+	 * @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: () => Promise<void>;
+	
+	/** 
+	 * @brief Disable virtual background.
+	 */
+	disableVirtualBackground: () => Promise<void>;
+	
+	/** 
+	 * @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;
+	
+	/** 
+	 * @brief Get the current virtual background image.
+	 * @return The URL of the current virtual background image.
+	 */
+	getBackgroundImage: () => string;
+	
+	/** 
+	 * @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>;
+	
+	/** 
+	 * @brief Set the priority of the facial recognition AI algorithm.
+	 * @param type The priority of the facial recognition AI algorithm.
+	 */
+	setAIModelType: (type: BackgroundAIModelType) => void;
+}
+declare class RTCBeautyExtension extends PreProcessingExtension implements IRTCBeautyExtension {
+	name: string;
+	protected _enable: boolean;
+	static _loadingProcess?: Promise<void>;
+	static _sdk?: ArSdk;
+	static _sdkUrl: any;
+	static _sdkSourceUrl: any;
+	static _sdkHash?: string;
+	static _sdkAuthServer?: string;
+	static _authFileUrl?: string;
+	private _beautyExt?;
+	private _backgroundExt?;
+	private _enableBeauty;
+	private _enableBackground;
+	private _fps;
+	private _backgroundBackend;
+	private _backgroundAIModelType;
+	private _backgroundMode;
+	private _beautyDefaultValue;
+	private _preTrack;
+	constructor(options?: IRTCBeautyExtensionConfig);
+	static loadWebARSDK(): Promise<void>;
+	initWebArSDK(): Promise<void>;
+	init(engineParams: any): Promise<void>;
+	checkCompatibility(): Promise<CompatibilityCheckResult>;
+	effect(track: ITrack, processTrack?: MediaStreamTrack): Promise<MediaStreamTrack>;
+	enable(): Promise<void>;
+	enableBeauty(): Promise<void>;
+	disable(): Promise<void>;
+	disableBeauty(): Promise<void>;
+	enableVirtualBackground(): Promise<void>;
+	disableVirtualBackground(): Promise<void>;
+	setBeautyIntensity(beautyMode: EffectBeautyMode, intensity: number): void;
+	setBackgroundMode(mode: BackgroundMode): void;
+	getBackgroundImage(): string;
+	loadBackgroundImage(url: string): Promise<void>;
+	setAIModelType(type: BackgroundAIModelType): void;
+	applyConstraints(streamIndex: StreamIndex, constraints: MediaTrackConstraints): void;
+	isSupported(): Promise<boolean>;
+	isOpen(): boolean;
+	destroy(): void;
+	private _rtcSdkApiCall;
+}
+declare enum RTCExtensionType {
+	CAPTURE = 0,
+	PRE_PROCESSING = 1,
+	ENCODE = 2,
+	TRANSFER = 3,
+	POST_PROCESSING = 4,
+	DECODE = 5,
+	RENDERING = 6
+}
+declare enum SourceType {
+	EXTERNAL = 0,
+	INTERNAL = 1
+}
+declare enum StreamIndex {
+	
+	/** 
+	 * @brief A mainstream is a media stream either captured by the internal module or from the custom source.
+	 */
+	STREAM_INDEX_MAIN = 0,
+	
+	/** 
+	 * @brief Screen-sharing stream, including screen-sharing video streams and/ or audio streams from sound cards
+	 */
+	STREAM_INDEX_SCREEN = 1
 }
 
-/** {en}
- * @brief Virtual background mode.
+/** 
+ * @brief Whether to use CPU or GPU mode. CPU mode is set by default.
  */
-export declare enum BackgroundMode {
+export declare enum BackgroundAIBackend {
 	
-	/** {en}
-	 * @brief Blur background.
+	/** 
+	 * @brief CPU mode.
 	 */
-	BACKGROUND_BLUR = "blur",
+	CPU = -1,
 	
-	/** {en}
-	 * @brief Image background.
+	/** 
+	 * @brief GPU mode. The SDK will check whether the current browser supports GPU mode, and will automatically fall back to CPU mode if GPU mode is not supported.
 	 */
-	BACKGROUND_IMAGE = "image"
+	GPU = 1
 }
 
-/** {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 Whether to use CPU or GPU mode. CPU mode is set by default.
+/** 
+ * @brief Virtual background mode.
  */
-export declare enum BackgroundAIBackend {
+export declare enum BackgroundMode {
 	
-	/** {en}
-	 * @brief CPU mode.
+	/** 
+	 * @brief Blur background.
 	 */
-	CPU = -1,
+	BACKGROUND_BLUR = "blur",
 	
-	/** {en}
-	 * @brief GPU mode. The SDK will check whether the current browser supports GPU mode, and will automatically fall back to CPU mode if GPU mode is not supported.
+	/** 
+	 * @brief Image background.
 	 */
-	GPU = 1
+	BACKGROUND_IMAGE = "image"
+}
+
+/** 
+ * @brief Basic beauty effect mode.
+ */
+export declare enum EffectBeautyMode {
+	
+	/** 
+	 * @brief Brightness.
+	 */
+	EFFECT_WHITE_MODE = 0,
+	
+	/** 
+	 * @brief Smoothness.
+	 */
+	EFFECT_SMOOTH_MODE = 1,
+	
+	/** 
+	 * @brief Sharpness.
+	 */
+	EFFECT_SHARPEN_MODE = 2
+}
+export interface ArSdk {
+	canvas?: HTMLCanvasElement;
+	video?: {
+		start: () => Promise<void>;
+		stop: () => Promise<void>;
+	};
+	extensions: any;
+	setOptions: (options: any) => void;
+	setDocumentTemplate: (template: any) => Promise<void>;
+	initialize: (options: any) => Promise<void>;
+	setStreamInput: (stream: MediaStream) => Promise<void>;
+	startFrame: () => void;
+	stopFrame: () => void;
+	setCanvasSize: (width: number, height: number) => void;
+	checkCompatibility: () => Promise<CompatibilityCheckResult>;
 }
 
-/** {en}
+/** 
  * @brief Compatibility check result.
  */
 export interface CompatibilityCheckResult {
 	
-	/** {en}
+	/** 
 	 * @brief Whether the system is compatible.
 	 *        &ensp; `true`: The system meets the requirements.
 	 *        &ensp; `false`: Incompatible.
 	 */
 	isCompatible: boolean;
 	
-	/** {en}
+	/** 
 	 * @brief Incompatible reasons.</br>
 	 *        &ensp; + 0: Other unknown reasons.
 	 *        &ensp; + 1: Browser does not support getUserMedia API.
@@ -92,13 +284,13 @@ export interface CompatibilityCheckResult {
 	 */
 	reasons: number[];
 	
-	/** {en}
+	/** 
 	 * @brief Extra message.
 	 */
 	message?: string;
 }
 
-/** {en}
+/** 
  * @brief Beauty extension configurations.
  */
 export interface IRTCBeautyExtensionConfig {
@@ -119,114 +311,31 @@ export interface IRTCBeautyExtensionConfig {
 	 */
 	sdkAuthServer?: string;
 	
-	/** {en}
+	/** 
 	 * @brief The authentication file's URL.
 	 */
 	authFileUrl?: string;
 	
-	/** {en}
+	/** 
 	 * @brief Whether to use CPU or GPU mode. CPU mode is set by default.
 	 */
 	aiBackend?: BackgroundAIBackend;
 	
-	/** {en}
+	/** 
 	 * @brief The priority of the facial recognition AI algorithm.
 	 */
 	aiModelType?: BackgroundAIModelType;
 }
-export declare class IRTCBeautyExtension {
-	constructor(options: IRTCBeautyExtensionConfig);
-	
-	/** {en}
-	 * @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: () => Promise<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.
-	 */
-	enable: () => Promise<void>;
-	
-	/** {en}
-	 * @brief Disable basic beauty effects.
-	 */
-	disableBeauty: () => Promise<void>;
-	
-	/** {en}
-	 * @hidden
-	 * @deprecated since 4.52, use disableBeauty instead.
-	 * @brief Disable basic beauty effects.
-	 */
-	disable: () => Promise<void>;
-	
-	/** {en}
-	 * @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: () => Promise<void>;
-	
-	/** {en}
-	 * @brief Disable virtual background.
-	 */
-	disableVirtualBackground: () => Promise<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 interface ITrack {
+	sourceType: SourceType;
+	mediaType: "audio" | "video";
+	mediaTrack: MediaStreamTrack;
+	streamIndex: number;
+	channelCount: number;
 }
 
 export {
-	IRTCBeautyExtension as default,
+	RTCBeautyExtension as default,
 };
 
 export {};