fcr-ui-scene 3.7.6 → 3.7.7

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

@@ -0,0 +1,222 @@
+import { FcrPrivilegeUserRole } from 'fcr-core';
+import { FcrUserInfo, FcrUserRole } from 'fcr-core/lib/type';
+import { ParticipantActionType } from 'agora-ui-foundation/lib/components/participants/attendee';
+import { FcrUIPrivilegeProvider } from '../../providers/privilege-provider';
+import { FcrUIDialogKey, FcrUIRoomControlType } from '../../utilities/constant';
+import { FcrUIDeviceStreamProvider } from '../../providers/device-stream-provider';
+import { FcrUIMemberData, OperateWaitingRoomMemberDialogProps, OpenMuteAllDialogProps } from './type';
+import { FcrUserKickedOutType } from 'fcr-core/lib/room-control/user-control/type';
+import { FcrMainRoomControl } from 'fcr-core/lib/room-control/type';
+import { FcrLanguage } from 'fcr-core/lib/room-control/interpreter-control/types';
+import { ConfirmContentProps } from 'agora-ui-foundation/lib/components/confirm-content';
+import { FcrUIRoomType } from '../../type';
+import { FcrUIEventProvider } from '../../providers/event-provider';
+import { FcrUIDeviceProvider } from '../../providers/device-provider';
+import { FcrUISessionProvider } from '../../providers/session-provider';
+import { FcrUIRoomProvider } from '../../providers/room-provider';
+import { FcrUISharedSpeakerSpotlightDataSource } from '../../shared-data-source/speaker-spotlight';
+import { FcrUISharedPinDataSource } from '../../shared-data-source/pin-data';
+import { FcrUISharedLayoutDataSource } from '../../shared-data-source/layout-data';
+import { FcrUISharedInterpreterDataSource } from '../../shared-data-source/interpreter';
+import { FcrUISharedSettingDataSource } from '../../shared-data-source/setting';
+import { FcrUISharedWaitingRoomDataSource } from '../../shared-data-source/waiting-room';
+import { FcrUIChatProvider } from '../../providers/chat-provider';
+import { FcrUIVideoWindowDataSource } from '../../shared-data-source/video-window';
+import { FcrUIMemberSharedDataSource } from '../../shared-data-source/member-data';
+import { FcrUISharedChatDataSource } from '../../shared-data-source/chat-data';
+import { FcrUIDialogProvider } from '../../providers/dialog-provider';
+import { FcrUIMessageProvider } from '../../providers/message-provider';
+import { FcrUIAbilityProviderImpl } from '../../providers/ability-provider';
+import { FcrUISecuritySharedDataSource } from '../../shared-data-source/security-data';
+import { FcrUIScreenShareSharedDataSource } from '../../shared-data-source/screen-share-data';
+import { User } from './components/participants/types';
+import { FcrUIMultiDisplayProvider } from '../../providers/multi-display-provider';
+export default class ParticipantStore {
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _roomStore;
+    private _chatProvider;
+    private _roomControl;
+    private _streamControl;
+    private _userControl;
+    private _waitingRoomControl?;
+    private _waitingRoomUserControl?;
+    private _peerSessionControl;
+    private _disposers;
+    private _dialogId?;
+    private _changeNameDialogKey;
+    private _deviceStore;
+    private _deviceStreamStore;
+    private _unmuteAudioTimestamp;
+    private _unmuteVideoTimestamp;
+    private _processedUserOpenDeviceRequests;
+    private _securityStore;
+    private _uiEventStore;
+    private _sharedSpeakerSpotlightDataSource;
+    private _sharedPinDataSource;
+    private _sharedLayoutDataSource;
+    private _sharedInterpreterDataSource;
+    private _sharedVideoWindowDataSource;
+    private _sharedWaitingRoomDataSource;
+    private _sharedMemberDataSource;
+    private _sharedChatDataSource;
+    private _sharedScreenShareSharedDataSource;
+    private _multiDisplayProvider;
+    private _peerSessionObserver;
+    private _dialogProvider;
+    private _abilityProvider;
+    private _messageProvider;
+    private _roomStoreObserver;
+    private _privilegeControlObserver;
+    private _userObserver;
+    private _eventObserver;
+    private _whitebaordObderver;
+    private _sharedSettingDataSource;
+    private _sharedSecuritySharedDataSource;
+    private _operatorRenameUserId;
+    private _operatorRenameUserName;
+    private accessor _mainList;
+    private accessor _isChecked;
+    accessor _participantsWindowActive: boolean;
+    accessor enableParticipantsJoinWithMute: boolean;
+    accessor searchText: string;
+    accessor currentModal: 'modal' | 'window';
+    accessor mergeConfirmDialog: boolean;
+    accessor mergeUserId: string;
+    accessor activeTab: FcrUIRoomType;
+    accessor interpreterInputLanguageList: {
+        userId: string;
+        language: FcrLanguage;
+    }[];
+    accessor newName: string;
+    accessor allowUnmute: boolean;
+    accessor joinWithMuteAudio: boolean;
+    accessor showBecomeHostButton: boolean;
+    get operatorRenameUserName(): string;
+    get audioVolumeMap(): Map<string, number>;
+    get localUser(): FcrUserInfo;
+    get localUserRole(): FcrUserRole;
+    get isLocalUserHost(): boolean;
+    get enableSpotlight(): boolean;
+    get screenSharingOwner(): FcrUserInfo | undefined;
+    get userListSource(): import("./member-list-data-source").FcrUIMemberDataImpl[];
+    get spotlightStreamId(): string;
+    get mergeUserInfo(): FcrUserInfo | undefined;
+    get userMap(): Map<string, FcrUIMemberData>;
+    get allowUnmuteSelfAudio(): boolean;
+    get allowJoinWithMuteAudio(): boolean;
+    get allowUnmuteSelfVideo(): boolean;
+    get isLockRoomEnabled(): boolean;
+    get isWaitingRoomEnabled(): boolean;
+    get allowChangeSelfName(): boolean;
+    get pinedStreamIds(): string[];
+    get hasPinnedStream(): boolean;
+    get userList(): User[];
+    get localMicVolume(): number;
+    get hasRevokeHostPermission(): boolean;
+    get interpreterUserList(): import("fcr-core/lib/room-control/interpreter-control/types").FcrInterpreterUserInfo[] | null;
+    get isInterpreterEnabled(): boolean;
+    get waitingRoomUserCount(): number;
+    get isNewWaitingRoomUserEnter(): boolean;
+    get isLocalCameraInSecondaryWindow(): boolean;
+    get isHostKeyEnabled(): boolean;
+    get hasInvite(): boolean;
+    get checkedStateMap(): import("../../shared-data-source/security-data").FcrSecurityCheckedStateType;
+    constructor({ roomControl, securityStore, uiEventStore, deviceStore, deviceStreamStore, roomStore, sessionProvider, sharedSpeakerSpotlightDataSource, sharedPinDataSource, sharedLayoutDataSource, sharedInterpreterDataSource, sharedSettingDataSource, sharedWaitingRoomDataSource, chatProvider, sharedVideoWindowDataSource, sharedMemberDataSource, sharedChatDataSource, dialogProvider, abilityProvider, messageProvider, sharedSecuritySharedDataSource, sharedScreenShareSharedDataSource, multiDisplayProvider, }: {
+        roomControl: FcrMainRoomControl;
+        securityStore: FcrUIPrivilegeProvider;
+        uiEventStore: FcrUIEventProvider;
+        deviceStore: FcrUIDeviceProvider;
+        deviceStreamStore: FcrUIDeviceStreamProvider;
+        sessionProvider: FcrUISessionProvider;
+        roomStore: FcrUIRoomProvider;
+        sharedSpeakerSpotlightDataSource: FcrUISharedSpeakerSpotlightDataSource;
+        sharedPinDataSource: FcrUISharedPinDataSource;
+        sharedLayoutDataSource: FcrUISharedLayoutDataSource;
+        sharedInterpreterDataSource: FcrUISharedInterpreterDataSource;
+        sharedSettingDataSource: FcrUISharedSettingDataSource;
+        sharedWaitingRoomDataSource: FcrUISharedWaitingRoomDataSource;
+        chatProvider: FcrUIChatProvider;
+        sharedVideoWindowDataSource: FcrUIVideoWindowDataSource;
+        sharedMemberDataSource: FcrUIMemberSharedDataSource;
+        sharedChatDataSource: FcrUISharedChatDataSource;
+        dialogProvider: FcrUIDialogProvider;
+        abilityProvider: FcrUIAbilityProviderImpl;
+        messageProvider: FcrUIMessageProvider;
+        sharedSecuritySharedDataSource: FcrUISecuritySharedDataSource;
+        sharedScreenShareSharedDataSource: FcrUIScreenShareSharedDataSource;
+        multiDisplayProvider: FcrUIMultiDisplayProvider;
+    });
+    release(): void;
+    allowedOperations: (userId: string, userRole: FcrUserRole) => string[];
+    checkIsPin: (userId: string) => boolean;
+    hasMutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasWaitingRoomPermission(): boolean;
+    hasUnmutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    hasRequestStartAudioPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
+    setCurrentModal(modal: 'modal' | 'window'): void;
+    closeParticipantsAside(): void;
+    openParticipantsWindow(): void;
+    closeParticipantsWindow(): void;
+    openDialog(): void;
+    openConfirmDialog(params: ConfirmContentProps, id?: string): string;
+    setParticipantsWindowActive(active: boolean): void;
+    handlerSearchUser(searchText: string): void;
+    onInvite(): void;
+    setMergeConfirmDialog(visible: boolean): void;
+    mergeConfirmDialogOk(userId: string): void;
+    removePin(userId: string): void;
+    addPin(userId: string): void;
+    getAllowedOperations: (targetRole: FcrUserRole, isSelf: boolean) => string[];
+    closeRemoveAdmitWaitingRoomDialog(dialogKey: FcrUIDialogKey): void;
+    openRemoveAdmitWaitingRoomDialog(params: OperateWaitingRoomMemberDialogProps): void;
+    setAllowUnmute(checked: boolean): void;
+    setAllowJoinWithMuteAudio(checked: boolean): void;
+    openMuteAllDialog(params: OpenMuteAllDialogProps): void;
+    isHostSupported(userId: string): boolean;
+    handlerUserAction(action: ParticipantActionType, userId: string): void;
+    private _getPinStreamIdFromUser;
+    private _handleUserPropertiesUpdated;
+    private _handleRemoteUsersJoined;
+    private _handleUserInfoUpdated;
+    handleConfirmChangeName(): Promise<void>;
+    handleCancelChangeName(): void;
+    private _openChangeNameDialog;
+    private _closeChangeNameDialog;
+    private _moveToWaitingRoomByUserIds;
+    removeWaitingRoomUser(userId: string, type: FcrUserKickedOutType): void;
+    kickOutWaitingRoomAllMember(type: FcrUserKickedOutType): Promise<void>;
+    moveToMainRoomAllMember(): Promise<void>;
+    getMicStreamVolume(streamId: string): number;
+    handlerRoomControlAction(action: FcrUIRoomControlType, data?: any): void;
+    private _handleEvent;
+    moveToMainRoomByUserIds(userId: string[]): void;
+    handleActiveTab(tab: FcrUIRoomType): void;
+    private _formatUser;
+    private _muteUserAudio;
+    private _unmuteUserAudio;
+    private _muteUserVideo;
+    private _unmuteUserVideo;
+    private _privateChat;
+    private _kickOutUser;
+    private _handleSetHostOrCoHost;
+    private _setAsHost;
+    private _setAsCoHost;
+    private _setAsAttendee;
+    private _muteAllAudio;
+    private _unmuteAllAudio;
+    private _enableSelfUnmute;
+    private _enableOpenVideo;
+    private _revokeHost;
+    private _playJoinLeaveSound;
+    private _lockRoom;
+    private _enableRename;
+    private enableJoinWithMuteAudio;
+    private _onPeerSessionReceived;
+    private _onPeerSessionAccepted;
+    private _onPeerSessionRejected;
+    private _updateSessionTimestamp;
+    private _getOutputLanguage;
+    private _checkCreatorInfo;
+    private _revokeHostByTicket;
+}
+export declare const StoreContext: import("react").Context<ParticipantStore>;