fcr-ui-scene 3.4.1 → 3.4.3

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

@@ -3,87 +3,227 @@ 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, FcrUIDeviceItem, FcrUIDeviceObserver, FcrUIMediaConfig } from '../type';
+import { FcrUIVideoEffectType, FcrUIBeautyKey, FcrUIConnectType, FcrUIResource, FcrUIDeviceObserver, FcrUIMediaConfig } from '../type';
 import { FcrUIEventProvider } from './event-provider';
-import { BeautyKey, DeviceItem } from '../modules/setting/store';
+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 screenTrack(): FcrCameraTrack | null;
+    /**
+     * 当前是否开启了摄像头
+     */
     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 cameraList(): FcrDeviceInfo[];
-    get microphoneList(): FcrDeviceInfo[];
-    get speakerList(): FcrDeviceInfo[];
-    get speakerVolume(): number;
+    /**
+     * 音频是否已连接
+     */
     get isAudioConnected(): boolean;
     get virtualBackgroundList(): VirtualBackground[];
-    get microphoneVolumeLevel(): number;
     get showForceOpenEffectDialog(): boolean;
-    get speakerVolumeLevel(): number;
-    get cameraDeviceList(): DeviceItem[];
-    get speakerDeviceList(): DeviceItem[];
-    get microphoneDeviceList(): DeviceItem[];
     get speakerDetecting(): boolean;
     get microphoneDetecting(): boolean;
     get showCameraPreview(): boolean;
     get soundEffectList(): Map<string, Record<string, string>>;
     get beautyKey(): FcrUIBeautyKey;
-    get microphoneVolume(): number;
     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;
-    checkLoopbackDevice(): Promise<number>;
+    /**
+     * 根据声卡采集对象ID获取声卡采集Track对象
+     * @param id
+     */
     getLoopbackTrack(id: string): FcrLoopbackTrack;
+    /**
+     * 检查当前声卡采集设备已安装（仅对Macos生效）
+     */
+    checkLoopbackDevice(): Promise<number>;
+    /**
+     * 检查当前平台能力支持
+     * @param type
+     */
     isCapabilitySupported(type: FcrCapability): boolean;
+    /**
+     * 获取屏幕共享窗口列表
+     */
     getWindowList(): Promise<AgoraRtcWindowInfo[]>;
+    /**
+     * 获取屏幕共享显示器列表
+     */
     getDisplayList(): Promise<AgoraRtcDisplayInfo[]>;
-    stopAudioByComputer(): void;
+    /**
+     * 应用是否有麦克风权限
+     */
     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;
-    actionsBeforeJoin(): void;
-    joinAudioByComputer(): Promise<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;
-    addObserver(observer: FcrUIDeviceObserver): void;
-    removeObserver(observer: FcrUIDeviceObserver): void;
+    /**
+     * 顺时针旋转视频
+     */
     setVideoOrientation(): void;
-    removeObserver(observer: FcrUIDeviceObserver): void;
-    setAudioConnected(enable: boolean): void;
+    /**
+     * 是否停止主房间音频
+     * @param enable
+     */
     setMainRoomAudioOff(enable: boolean): void;
     setBeautyOptions(beautyOption: Partial<FcrBeautyOptions>): void;
     enableBeautyEffect(enable: boolean): void;
@@ -91,17 +231,38 @@ export interface FcrUIDeviceProvider {
     toggleLocalMirror(enable: boolean): void;
     enableVirtualBackground(enable: boolean, source?: VirtualBackground): void;
     setEditBeautyKey(key: BeautyKey): void;
+    /**
+     * 强行开启视频特效
+     */
     handleForceOpenVideoEffect(): void;
     handleCancelForceOpenVideoEffect(): void;
-    stopMicrophoneTest(): void;
+    /**
+     * 开始麦克风检测
+     */
     startMicrophoneTest(): void;
-    stopSpeakerTest(): void;
+    /**
+     * 停止麦克风检测
+     */
+    stopMicrophoneTest(): void;
+    /**
+     * 开启扬声器检测
+     */
     startSpeakerTest(): void;
-    setSpeakerVolume(value: number): void;
-    setSelectedSpeakerVolume(volume: number): void;
-    handleRealCameraEnabledChanged(enable: boolean): void;
-    handleCameraChanged(enable: boolean): 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;
@@ -124,8 +285,6 @@ export declare class FcrUIDeviceProviderImpl implements FcrUIDeviceProvider {
     private _microphoneObserver;
     private _defaultMirror;
     private _volumeIndicationInterval;
-    private _microponeInitCount;
-    private _speakerInitCount;
     private accessor _microphoneDeviceId;
     private accessor _speakerDeviceId;
     accessor currentIsMirror: boolean;
@@ -154,9 +313,7 @@ export declare class FcrUIDeviceProviderImpl implements FcrUIDeviceProvider {
     accessor microphoneDetecting: boolean;
     accessor speakerDetecting: boolean;
     accessor connectType: FcrUIConnectType;
-    accessor isAudioConnected: boolean;
     accessor isMainRoomAudioOff: boolean;
-    toggleCameraVideoOrientation(): void;
     ifAccessMicrophone(): Promise<boolean>;
     ifAccessCamera(): Promise<boolean>;
     ifNeedExecuteAutoConnectAudio(): boolean;
@@ -167,9 +324,6 @@ export declare class FcrUIDeviceProviderImpl implements FcrUIDeviceProvider {
     get defaultMirror(): boolean;
     get followSystemMicrophoneDevice(): boolean;
     get followSystemSpeakerDevice(): boolean;
-    get cameraDeviceList(): FcrUIDeviceItem[];
-    get microphoneDeviceList(): FcrUIDeviceItem[];
-    get speakerDeviceList(): FcrUIDeviceItem[];
     get lastEnableVideoEffectType(): FcrUIVideoEffectType;
     set lastEnableVideoEffectType(type: FcrUIVideoEffectType);
     get currentDeviceId(): {
@@ -177,20 +331,17 @@ export declare class FcrUIDeviceProviderImpl implements FcrUIDeviceProvider {
         microphoneDeviceId: string;
         speakerDeviceId: string;
     };
+    get isAudioConnected(): boolean;
     constructor(_eventProvider: FcrUIEventProvider, _mediaControl: FcrDesktopMediaControl, _mediaConfig: FcrUIMediaConfig);
-    getCameraTrack(deviceId: string): FcrCameraTrack;
-    getMicrophoneTrack(deviceId: string): FcrMicrophoneTrack;
     getScreenTrack(id: string): FcrScreenTrack;
     getLoopbackTrack(id: string): FcrLoopbackTrack;
     checkLoopbackDevice(): Promise<number>;
     isCapabilitySupported(type: FcrCapability): boolean;
     getWindowList(): Promise<AgoraRtcWindowInfo[]>;
     getDisplayList(): Promise<AgoraRtcDisplayInfo[]>;
-    get screenTrack(): FcrCameraTrack | null;
     get cameraTrack(): FcrCameraTrack;
     get microphoneTrack(): FcrMicrophoneTrack;
-    setSelectedSpeakerVolume(volume: number): void;
-    init(): Promise<void>;
+    init(): Promise<[PromiseSettledResult<void>, PromiseSettledResult<void>, PromiseSettledResult<void>]>;
     addObserver(observer: FcrUIDeviceObserver): void;
     removeObserver(observer: FcrUIDeviceObserver): void;
     startPlayLocalVideo(view: HTMLElement, isMirror?: boolean): void;
@@ -221,15 +372,10 @@ export declare class FcrUIDeviceProviderImpl implements FcrUIDeviceProvider {
     setMicrophoneId(microphoneId: string): Promise<void>;
     setSpeakerVolume(value: number): void;
     setMicrophoneVolume(value: number): void;
-    actionsBeforeJoin(): void;
     startOrStopCamera(enable: boolean): void;
     setShowCameraPreview(enable: boolean): void;
-    handleRealCameraEnabledChanged(realEnable: boolean): void;
-    handleCameraChanged(enabled: boolean): void;
     downloadUiResources(uiResource?: FcrUIResource): Promise<void>;
     release(): void;
-    joinAudioByComputer(): Promise<void>;
-    stopAudioByComputer(): void;
     private _fileToUiData;
     setConnectType(connectType: FcrUIConnectType): void;
     private _fetchZipAndUnzip;
@@ -238,9 +384,21 @@ export declare class FcrUIDeviceProviderImpl implements FcrUIDeviceProvider {
     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;
-    setAudioConnected(enable: boolean): void;
+    private _getMicrophoneList;
+    private _getSpeakerList;
     setMainRoomAudioOff(enable: boolean): void;
 }