fcr-ui-scene 1.0.40 → 3.1.0-1

package/lib/modules/setting/store.d.ts

@@ -0,0 +1,213 @@
+/// <reference types="node" />
+import { FcrDesktopMediaControl, FcrMainRoomControl, FcrMonitorControl, FcrStreamControl } from 'agora-edu-core';
+import { FcrBeautyOptions } from 'agora-edu-core/lib/media-control/type';
+import { FcrAiDenoiseLevel, FcrPerformanceInfo } from 'agora-edu-core/lib/type';
+import { AgoraRtcNetworkStats } from 'agora-rte-sdk';
+import { FcrUIEventStore } from '../../common/event-store';
+import { HighlightElement } from '../../utilities/constant';
+import { DEFAULT_BEAUTY_VALUE } from 'agora-ui-foundation/lib/components/local-video-player';
+import { FcrUISceneConfig } from '../../type';
+import { VirtualBackground } from '../device-pretest/assets/virtual-backdound-resources';
+import { FcrDeviceStore } from '../../common/device-store';
+export interface DeviceItem {
+    text: string;
+    value: string;
+}
+export declare enum DeviceSettingTab {
+    GENERAL = "general",
+    AUDIO = "audio",
+    VIDEO = "video",
+    STORAGE = "storage",
+    STATE = "state"
+}
+export type VideoActiveTab = 'basic' | 'virtual-background' | 'beauty-filter';
+export interface DeviceSettingDialogConfig {
+    activeTab: DeviceSettingTab;
+    highlightSelector: HighlightElement | undefined;
+    videoActiveTab: VideoActiveTab;
+}
+export interface CustomSetting {
+    shouldTurnOffVideo: boolean;
+    shouldDisplayPreviewDialog: boolean;
+    shouldHideNonVideoParticipants: boolean;
+    displayedMaxAttendees: number;
+    autoAdjustmentSpeakerVolume: boolean;
+    autoAdjustmentMicrophoneVolume: boolean;
+    noiseReduce: FcrAiDenoiseLevel;
+    recordingPath: string;
+    videoHD: boolean;
+    videoLowLight: boolean;
+    hardwareForReception: boolean;
+    videoNoise: boolean;
+    audioHiFi: boolean;
+    audioEchoCancellation: boolean;
+    audioStereo: boolean;
+    audioVoiceChanger: boolean;
+    spotlightEnabled: boolean;
+}
+export interface StoreConfig {
+    userName: string;
+}
+export { DEFAULT_BEAUTY_VALUE };
+export type BeautyKey = 'none' | 'smoothnessLevel' | 'lighteningLevel' | 'lighteningLevel';
+export default class SettingStore {
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _disposers;
+    private _currentDialogId;
+    private _mediaControl;
+    private _monitorControl;
+    private _streamControl;
+    private _roomControl;
+    private _uiEventStore;
+    private _deviceStore;
+    private _videoView4Setting?;
+    private _settingVideoOpened;
+    private _deviceStoreObserver;
+    private _streamVolumeMap;
+    private _audioDeviceVolumeRefreshTask?;
+    private _volumeIndicationInterval;
+    private _cameraTrack?;
+    private _useDefaultAudioEchoCancellation;
+    accessor loudestStreamVolumeLevel: number;
+    accessor microphoneVolumeLevel: number;
+    accessor isWifiConnected: boolean;
+    accessor dialogConfig: DeviceSettingDialogConfig;
+    accessor networkState: AgoraRtcNetworkStats;
+    accessor performanceState: FcrPerformanceInfo & {
+        cpuOtherAppUsage: number;
+        memoryOtherAppUsageRatio: number;
+        memoryOtherAppUsageInKbytes: number;
+    };
+    accessor localAudioStreamMap: Map<string, import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcLocalAudioStats>;
+    accessor remoteAudioStreamMap: Map<string, import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcRemoteAudioStats>;
+    accessor localVideoStreamMap: Map<string, import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcLocalTrackStats & {
+        sendFrameRate: number;
+        dimensions: import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcDimensions;
+        frameRate: number;
+        bitrate: number;
+    } & {
+        isScreenStream: boolean;
+    }>;
+    accessor remoteVideoStreamMap: Map<string, import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcRemoteTrackStats & {
+        dimensions: import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcDimensions;
+        frameRate: number;
+    } & {
+        isScreenStream: boolean;
+    }>;
+    accessor systemMemorySize: number;
+    accessor systemCpuDesc: string;
+    accessor setting: CustomSetting;
+    accessor config: FcrUISceneConfig | undefined;
+    accessor getSystemInfoTimer: NodeJS.Timeout | null;
+    get maxVideoSendInfo(): (import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcLocalTrackStats & {
+        sendFrameRate: number;
+        dimensions: import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcDimensions;
+        frameRate: number;
+        bitrate: number;
+    } & {
+        isScreenStream: boolean;
+    }) | null;
+    get maxVideoReceiveInfo(): (import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcRemoteTrackStats & {
+        dimensions: import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcDimensions;
+        frameRate: number;
+    } & {
+        isScreenStream: boolean;
+    }) | null;
+    get sendScreenShareInfo(): (import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcLocalTrackStats & {
+        sendFrameRate: number;
+        dimensions: import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcDimensions;
+        frameRate: number;
+        bitrate: number;
+    } & {
+        isScreenStream: boolean;
+    }) | null;
+    get receiveScreenShareInfo(): (import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcRemoteTrackStats & {
+        dimensions: import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcDimensions;
+        frameRate: number;
+    } & {
+        isScreenStream: boolean;
+    }) | null;
+    get microphoneVolumeDb(): string;
+    get speakerVolumeDb(): string;
+    get speakerTestVolumeLevel(): number;
+    get microphoneTestVolumeLevel(): number;
+    get speakerVolume(): number;
+    get microphoneVolume(): number;
+    get isLocalMirrorEnabled(): boolean;
+    get isLocalEditBeautyOptions(): boolean;
+    get currentBeautyKey(): import("../../common/device-store").BeautyKey;
+    get beautyOptions(): import("agora-rte-sdk/lib/core/rtc/type").AgoraRtcBeautyOptions;
+    get cameraDeviceId(): string;
+    get cameraEnabled(): boolean;
+    get showForceOpenEffectDialog(): boolean;
+    get currentVirtualBackgroundName(): string;
+    get cameraDeviceList(): DeviceItem[];
+    get microphoneDeviceId(): string;
+    get speakerDeviceId(): string;
+    get speakerDeviceList(): DeviceItem[];
+    get microphoneDeviceList(): DeviceItem[];
+    get enableBeauty(): boolean;
+    get virtualBackgroundList(): VirtualBackground[];
+    get currentIsMirror(): boolean;
+    get microphoneDetecting(): boolean;
+    get speakerDetecting(): boolean;
+    constructor({ mediaControl, config, uiEventStore, deviceStore, monitorControl, streamControl, roomControl, }: {
+        mediaControl: FcrDesktopMediaControl;
+        config: FcrUISceneConfig;
+        uiEventStore: FcrUIEventStore;
+        monitorControl: FcrMonitorControl;
+        streamControl: FcrStreamControl;
+        roomControl: FcrMainRoomControl;
+        deviceStore: FcrDeviceStore;
+    });
+    enableVirtualBackground(enable: boolean, source?: VirtualBackground): void;
+    setEditBeautyKey(key: BeautyKey): void;
+    enableBeautyEffect(enable: boolean): void;
+    private _initReactions;
+    private _disposeReactions;
+    setCameraDevice(id: string): void;
+    setMicrophoneDevice(deviceId: string): void;
+    stopSpeakerTest(): void;
+    startSpeakerTest(): void;
+    setSpeakerDevice(deviceId: string): void;
+    setSpeakerVolume(value: number): void;
+    setMicrophoneVolume(value: number): void;
+    setVideoOrientation(): void;
+    setBeautyOptions(beautyOption: Partial<FcrBeautyOptions>): void;
+    toggleLocalMirrorPreview(isMirror: boolean): void;
+    startVideo(isMirror: boolean, view?: HTMLDivElement | undefined): void;
+    stopVideo(): void;
+    handleForceOpenVideoEffect(): void;
+    handleCancelForceOpenVideoEffect(): void;
+    toggleLocalMirror(enable: boolean): void;
+    setSettingVideoOpened(opened: boolean): void;
+    _syncSystemInfo(): Promise<void>;
+    private _enableVideoHd;
+    private _enableLowlightEnhancement;
+    private _enableVideoDenoiser;
+    private _enableHardwareForReception;
+    startCameraTest(): void;
+    stopCameraTest(): void;
+    startMicrophoneTest(): void;
+    stopMicrophoneTest(): void;
+    release(): void;
+    setDialogConfig(dialogConfig: Partial<DeviceSettingDialogConfig>): void;
+    setSetting(setting: Partial<CustomSetting>): void;
+    private _onEvent;
+    private _onNetworkStatsUpdated;
+    calculateSystemInfo(): Promise<void>;
+    getSystemInformation(): void;
+    clearGetSystemInfoInterval(): void;
+    closeDialog(): void;
+    private _onLocalAudioStatsUpdated;
+    private _onRemoteAudioStatsUpdated;
+    private _onLocalVideoStatsUpdated;
+    private _onRemoteVideoStatsUpdated;
+    private _onStreamsUpdated;
+    private _onStreamsRemoved;
+    private _onPerformanceUpdated;
+    private _handleCameraChanged;
+    private _handleCameraListUpdated;
+    private _onAudioVolumeUpdated;
+    private _preHandleSetting;
+}