fcr-ui-scene 3.1.1 → 3.3.0

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

@@ -1,15 +1,15 @@
-/// <reference types="react" />
-import { FcrDesktopMediaControl, FcrStreamControl, FcrUserControl } from 'agora-edu-core';
-import { FcrChatRoomConnectionState, FcrPrivilegeUserRole, FcrUserInfo, FcrUserRole, FcrUserUpdatedEvent } from 'agora-edu-core/lib/type';
+import { FcrDesktopMediaControl, FcrPrivilegeControl, FcrPrivilegeUserRole, FcrStreamControl, FcrUserControl } from 'agora-edu-core';
+import { FcrUserInfo, FcrUserRole } from 'agora-edu-core/lib/type';
 import { FcrVideoWindowPreviewType } from '../video-window/type';
 import { FcrDeviceStore } from '../../common/device-store';
 import { FcrUIEventObserver, FcrUIEventStore, FcrUISetMainSpeakerParams, FcrUIToggleLayoutParams, FcrUIToggleLayoutSizeParams, FcrUIUpdateAsideParams } from '../../common/event-store';
 import { FcrSecurityStore } from '../../common/security-store';
 import { UIAction } from '../../utilities/constant';
 import { FcrUIVideoWindowData, FcrUIVideoWindowLayoutType, GalleryMaxSize } from './type';
-import { FcrChatRoomControl } from 'agora-edu-core/lib/room-control/chatroom-control';
-import { WhiteboardControlbarEvents } from '../whiteboard/type';
 import { FcrWhiteboardControl } from 'agora-edu-core/lib/room-control/whiteboard-control/types';
+import { FcrChatRoomConnectionState, FcrChatRoomControl } from 'agora-edu-core/lib/room-control/chatroom-control/type';
+import { FcrUserUpdatedEvent } from 'agora-edu-core/lib/room-control/user-control/type';
+import { FcrBaseRoomControl } from 'agora-edu-core/lib/room-control/type';
 export interface FcrLayoutSlots {
     participant: React.ReactNode;
     chat: React.ReactNode;
@@ -32,11 +32,31 @@ export interface LayoutStoreParams {
     securityStore: FcrSecurityStore;
     chatRoomControl: FcrChatRoomControl;
     whiteBoardControl: FcrWhiteboardControl;
+    privilegeControl: FcrPrivilegeControl;
+    roomControl: FcrBaseRoomControl;
 }
 export default class LayoutStore implements FcrLayoutSlots, FcrUIEventObserver {
-    private _videoWindowDataSource;
     private readonly logger;
     private static MIN_USERS_TO_ENABLE_SPOTLIGHT;
+    private _videoWindowDataSource;
+    private _deviceStore;
+    private _privilegeControl;
+    private _uiEventStore;
+    private _userControl;
+    private _streamControl;
+    private _securityStore;
+    private _whiteBoardControl;
+    private _localView;
+    private _subscriptions;
+    private _barLockTimer;
+    private _chatRoomControl;
+    private _waitingRoomControl?;
+    private _waitingRoomUserControl?;
+    private _liveStreamState;
+    private _chatRoomObserver;
+    private _waitingRoomUserObserver;
+    private _waitingRoomObserver;
+    private _managerRoleUpdateForToast;
     accessor participant: React.ReactNode;
     accessor chat: React.ReactNode;
     accessor chatAction: React.ReactNode;
@@ -60,25 +80,16 @@ export default class LayoutStore implements FcrLayoutSlots, FcrUIEventObserver {
     accessor spotlightStreamId: string;
     accessor shouldHideNonVideoParticipants: boolean;
     accessor participantCount: number;
-    accessor ownerUser: FcrUserInfo | null;
+    accessor ownerUser: FcrUserInfo | undefined;
     accessor localUser: FcrUserInfo;
-    accessor documentVisible: boolean;
     accessor enableSpotlight: boolean;
-    private _deviceStore;
-    private _uiEventStore;
-    private _userControl;
-    private _streamControl;
-    private _securityStore;
-    private _whiteBoardControl;
-    private _localView;
-    private _subscriptions;
-    private _barLockTimer;
-    private _chatRoomControl;
-    private _chatRoomObserver;
-    private _managerRoleUpdateForToast;
+    accessor isWaitingRoomNotify: boolean;
     get deviceStore(): FcrDeviceStore;
     get streamControl(): FcrStreamControl;
+    get isWaterMarkEnabled(): boolean;
+    get isMulti(): boolean;
     get layout(): FcrUIVideoWindowLayoutType;
+    get manualLayout(): FcrUIVideoWindowLayoutType | undefined;
     get mainList(): import("./video-window-datasource").FcrUIVideoWindowDataImpl[];
     get mainListMapByAudioStreamId(): Map<string, FcrUIVideoWindowData>;
     get foldList(): import("./video-window-datasource").FcrUIVideoWindowDataImpl[];
@@ -93,12 +104,17 @@ export default class LayoutStore implements FcrLayoutSlots, FcrUIEventObserver {
     get allowChat(): boolean;
     get allowUnmuteSelfAudio(): boolean;
     get allowUnmuteSelfVideo(): boolean;
+    get isHostOrCoHost(): boolean;
+    get allowedAllChat(): boolean | undefined;
+    get allowedPublicChatAndDisallowedPrivateChat(): boolean | undefined;
+    get disallowedPublicChatAndDisallowedPrivateChatToParticipant(): boolean | undefined;
+    get disallowedAllChat(): boolean | undefined;
+    get privilegeOperator(): FcrUserInfo | undefined;
+    get localUserId(): string;
     constructor(params: LayoutStoreParams);
-    private _initStream;
-    private _isSetSpotlightEnable;
-    private _addListeners;
-    private _handleSpotlightAdded;
-    private _handleSpotlightRemoved;
+    getWaterMarkContent(): string;
+    notifyParticipantShowWaitingRoom(): void;
+    setIsWaitingRoomNotify(): void;
     hasMutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
     hasUnmutePermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
     hasRequestStartAudioPermission(targetRole: FcrPrivilegeUserRole | FcrUserRole): boolean;
@@ -109,13 +125,7 @@ export default class LayoutStore implements FcrLayoutSlots, FcrUIEventObserver {
     setAllowChat(allowChat: boolean): void;
     handleSetPinState(userId: string): void;
     setWhiteboardActive(active: boolean): void;
-    private _handleLayoutUpdated;
-    private _handleFoldListChanged;
-    private _handleMainListChanged;
     setAsideWidth(val: number): void;
-    setDocumentVisibility(visible: boolean): void;
-    private _switchToSpeaker;
-    private _switchToGallery;
     getLocalUserId(): string;
     /**
      * Partially update slots, use `null` to delete the slot.
@@ -130,42 +140,41 @@ export default class LayoutStore implements FcrLayoutSlots, FcrUIEventObserver {
     moveChatFromAsideToDialog(): void;
     openPrivateChat(userId: string): void;
     getAllowedOperations(targetRole: FcrUserRole, isSelf: boolean): string[];
-    toggleLayout(layout: FcrUIVideoWindowLayoutType): void;
+    toggleLayout(layout: FcrUIVideoWindowLayoutType, manual?: boolean): void;
     toggleCollapsed(collapsed?: boolean): void;
     setGalleryMaxSize(size: GalleryMaxSize): void;
     toggleAside(open?: boolean): void;
     asideWidthChanged(width: number): void;
     toggleLayoutBarLock(state: boolean): void;
     toggleLayoutBarHidden(): void;
-    private _setBarHovering;
     resetLockTimer(): void;
     setHoveringHandler(): void;
     setHoveringLeaveHandler(): false | void;
     release(): void;
-    private _onAllUserCountUpdated;
     onUserInfoUpdated(roomId: string, event: FcrUserUpdatedEvent): void;
     setLocalUserRole(role: FcrUserRole): void;
-    onEvent(action: UIAction.UPDATE_ASIDE, payload: FcrUIUpdateAsideParams): void;
-    onEvent(action: UIAction.TOGGLE_LAYOUT, payload: FcrUIToggleLayoutParams): void;
-    onEvent(action: UIAction.TOGGLE_LAYOUT_SIZE, payload: FcrUIToggleLayoutSizeParams): void;
-    onEvent(action: UIAction.SET_MAIN_SPEAKER, payload: FcrUISetMainSpeakerParams): void;
-    onEvent(action: UIAction.TOGGLE_LAYOUT_BAR_LOCK, payload: boolean): void;
-    onEvent(action: UIAction.WHITEBOARD_CHANGED, payload: {
-        action: WhiteboardControlbarEvents;
-        payload: boolean;
-    }): void;
     stopLocalPreview(view: HTMLDivElement): void;
     startLocalPreview(div: HTMLDivElement | null): void;
-    get isHostOrCoHost(): boolean;
     setAllowChatWithPayload(type: 'public' | 'private_to_manager'): void;
-    get allowedAllChat(): boolean | undefined;
-    get allowedPublicChatAndDisallowedPrivateChat(): boolean | undefined;
-    get disallowedPublicChatAndDisallowedPrivateChatToParticipant(): boolean | undefined;
-    get disallowedAllChat(): boolean | undefined;
     muteAudio(mute: boolean, userId: string): void;
     sendParticipantEvent(payload: unknown): void;
-    get privilegeOperator(): FcrUserInfo | undefined;
-    get localUserId(): string;
+    onEvent(action: UIAction.UPDATE_ASIDE, payload: FcrUIUpdateAsideParams): void;
+    onEvent(action: UIAction.TOGGLE_LAYOUT, payload: FcrUIToggleLayoutParams): void;
+    onEvent(action: UIAction.TOGGLE_LAYOUT_SIZE, payload: FcrUIToggleLayoutSizeParams): void;
+    onEvent(action: UIAction.SET_MAIN_SPEAKER, payload: FcrUISetMainSpeakerParams): void;
+    onEvent(action: UIAction.TOGGLE_LAYOUT_BAR_LOCK, payload: boolean): void;
+    private _addListeners;
+    private _handleLayoutUpdated;
+    private _handleFoldListChanged;
+    private _handleMainListChanged;
+    private _switchToSpeaker;
+    private _switchToGallery;
+    private _setBarHovering;
+    private _onAllUserCountUpdated;
+    private _initStream;
+    private _isSetSpotlightEnable;
+    private _handleSpotlightAdded;
+    private _handleSpotlightRemoved;
     private _handleConnectionUpdated;
     private _handleStreamAdded;
     private _onStreamsAdded;
@@ -174,4 +183,6 @@ export default class LayoutStore implements FcrLayoutSlots, FcrUIEventObserver {
     private _onAudioVolumeUpdated;
     private _setSpotlightStream;
     private _findSpotlightStream;
+    private _handleRemoteWaitingUserLeft;
+    private _handleMessageReceived;
 }