fcr-ui-scene 3.7.4 → 3.7.6

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

@@ -0,0 +1,434 @@
+import { FcrPrivilegeUserRole } from 'fcr-core';
+import { FcrUserInfo, FcrUserRole } from 'fcr-core/lib/type';
+import { ParticipantActionType } from 'agora-ui-foundation/lib/components/participants/attendee';
+import { FcrUIDialogKey, FcrUIRoomControlType } from '../../utilities/constant';
+import { FcrUIMemberData, OperateWaitingRoomMemberDialogProps, ParticipantStoreArgs } from './type';
+import { FcrUserKickedOutType } from 'fcr-core/lib/room-control/user-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, FcrUIUpdateAsideParams } from '../../type';
+import { User } from './components/participants/types';
+export declare abstract class ParticipantStoreBase {
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _disposers;
+    private _roomStore;
+    private _chatProvider;
+    private _roomControl;
+    private _streamControl;
+    private _userControl;
+    private _waitingRoomControl?;
+    private _waitingRoomUserControl?;
+    private _peerSessionControl;
+    private _eventProvider;
+    private _deviceStore;
+    private _deviceStreamStore;
+    private _unmuteAudioTimestamp;
+    private _unmuteVideoTimestamp;
+    private _processedUserOpenDeviceRequests;
+    private _privilegeProvider;
+    private _screenShareProvider;
+    private _sharedPinDataSource;
+    private _sharedLayoutDataSource;
+    private _sharedInterpreterDataSource;
+    private _sharedVideoWindowDataSource;
+    private _sharedWaitingRoomDataSource;
+    private _sharedMemberDataSource;
+    private _sharedChatDataSource;
+    private _sharedSettingDataSource;
+    private _sharedSecurityDataSource;
+    private _peerSessionObserver;
+    private _dialogProvider;
+    private _abilityProvider;
+    private _messageProvider;
+    private _roomStoreObserver;
+    private _privilegeControlObserver;
+    private _userObserver;
+    private _whitebaordObderver;
+    protected _renamingUserId: string;
+    protected _renamingUserName: string;
+    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;
+    accessor _userCount: number;
+    get renamingUserName(): string;
+    get audioVolumeMap(): Map<string, number>;
+    get localUser(): FcrUserInfo;
+    get localUserRole(): FcrUserRole;
+    get isLocalUserHost(): boolean;
+    get enableSpotlight(): boolean;
+    get userListSource(): import("./member-list-data-source").FcrUIMemberDataImpl[];
+    get spotlightStreamId(): string;
+    get mergeUserInfo(): FcrUserInfo | undefined;
+    get userMap(): Map<string, FcrUIMemberData>;
+    get userCount(): number;
+    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 isLocalScreenSharing(): boolean;
+    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;
+    abstract get isLocalCameraInSecondaryWindow(): boolean;
+    protected abstract _openChangeNameDialog(userId: string): void;
+    get isHostKeyEnabled(): boolean;
+    get hasInvite(): boolean;
+    get checkedStateMap(): import("../../shared-data/security-data").FcrSecurityCheckedStateType;
+    constructor({ objectManager }: ParticipantStoreArgs);
+    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;
+    setParticipantsRenderAt(renderPosition: 'aside' | 'dialog'): void;
+    setLayoutAsideLayout(params: FcrUIUpdateAsideParams): void;
+    get getLayoutChatRenderAt(): "aside" | "dialog";
+    setChatActiveTab(activeTab: FcrUIRoomType): void;
+    abstract closeChatWindow(): void;
+    abstract openChatWindow(): boolean;
+    closeParticipantsWindow(): void;
+    openDialog(key: FcrUIDialogKey): void;
+    closeDialog(key: FcrUIDialogKey): void;
+    openConfirmDialog(params: ConfirmContentProps, key?: string): string;
+    closeConfirmDialog(id: string): void;
+    setParticipantsWindowActive(active: boolean): void;
+    handlerSearchUser(searchText: string): void;
+    onInvite(): void;
+    setMergeConfirmDialog(visible: boolean): void;
+    mergeConfirmDialogOk(userId: string): void;
+    openRemoveAdmitWaitingRoomDialog(params: OperateWaitingRoomMemberDialogProps): void;
+    setAllowUnmute(checked: boolean): void;
+    setAllowJoinWithMuteAudio(checked: boolean): void;
+    openMuteAllDialog(): void;
+    handlerRoomControlAction(action: FcrUIRoomControlType, data?: any): void;
+    moveParticipantFromDialogToAside(): void;
+    private _revokeHostByTicket;
+    private _muteAllAudio;
+    private _unmuteAllAudio;
+    private _enableSelfUnmute;
+    private _enableOpenVideo;
+    private _revokeHost;
+    private _lockRoom;
+    private _enableRename;
+    private enableJoinWithMuteAudio;
+    moveToMainRoomByUserIds(userId: string[]): void;
+    kickOutWaitingRoomAllMember(type: FcrUserKickedOutType): Promise<void>;
+    moveToMainRoomAllMember(): Promise<void>;
+    removeWaitingRoomUser(userId: string, type: FcrUserKickedOutType): void;
+    getAllowedOperations: (targetRole: FcrUserRole, isSelf: boolean) => string[];
+    removePin(userId: string): void;
+    isHostSupportedByPlatform(userId: string): boolean;
+    addPin(userId: string): void;
+    private _getPinStreamIdFromUser;
+    /**
+     * 格式化用户数据为UI显示格式
+     * @param user 原始用户数据
+     * @returns 格式化后的用户数据
+     */
+    private _formatUser;
+    /**
+     * 获取默认用户数据（用于错误处理）
+     * @returns 默认用户数据
+     */
+    private _getDefaultUserData;
+    /**
+     * 获取用户基础信息
+     * @param user 用户数据
+     * @param isSelf 是否为当前用户
+     * @returns 基础信息对象
+     */
+    private _getUserBaseInfo;
+    /**
+     * 获取用户设备信息
+     * @param user 用户数据
+     * @param userStreams 用户流数据
+     * @param isSelf 是否为当前用户
+     * @returns 设备信息对象
+     */
+    private _getUserDeviceInfo;
+    /**
+     * 获取普通用户（电脑客户端）的设备信息
+     * @param userStreams 用户流数据
+     * @param isSelf 是否为当前用户
+     * @returns 设备信息对象
+     */
+    private _getNormalUserDeviceInfo;
+    /**
+     * 获取PSTN电话用户的设备信息
+     * @param userStreams 用户流数据
+     * @returns 设备信息对象
+     */
+    private _getPstnUserDeviceInfo;
+    /**
+     * 获取SIP/H323会议系统用户的设备信息
+     * @param userStreams 用户流数据
+     * @returns 设备信息对象
+     */
+    private _getSipOrH323UserDeviceInfo;
+    /**
+     * 获取默认设备信息
+     * @returns 默认设备信息对象
+     */
+    private _getDefaultDeviceInfo;
+    /**
+     * 获取用户流状态信息
+     * @param user 用户数据
+     * @param userStreams 用户流数据
+     * @returns 流状态信息对象
+     */
+    private _getUserStreamInfo;
+    /**
+     * 根据视频源类型查找流
+     * @param userStreams 用户流数组
+     * @param videoSourceType 视频源类型
+     * @returns 找到的流或undefined
+     */
+    private _findStreamByVideoSourceType;
+    /**
+     * 根据连接器类型查找流
+     * @param userStreams 用户流数组
+     * @param connectorType 连接器类型
+     * @returns 找到的流或undefined
+     */
+    private _findStreamByConnectorType;
+    /**
+     * 查找SIP或H323流
+     * @param userStreams 用户流数组
+     * @returns 找到的流或undefined
+     */
+    private _findSipOrH323Stream;
+    /**
+     * 检查流是否有音频发布并已启动
+     * @param stream 流信息
+     * @returns 是否有音频发布并已启动
+     */
+    private _hasAudioPublishedAndStarted;
+    /**
+     * 检查流是否有视频发布并已启动
+     * @param stream 流信息
+     * @returns 是否有视频发布并已启动
+     */
+    private _hasVideoPublishedAndStarted;
+    private _handleRemoteUsersJoined;
+    private _handleUserInfoUpdated;
+    private _handleUserCountUpdated;
+    private _handleUserPropertiesUpdated;
+    handleConfirmChangeName(): Promise<void>;
+    handleCancelChangeName(): void;
+    private _closeChangeNameDialog;
+    private _getOutputLanguage;
+    handlerUserAction(action: ParticipantActionType, userId: string): void;
+    handleActiveTab(tab: FcrUIRoomType): void;
+    /**
+     * 检查是否在会话持续时间内，避免重复发送请求
+     * @param userId 用户ID
+     * @param timestampMap 时间戳映射表
+     * @returns 如果在持续时间内返回true，否则返回false
+     */
+    private _isWithinSessionDuration;
+    /**
+     * 设置权限并更新UI状态
+     * 设置权限后需要同步更新UI状态
+     * @param setPrivilege 设置权限的函数
+     * @param uiState 要更新的UI状态
+     */
+    private _setPrivilegeAndUpdateUI;
+    /**
+     * 显示toast消息的辅助方法
+     * @param message 消息内容
+     * @param type 消息类型，默认为'normal'
+     */
+    private _showToast;
+    /**
+     * 打开对话框的辅助方法
+     * @param dialogKey 对话框键值
+     */
+    protected _openDialog(dialogKey: FcrUIDialogKey, params?: Record<string, unknown>): void;
+    /**
+     * 更新流发布权限的辅助方法
+     * @param streamId 流ID
+     * @param audioPrivilege 音频权限
+     * @param videoPrivilege 视频权限
+     */
+    private _updateStreamPrivilege;
+    /**
+     * 获取用户的目标音频流
+     * @param userId 用户ID
+     * @returns 目标流信息，包含硬件设备流和普通客户端流
+     */
+    private _getUserTargetAudioStreams;
+    /**
+     * 静音指定用户的音频
+     * @param userId 用户ID
+     */
+    private _muteUserAudio;
+    /**
+     * 取消静音指定用户的音频
+     * @param userId 用户ID
+     */
+    private _unmuteUserAudio;
+    /**
+     * 静音指定用户的视频
+     * @param userId 用户ID
+     */
+    private _muteUserVideo;
+    private _unmuteUserVideo;
+    private _privateChat;
+    private _setAsHost;
+    private _setAsCoHost;
+    /**
+     * 显示设置主持人/联席主持人对话框
+     * @param userId 用户ID
+     * @param type 角色类型
+     */
+    private _showSetHostDialog;
+    /**
+     * 获取角色显示名称
+     * @param type 角色类型
+     * @returns 角色显示名称
+     */
+    private _getRoleDisplayName;
+    /**
+     * 处理设置主持人确认操作
+     * @param userId 用户ID
+     * @param type 角色类型
+     */
+    private _handleSetHostConfirmation;
+    /**
+     * 处理设置主持人时的错误
+     * @param error 错误对象
+     */
+    private _handleSetHostError;
+    private _updateRemoteUserRole;
+    private _setAsAttendee;
+    /**
+     * 将指定用户移动到等待房间
+     * @param userId 要移动的用户ID
+     */
+    private _moveToWaitingRoomByUserId;
+    /**
+     * 踢出用户的主入口方法
+     * 根据当前房间类型选择相应的处理逻辑
+     * @param userId 要踢出的用户ID
+     */
+    private _kickOutUser;
+    /**
+     * 从主房间踢出用户
+     * @param userId 用户ID
+     */
+    private _kickOutUserFromMainRoom;
+    /**
+     * 从等待房间踢出用户
+     * @param userId 用户ID
+     */
+    private _kickOutUserFromWaitingRoom;
+    /**
+     * 检查用户是否存在
+     * @param userId 用户ID
+     * @returns 用户是否存在
+     */
+    private _isUserExists;
+    /**
+     * 根据用户ID获取用户名
+     * @param userId 用户ID
+     * @returns 用户名，如果找不到则返回空字符串
+     */
+    private _getUserNameById;
+    /**
+     * 创建主房间踢出用户的对话框配置
+     * @param userId 用户ID
+     * @param userName 用户名
+     * @returns 对话框配置对象
+     */
+    private _createMainRoomKickOutDialogConfig;
+    /**
+     * 创建等待房间踢出用户的对话框配置
+     * @param userId 用户ID
+     * @param userName 用户名
+     * @returns 对话框配置对象
+     */
+    private _createWaitingRoomKickOutDialogConfig;
+    /**
+     * 执行踢出用户操作
+     * @param userId 用户ID
+     * @param kickOutType 踢出类型
+     */
+    private _executeKickOut;
+    private _onPeerSessionReceived;
+    private _onPeerSessionAccepted;
+    private _onPeerSessionRejected;
+    private _updateSessionTimestamp;
+    /**
+     * 设置等候室用户数量监听器
+     * 当等候室用户数量为0时 tab自动切换回主房间
+     */
+    private _setupWaitingRoomUserCountListener;
+    /**
+     * 检查会话是否已经被处理过
+     * @param sessionId 会话ID
+     * @returns 是否已处理
+     */
+    private _isSessionAlreadyProcessed;
+    /**
+     * 验证本地用户信息
+     * @returns 验证是否通过
+     */
+    private _validateLocalUser;
+    /**
+     * 处理设备请求
+     * @param session 对等会话
+     */
+    private _handleDeviceRequest;
+    /**
+     * 处理摄像头开启请求
+     * @param session 对等会话
+     * @param sender 发送者信息
+     */
+    private _handleCameraRequest;
+    /**
+     * 处理麦克风开启请求
+     * @param session 对等会话
+     * @param sender 发送者信息
+     */
+    private _handleMicrophoneRequest;
+    /**
+     * 显示摄像头请求确认对话框
+     * @param session 对等会话
+     * @param sender 发送者信息
+     */
+    private _showCameraRequestDialog;
+    /**
+     * 显示麦克风请求确认对话框
+     * @param session 对等会话
+     * @param sender 发送者信息
+     */
+    private _showMicrophoneRequestDialog;
+    private _handleEvent;
+}
+export declare const StoreContext: import("react").Context<ParticipantStoreBase>;