fcr-ui-scene 3.4.0 → 3.4.2

package/lib/providers/device-provider.d.ts

@@ -0,0 +1,404 @@
+import { FcrBeautyOptions, FcrCameraTrack, FcrLoopbackTrack, FcrMicrophoneTrack, FcrScreenTrack } from 'fcr-core/lib/media-control/type';
+import { FcrDeviceInfo } from 'fcr-core/lib/type';
+import { FcrAiDenoiseLevel, FcrCapability, FcrDesktopMediaControl } from 'fcr-core';
+import { AgoraRtcDisplayInfo, AgoraRtcWindowInfo } from 'agora-rte-sdk/lib/core/rtc/type';
+import { VirtualBackground } from '../modules/device-pretest/assets/virtual-backdound-resources';
+import { FcrUIVideoEffectType, FcrUIBeautyKey, FcrUIConnectType, FcrUIResource, FcrUIDeviceObserver, FcrUIMediaConfig } from '../type';
+import { FcrUIEventProvider } from './event-provider';
+import { BeautyKey } from '../modules/setting/store';
+export declare const DEFAULT_DEVICE_ID = "default";
+export interface FcrUIDeviceProvider {
+    /**
+     * 当前摄像头ID
+     */
+    get cameraId(): string;
+    /**
+     * 当前麦克风ID，可能为default，表示跟随系统
+     */
+    get microphoneId(): string;
+    /**
+     * 当前扬声器ID，可能为default，表示跟随系统
+     */
+    get speakerId(): string;
+    /**
+     * 当前设备ID，包含真实的麦克风、扬声器设备ID
+     * microphoneId和speakerId不一定能代表真实的设备ID，可能是 default
+     */
+    get currentDeviceId(): {
+        cameraDeviceId: string;
+        microphoneDeviceId: string;
+        speakerDeviceId: string;
+    };
+    /**
+     * 当前摄像头Track对象
+     */
+    get cameraTrack(): FcrCameraTrack;
+    /**
+     * 当前麦克风Track对象
+     */
+    get microphoneTrack(): FcrMicrophoneTrack;
+    /**
+     * 当前是否开启了摄像头
+     */
+    get cameraEnabled(): boolean;
+    /**
+     * 当前是否开启了麦克风
+     */
+    get microphoneEnabled(): boolean;
+    /**
+     * 摄像头列表
+     */
+    get cameraList(): FcrDeviceInfo[];
+    /**
+     * 麦克风列表
+     */
+    get microphoneList(): FcrDeviceInfo[];
+    /**
+     * 扬声器列表
+     */
+    get speakerList(): FcrDeviceInfo[];
+    /**
+     * 当前设置的扬声器音量
+     */
+    get speakerVolume(): number;
+    /**
+     * 当前设置的麦克风音量
+     */
+    get microphoneVolume(): number;
+    /**
+     * 实时麦克风声量，设备关闭时为0
+     */
+    get microphoneVolumeLevel(): number;
+    /**
+     * 当前扬声器音量，设备关闭时为0
+     */
+    get speakerVolumeLevel(): number;
+    /**
+     * 当前主房间音频播放是否关闭
+     */
+    get isMainRoomAudioOff(): boolean;
+    get isLocalMirrorEnabled(): boolean;
+    get isLocalEditBeautyOptions(): boolean;
+    get beautyOptions(): FcrBeautyOptions;
+    get enableBeauty(): boolean;
+    get virtualBackgroundName(): string;
+    /**
+     * 音频是否已连接
+     */
+    get isAudioConnected(): boolean;
+    get virtualBackgroundList(): VirtualBackground[];
+    get showForceOpenEffectDialog(): boolean;
+    get speakerDetecting(): boolean;
+    get microphoneDetecting(): boolean;
+    get showCameraPreview(): boolean;
+    get soundEffectList(): Map<string, Record<string, string>>;
+    get beautyKey(): FcrUIBeautyKey;
+    get currentIsMirror(): boolean;
+    get defaultMirror(): boolean;
+    /**
+     * 连接类型
+     */
+    get connectType(): FcrUIConnectType;
+    /**
+     * 设置扬声器音量
+     * @param value
+     */
+    setMicrophoneVolume(value: number): void;
+    /**
+     * 设置扬声器音量
+     * @param value
+     */
+    setSpeakerVolume(value: number): void;
+    enableAudioHiFiMode(enable: boolean): void;
+    enableAudioEchoCancellation(enable: boolean): void;
+    enableAudioStereo(enable: boolean): void;
+    setNoiseLevel(level: FcrAiDenoiseLevel): void;
+    /**
+     * 开关摄像头
+     * @param enable
+     */
+    startOrStopCamera(enable: boolean): void;
+    /**
+     * 设置连接类型
+     * @param type
+     */
+    setConnectType(type: FcrUIConnectType): void;
+    /**
+     * 根据屏幕或窗口ID获取屏幕Track对象
+     * @param id
+     */
+    getScreenTrack(id: string): FcrScreenTrack;
+    /**
+     * 根据声卡采集对象ID获取声卡采集Track对象
+     * @param id
+     */
+    getLoopbackTrack(id: string): FcrLoopbackTrack;
+    /**
+     * 检查当前声卡采集设备已安装（仅对Macos生效）
+     */
+    checkLoopbackDevice(): Promise<number>;
+    /**
+     * 检查当前平台能力支持
+     * @param type
+     */
+    isCapabilitySupported(type: FcrCapability): boolean;
+    /**
+     * 获取屏幕共享窗口列表
+     */
+    getWindowList(): Promise<AgoraRtcWindowInfo[]>;
+    /**
+     * 获取屏幕共享显示器列表
+     */
+    getDisplayList(): Promise<AgoraRtcDisplayInfo[]>;
+    /**
+     * 应用是否有麦克风权限
+     */
+    ifAccessMicrophone(): Promise<boolean>;
+    /**
+     * 应用是否有摄像头权限
+     */
+    ifAccessCamera(): Promise<boolean>;
+    /**
+     * 是否需要自动连接音频（需要自动连接，但是还没连接过）
+     */
+    ifNeedExecuteAutoConnectAudio(): boolean;
+    /**
+     * 是否需要执行连接音频选项（不需要自动连接，且没连接过）
+     */
+    ifNeedExecuteConnectAudioOption(): boolean;
+    /**
+     * 连接音频
+     * @param includeMicrophone
+     */
+    connectAudio(includeMicrophone: boolean): void;
+    /**
+     * 断开音频
+     */
+    disconnectAudio(): void;
+    /**
+     * 需要执行摄像头打开
+     */
+    ifNeedExecuteOpenCamera(): boolean;
+    /**
+     * 设置当前摄像头ID
+     * @param cameraId
+     */
+    setCameraId(cameraId: string): void;
+    /**
+     * 设置当前麦克风ID
+     * @param microphoneId
+     */
+    setMicrophoneId(microphoneId: string): void;
+    /**
+     * 设置当前扬声器ID
+     * @param speakerId
+     */
+    setSpeakerId(speakerId: string): void;
+    downloadUiResources(uiResource?: FcrUIResource): void;
+    /**
+     * 开启或关闭麦克风
+     * @param enable
+     */
+    setMicrophoneEnabled(enable: boolean): void;
+    /**
+     * 开启或关闭摄像头
+     * @param enable
+     */
+    setCameraEnabled(enable: boolean): void;
+    /**
+     * 开始渲染本地摄像头画面
+     * @param view
+     * @param isMirror
+     */
+    startPlayLocalVideo(view: HTMLElement, isMirror?: boolean): void;
+    /**
+     * 停止渲染本地摄像头画面
+     * @param view
+     */
+    stopPlayLocalVideo(view: HTMLElement): void;
+    /**
+     * 顺时针旋转视频
+     */
+    setVideoOrientation(): void;
+    /**
+     * 是否停止主房间音频
+     * @param enable
+     */
+    setMainRoomAudioOff(enable: boolean): void;
+    setBeautyOptions(beautyOption: Partial<FcrBeautyOptions>): void;
+    enableBeautyEffect(enable: boolean): void;
+    toggleLocalMirrorPreview(enable: boolean): void;
+    toggleLocalMirror(enable: boolean): void;
+    enableVirtualBackground(enable: boolean, source?: VirtualBackground): void;
+    setEditBeautyKey(key: BeautyKey): void;
+    /**
+     * 强行开启视频特效
+     */
+    handleForceOpenVideoEffect(): void;
+    handleCancelForceOpenVideoEffect(): void;
+    /**
+     * 开始麦克风检测
+     */
+    startMicrophoneTest(): void;
+    /**
+     * 停止麦克风检测
+     */
+    stopMicrophoneTest(): void;
+    /**
+     * 开启扬声器检测
+     */
+    startSpeakerTest(): void;
+    /**
+     * 停止扬声器检测
+     */
+    stopSpeakerTest(): void;
+    /**
+     * 重制镜像
+     */
+    resetMirror(): void;
+    /**
+     * 设置是否开启镜像
+     * @param enabled
+     */
+    toggleLocalCameraPreview(enabled: boolean): void;
+    addObserver(observer: FcrUIDeviceObserver): void;
+    removeObserver(observer: FcrUIDeviceObserver): void;
+}
+export declare class FcrUIDeviceProviderImpl implements FcrUIDeviceProvider {
+    private _eventProvider;
+    private _mediaControl;
+    private _mediaConfig;
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _observable;
+    private _listeners;
+    private _hasExecutedOpenCamera;
+    private _hasExecutedConnectAudio;
+    private _isAudioConnected;
+    private _cameraVideoTrack?;
+    private _microphoneAudioTrack?;
+    private _localVideoViewSet;
+    private _videoRotation;
+    private _playAudioTimer?;
+    private _isForceEnableBeauty;
+    private _isForceEnableVirtualBackground;
+    private _lastEnableVideoEffectType;
+    private _microphoneObserver;
+    private _defaultMirror;
+    private _volumeIndicationInterval;
+    private accessor _microphoneDeviceId;
+    private accessor _speakerDeviceId;
+    accessor currentIsMirror: boolean;
+    accessor showForceOpenEffectDialog: boolean;
+    accessor cameraId: string;
+    accessor microphoneId: string;
+    accessor speakerId: string;
+    accessor cameraEnabled: boolean;
+    accessor showCameraPreview: boolean;
+    accessor microphoneEnabled: boolean;
+    accessor cameraList: FcrDeviceInfo[];
+    accessor microphoneList: FcrDeviceInfo[];
+    accessor microphoneVolumeLevel: number;
+    accessor speakerList: FcrDeviceInfo[];
+    accessor isLocalMirrorEnabled: boolean;
+    accessor isLocalEditBeautyOptions: boolean;
+    accessor speakerVolumeLevel: number;
+    accessor speakerVolume: number;
+    accessor microphoneVolume: number;
+    accessor virtualBackgroundName: string;
+    accessor enableBeauty: boolean;
+    accessor beautyKey: FcrUIBeautyKey;
+    accessor beautyOptions: FcrBeautyOptions;
+    accessor virtualBackgroundList: VirtualBackground[];
+    accessor soundEffectList: Map<string, Record<string, string>>;
+    accessor microphoneDetecting: boolean;
+    accessor speakerDetecting: boolean;
+    accessor connectType: FcrUIConnectType;
+    accessor isMainRoomAudioOff: boolean;
+    ifAccessMicrophone(): Promise<boolean>;
+    ifAccessCamera(): Promise<boolean>;
+    ifNeedExecuteAutoConnectAudio(): boolean;
+    ifNeedExecuteConnectAudioOption(): boolean;
+    ifNeedExecuteOpenCamera(): boolean;
+    connectAudio(includeMicrophone: boolean): void;
+    disconnectAudio(): void;
+    get defaultMirror(): boolean;
+    get followSystemMicrophoneDevice(): boolean;
+    get followSystemSpeakerDevice(): boolean;
+    get lastEnableVideoEffectType(): FcrUIVideoEffectType;
+    set lastEnableVideoEffectType(type: FcrUIVideoEffectType);
+    get currentDeviceId(): {
+        cameraDeviceId: string;
+        microphoneDeviceId: string;
+        speakerDeviceId: string;
+    };
+    get isAudioConnected(): boolean;
+    constructor(_eventProvider: FcrUIEventProvider, _mediaControl: FcrDesktopMediaControl, _mediaConfig: FcrUIMediaConfig);
+    getScreenTrack(id: string): FcrScreenTrack;
+    getLoopbackTrack(id: string): FcrLoopbackTrack;
+    checkLoopbackDevice(): Promise<number>;
+    isCapabilitySupported(type: FcrCapability): boolean;
+    getWindowList(): Promise<AgoraRtcWindowInfo[]>;
+    getDisplayList(): Promise<AgoraRtcDisplayInfo[]>;
+    get cameraTrack(): FcrCameraTrack;
+    get microphoneTrack(): FcrMicrophoneTrack;
+    init(): Promise<[PromiseSettledResult<void>, PromiseSettledResult<void>, PromiseSettledResult<void>]>;
+    addObserver(observer: FcrUIDeviceObserver): void;
+    removeObserver(observer: FcrUIDeviceObserver): void;
+    startPlayLocalVideo(view: HTMLElement, isMirror?: boolean): void;
+    stopPlayLocalVideo(view: HTMLElement): void;
+    startSpeakerTest(): void;
+    stopSpeakerTest(): void;
+    setCurrentIsMirror(isMirror: boolean): void;
+    toggleLocalMirrorPreview(mirror: boolean): void;
+    setBeautyOptions(beautyOption: Partial<FcrBeautyOptions>): void;
+    handleCancelForceOpenVideoEffect(): void;
+    handleForceOpenVideoEffect(): void;
+    setVideoOrientation(): void;
+    setCameraEnabled(enable: boolean): void;
+    setMicrophoneEnabled(enable: boolean): void;
+    toggleLocalMirror(enable: boolean): void;
+    resetMirror(): void;
+    startMicrophoneTest(): void;
+    stopMicrophoneTest(): void;
+    enableVirtualBackground(enable: boolean, source?: VirtualBackground): void;
+    setEditBeautyKey(key: FcrUIBeautyKey): void;
+    enableBeautyEffect(enable: boolean): void;
+    enableAudioHiFiMode(enable: boolean): void;
+    enableAudioEchoCancellation(enable: boolean): void;
+    enableAudioStereo(enable: boolean): void;
+    setNoiseLevel(level: FcrAiDenoiseLevel): void;
+    setCameraId(cameraId: string): void;
+    setSpeakerId(speakerId: string): Promise<void>;
+    setMicrophoneId(microphoneId: string): Promise<void>;
+    setSpeakerVolume(value: number): void;
+    setMicrophoneVolume(value: number): void;
+    startOrStopCamera(enable: boolean): void;
+    setShowCameraPreview(enable: boolean): void;
+    downloadUiResources(uiResource?: FcrUIResource): Promise<void>;
+    release(): void;
+    private _fileToUiData;
+    setConnectType(connectType: FcrUIConnectType): void;
+    private _fetchZipAndUnzip;
+    private _updateVirtualBackgroundList;
+    private _handleSpeakerTestVolumeIndicationUpdated;
+    private _handleSpeakerVolumeUpdated;
+    private _handleMicrophoneVolumeIndicationUpdated;
+    private _handleCameraChanged;
+    toggleLocalCameraPreview(enabled: boolean): void;
+    private _handleCameraListUpdated;
+    private _handleMicrophoneAdded;
+    private _handleMicrophoneRemoved;
+    private _handleMicrophoneListUpdated;
+    /**
+     * 某些情况下需要重新创建 Track，比如：
+     * 1.浏览器中耳机插入，可能导致系统默认设备变更，此时应该重新创建 track
+     * 2.客户端中，系统默认设备变更时，并不会有回调发生，但是需要在下次开启或关闭设备时纠正当前系统设备ID
+     */
+    private _refreshMicrophoneTrack;
+    private _handleSpeakerAdded;
+    private _handleSpeakerRemoved;
+    private _handleSpeakerListUpdated;
+    private _getMicrophoneList;
+    private _getSpeakerList;
+    setMainRoomAudioOff(enable: boolean): void;
+}