aliyun-rtc-sdk 6.11.3 → 6.11.4

package/dist/plugins/beautyPlugin.d.ts

@@ -0,0 +1,208 @@
+import EventEmitter from 'eventemitter3';
+import { LocalStream, IProfile } from 'aliyun-rts-sdk';
+import { IVideoConstraints, IAudioConstraints } from 'media-device';
+import { QueenEngineWorker } from 'aliyun-queen-engine';
+import { BeautyParams } from 'aliyun-queen-engine/dist/QueenTypes';
+
+declare enum VideoStreamSource {
+    Camera = 0,
+    Screen = 1,
+    Image = 2
+}
+declare enum AudioStreamSource {
+    Microphone = 0,
+    Screen = 1,
+    Mixed = 2
+}
+/**
+ * ------------------    模式    ----- 采样率  -----  声道  -----  码率（kbps）  -----
+ *
+ * standard:           标准音质         48000       单声道          64
+ *
+ * high:                 高音质         48000       单声道         128
+ *
+ * standard-stereo:   立体声音质         48000       双声道         80
+ *
+ * high-stereo:       立体声高音质       48000       双声道         192
+ */
+type AudioProfileKey = 'standard' | 'high' | 'standard-stereo' | 'high-stereo';
+
+declare enum AliRtcRawDataStreamType {
+    /** 相机流 */
+    AliRtcSdkStreamTypeCapture = 0,
+    /** 屏幕共享流 */
+    AliRtcSdkStreamTypeScreen = 1
+}
+
+interface AliRtcLocalStreamListener {
+    videotrackended: () => void;
+    audiotrackended: () => void;
+}
+declare class AliRtcLocalStreamInfo extends EventEmitter<AliRtcLocalStreamListener> {
+    type: AliRtcRawDataStreamType;
+    originVideoTrack?: MediaStreamTrack;
+    videoSource?: VideoStreamSource;
+    private _videoMuted;
+    originAudioTrack?: MediaStreamTrack;
+    audioSource?: AudioStreamSource;
+    private _audioMuted;
+    private _targetVideoTrack?;
+    private _targetDualVideoTrack?;
+    private _targetAudioTrack?;
+    private _publishVideoStream?;
+    private _publishDualVideoStream?;
+    private _publishAudioStream?;
+    private _previewStream?;
+    plugins: AliRtcPlugin[];
+    private _profileManager?;
+    cameraVideoConstraints?: IVideoConstraints;
+    micAudioConstraints?: IAudioConstraints;
+    private get profileManager();
+    get audioProfile(): AudioProfileKey | undefined;
+    constructor(type: AliRtcRawDataStreamType);
+    private onVideoTrackEnded;
+    private onAudioTrackEnded;
+    updateSource(newStream: LocalStream, newVideoSource?: VideoStreamSource, newAudioSource?: AudioStreamSource): Promise<void>;
+    get currentProfile(): string | undefined;
+    get currentVideoTrack(): MediaStreamTrack | undefined;
+    get currentDualVideoTrack(): MediaStreamTrack | undefined;
+    get publishVideoStream(): LocalStream | undefined;
+    get publishDualVideoStream(): LocalStream | undefined;
+    get currentAudioTrack(): MediaStreamTrack | undefined;
+    get publishAudioStream(): LocalStream | undefined;
+    get previewStream(): LocalStream | undefined;
+    /**
+     * 更新 VideoTrack
+     * @param videoTrack
+     */
+    updateVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 更新 DualVideoTrack
+     * @param videoTrack
+     * @param force
+     */
+    updateDualVideoTrack(videoTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 更新 AudioTrack
+     * @param audioTrack
+     */
+    updateAudioTrack(audioTrack?: MediaStreamTrack, force?: boolean): Promise<void>;
+    /**
+     * 设置音频流静音
+     * @param muted
+     */
+    setAudioMuted(muted: boolean): void;
+    get isAudioMuted(): boolean;
+    /**
+     * 设置视频流静音
+     * @param muted
+     */
+    setVideoMuted(muted: boolean): void;
+    get isVideoMuted(): boolean;
+    process(localStreamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    /**
+     * 停止视频流
+     */
+    stopVideo(): void;
+    /**
+     * 停止音频流
+     */
+    stopAudio(): void;
+    /**
+     * 停止视频流和音频流
+     */
+    stop(): void;
+    /**
+     * 应该在执行完 plugin 后调用
+     * @param profileName
+     * @param profileValue
+     */
+    updateVideoProfile(profileName?: string, profileValue?: IProfile): Promise<void>;
+    get videoProfile(): string | undefined;
+    setVideoContentHint(hint?: string): void;
+    /**
+     * 应该在执行完 plugin 后调用
+     * @param profileName
+     */
+    updateAudioProfile(profileKey: AudioProfileKey): Promise<void>;
+    /**
+     * 复制视频 profile 到指定 LocalStream
+     * @param publishStream
+     */
+    cloneVideoProfile(publishStream: LocalStream): Promise<void>;
+    addPlugin(plugin: AliRtcPlugin): void;
+    removePlugin(plugin: AliRtcPlugin): boolean;
+}
+
+declare enum AliRtcPluginType {
+    PRE_PROCESSOR = 0,
+    POST_PROCESSOR = 1
+}
+declare enum AliRtcPluginTrackType {
+    AUDIO = 0,
+    VIDEO = 1,
+    BOTH = 2
+}
+interface AliRtcPluginListener {
+    enabled: () => void;
+    disabled: () => void;
+    updated: () => void;
+    ready: () => void;
+    overload: (info: any) => void;
+    error: (error: any) => void;
+    unsupported: () => void;
+}
+declare abstract class AliRtcPlugin extends EventEmitter<AliRtcPluginListener> {
+    name: string;
+    options: any;
+    type: AliRtcPluginType;
+    streamType: AliRtcRawDataStreamType;
+    trackType: AliRtcPluginTrackType;
+    zIndex: number;
+    private _isEnable;
+    lastInputAudioTrack?: MediaStreamTrack;
+    lastOutputAudioTrack?: MediaStreamTrack;
+    lastInputVideoTrack?: MediaStreamTrack;
+    lastOutputVideoTrack?: MediaStreamTrack;
+    constructor(name: string, streamType?: AliRtcRawDataStreamType, trackType?: AliRtcPluginTrackType);
+    get initOptions(): {};
+    getOptions(): any;
+    abstract setOptions(options: any): void;
+    abstract isSupported(version: string): boolean;
+    init(): Promise<void>;
+    enable(): void;
+    disable(): void;
+    get isEnable(): boolean;
+    protected audioUpdated(streamInfo: AliRtcLocalStreamInfo): boolean;
+    protected videoUpdated(streamInfo: AliRtcLocalStreamInfo): boolean;
+    execute(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    abstract shouldUpdate(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): boolean;
+    abstract process(streamInfo: AliRtcLocalStreamInfo, streamInfos: AliRtcLocalStreamInfo[]): Promise<void>;
+    clear(_streamInfo?: AliRtcLocalStreamInfo): void;
+}
+
+type AliRtcBeautyPluginOptions = {
+    licenseKey?: string;
+} & BeautyParams;
+declare class AliRtcBeautyPlugin extends AliRtcPlugin {
+    engineReady: boolean;
+    _queenEngine?: QueenEngineWorker;
+    canvas?: HTMLCanvasElement;
+    dirty: boolean;
+    lastFrameTimestamp: number;
+    continuousStuckCount: number;
+    get initOptions(): {
+        licenseKey: string;
+    };
+    setOptions(options: AliRtcBeautyPluginOptions): void;
+    constructor();
+    init(): Promise<void>;
+    isSupported(): boolean;
+    private initQueen;
+    shouldUpdate(streamInfo: AliRtcLocalStreamInfo): boolean;
+    process(streamInfo: AliRtcLocalStreamInfo): Promise<void>;
+    get queenEngine(): QueenEngineWorker | undefined;
+    clear(streamInfo?: AliRtcLocalStreamInfo): void;
+}
+
+export { AliRtcBeautyPlugin as default };