fcr-ui-scene 3.4.1 → 3.4.3

package/lib/type.d.ts

@@ -1,12 +1,12 @@
-import { FcrCoreEngine, FcrDesktopMediaControl, FcrError, FcrPrivilegeControl, FcrStreamControl, FcrUserRole as FcrUIUserRole, FcrUserControl } from 'fcr-core';
-import { FcrChatRoomControl } from 'fcr-core/lib/room-control/chatroom-control/type';
-import { FcrRoomStore } from './common/room-store';
-import { FcrUIEventStore } from './common/event-store';
-import { FcrSecurityStore } from './common/security-store';
-import { FcrDeviceStore } from './common/device-store';
-import { FcrMainRoomControl } from 'fcr-core/lib/room-control/type';
-import { FcrDeviceStreamStore } from './common/device-stream-store';
-import { FcrRemoteVideoRenderManager } from './common/remote-renderer';
+import { FcrConnectionState, FcrError, FcrUserRole as FcrUIUserRole } from 'fcr-core';
+import { FcrChatRoomReceiveBaseMessage } from 'fcr-core/lib/room-control/chatroom-control/type';
+import { FcrMainRoomControl, FcrRoomJoinOptions, FcrRoomType, FcrWaitingRoomControl } from 'fcr-core/lib/room-control/type';
+import { FcrDeviceInfo } from 'fcr-core/lib/type';
+import { FcrInterpreterRoomControl, FcrLanguage } from 'fcr-core/lib/room-control/interpreter-control/types';
+import { ToastSize } from 'agora-ui-foundation/lib/components/toast';
+import { FcrUIDialogKey } from './utilities/constant';
+import { FcrIconType } from 'agora-ui-foundation/lib/components/icon/type';
+import { ButtonType } from 'agora-ui-foundation/lib/components/button';
 export { FcrUserRole, FcrRegion, FcrStreamLatencyLevel } from 'fcr-core';
 /**
  * FcrUIExitReason enum represents the reason for exiting a UI scene.
@@ -126,20 +126,265 @@ export interface FcrUIMediaConfig {
 export interface FcrUISettingConfig {
     media: FcrUIMediaConfig;
 }
-export type StoreConfig = {
-    mediaControl: FcrDesktopMediaControl;
-    streamControl: FcrStreamControl;
-    userControl: FcrUserControl;
-    privilegeControl: FcrPrivilegeControl;
-    chatRoomControl: FcrChatRoomControl;
-    roomStore: FcrRoomStore;
-    uiEventStore: FcrUIEventStore;
-    securityStore: FcrSecurityStore;
-    deviceStore: FcrDeviceStore;
-    roomControl: FcrMainRoomControl;
-    engine: FcrCoreEngine;
-    deviceStreamStore: FcrDeviceStreamStore;
-    remoteVideoRenderManager: FcrRemoteVideoRenderManager;
-    config?: FcrUISceneConfig;
-    parameters?: Record<string, unknown>;
+export type FcrUIBeautyKey = 'none' | 'smoothnessLevel' | 'lighteningLevel' | 'lighteningLevel';
+export interface FcrUIDeviceObserver {
+    /**
+     * 当前选中摄像头变更
+     * @param cameraId
+     */
+    onCameraChanged?(cameraId: string): void;
+    /**
+     * 当前选中麦克风变更
+     * @param microphoneId
+     */
+    onMicrophoneChanged?(microphoneId: string): void;
+    /**
+     * 当前选中扬声器变更
+     * @param speakerId
+     */
+    onSpeakerChanged?(speakerId: string): void;
+    /**
+     * 摄像头列表更新
+     * @param cameraList
+     */
+    onCameraListUpdated?(cameraList: FcrDeviceInfo[]): void;
+    /**
+     * 麦克风列表更新
+     * @param microphoneList
+     */
+    onMicrophoneListUpdated?(microphoneList: FcrDeviceInfo[]): void;
+    /**
+     * 扬声器列表更新
+     * @param speakerList
+     */
+    onSpeakerListUpdated?(speakerList: FcrDeviceInfo[]): void;
+    /**
+     * 音频已断开
+     */
+    onAudioDisconnected?(): void;
+    /**
+     * 音频已连接
+     */
+    onAudioConnected?(): void;
+}
+export declare enum FcrUIVideoEffectType {
+    NONE = 0,
+    BEAUTY = 1,
+    VIRTUAL_BACKGROUND = 2
+}
+export declare enum FcrUIConnectType {
+    NONE = 0,
+    COMPUTER = 1,
+    PHONE = 2
+}
+export type FcrUISecuritySendChatOriginalPayload = {
+    public: 0 | 1;
+    private: {
+        host: 0 | 1;
+        cohost: 0 | 1;
+        participant: 0 | 1;
+    };
 };
+export interface FcrUIToggleInterpreterRoom {
+    control: FcrInterpreterRoomControl;
+    language: FcrLanguage;
+    isToggleInterperterRemoteAudio?: boolean;
+}
+export interface FcrUILeaveInterpreterRoom extends FcrUIToggleInterpreterRoom {
+}
+export interface FcrUIJoinInterpreterRoom extends FcrUIToggleInterpreterRoom {
+    roomJoinOptions: FcrRoomJoinOptions;
+}
+export type FcrUIRoomObserver = {
+    /**
+     * 用户加入主房间
+     * @param ticket
+     * @returns
+     */
+    onJoinMainRoom?: (ticket: string) => void;
+    /**
+     * 用户离开主房间
+     */
+    onLeaveMainRoom?: () => void;
+    /**
+     * 用户加入主房间失败
+     * @param error
+     */
+    onJoinMainRoomFailed?: (error: FcrError) => void;
+    /**
+     * 用户加入等候室
+     * @param roomControl
+     * @param isWaitingRoomManager
+     * @returns
+     */
+    onJoinWaitingRoom?: (roomControl: FcrWaitingRoomControl, isWaitingRoomManager?: boolean) => void;
+    /**
+     * 用户离开等候室
+     */
+    onLeaveWaitingRoom?: () => void;
+    /**
+     * 用户被踢出房间
+     * @param roomId
+     * @returns
+     */
+    onLocalUserKickedOut?: () => void;
+    /**
+     * 房间已关闭
+     * @returns
+     */
+    onRoomClosed?: () => void;
+    /**
+     * 用户退出房间
+     * @param roomState
+     */
+    onExitRoom?: () => void;
+};
+export type FcrUIConnectionObserver = {
+    onConnectionStateUpdated?: (state: FcrConnectionState) => void;
+};
+export interface FcrUIDialogParams<T> {
+    dialogKey: FcrUIDialogKey;
+    dialogId: string;
+    params?: T extends unknown ? unknown : T;
+}
+export interface FcrUIToastParams {
+    type: 'error' | 'warn' | 'info' | 'normal';
+    message: string;
+    duration?: number;
+    id?: string;
+    size?: ToastSize;
+    customRootClass?: string;
+}
+export declare enum FcrUINotificationContentType {
+    WAITING_ROOM = "WAITING_ROOM",
+    INTERPRETER_STATUS = "INTERPRETER_STATUS"
+}
+export interface FcrUINotificationParams {
+    duration?: number;
+    placement: 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight';
+    type: FcrUINotificationContentType;
+    onOk?: () => void;
+    onClose?: () => void;
+    data?: any;
+}
+export interface FcrUIConfirmDialogParams {
+    title: string;
+    content: React.ReactNode;
+    icon?: FcrIconType;
+    okText?: string;
+    cancelText?: string;
+    showCancel?: boolean;
+    closable?: boolean;
+    onConfirm?: () => void;
+    onOk?: () => void;
+    onCancel?: () => void;
+    alignCenter?: boolean;
+    width?: number;
+    height?: number;
+    buttonBlock?: boolean;
+    cancelType?: ButtonType;
+}
+export interface FcrUIUpdateAsideParams {
+    participant?: boolean;
+    chat?: boolean;
+}
+export interface FcrUINewChatMessagesParams {
+    latestMessage: FcrChatRoomReceiveBaseMessage;
+    count: number;
+    type: FcrRoomType;
+}
+export interface FcrUIToggleLayoutParams {
+    layout: 'speaker' | 'gallery';
+    manual?: boolean;
+}
+export interface FcrUIToggleLayoutSizeParams {
+    size: 16 | 25;
+}
+export interface FcrUILayoutSizeChangedParams extends FcrUIToggleLayoutSizeParams {
+}
+export interface FcrUISetMainSpeakerParams {
+    userId: string;
+}
+export interface FcrUIVisibilityStateParams {
+    visibility: boolean;
+}
+export interface FcrUIUpdateShareScreenParams {
+    isOpen: boolean;
+}
+export interface FcrUICloudRecordingParams {
+    action: 'start' | 'pause' | 'resume' | 'stop';
+}
+export interface FcrUIHandleDeviceActionParams {
+    enable?: boolean;
+    view?: HTMLDivElement;
+}
+export interface FcrUISpotlightStreamChangedParams {
+    type: 'add' | 'remove';
+    streamId: string;
+}
+export type FcrUIJoinRoomResponse = readonly [FcrRoomType.Mainroom, FcrMainRoomControl] | readonly [FcrRoomType.Waitingroom, FcrWaitingRoomControl];
+import { FcrRoomConnectorType, FcrVideoSourceType } from 'fcr-core';
+import { FcrUserRole } from 'fcr-core/lib/type';
+export declare enum FcrUIVideoWindowLayoutType {
+    /** Show a carousel on top and a big video on the rest of the screen. */
+    Speaker = "speaker",
+    /** Show videos in grid, filling the screen. */
+    Gallery = "gallery"
+}
+export declare enum GalleryMaxSize {
+    Normal = 16,
+    Large = 25
+}
+export declare const VideoRatio: number;
+export declare enum FcrUIVideoWindowMainSortingPriority {
+    NONE = 0,
+    MICROPHONE_OPEN = 1,
+    CAMERA_OPEN = 2,
+    BOTH_OPEN = 3,
+    CO_HOST = 4,
+    MYSELF = 5,
+    HOST = 6,
+    SCREEN_SHARING_OWNER = 7,
+    SPEAKER_SPOTLIGHT = 8,
+    FOCUS = 9,
+    HIGHEST = 10
+}
+export declare enum FcrUIVideoWindowFoldSortingPriority {
+    NONE = 0,
+    MICROPHONE_OPEN = 1,
+    CAMERA_OPEN = 2,
+    BOTH_OPEN = 3,
+    CO_HOST = 4,
+    MYSELF = 5,
+    HOST = 6,
+    SCREEN_SHARING_OWNER = 7,
+    SCREEN_SHARING_STREAM = 8,
+    PIN = 9,
+    FOCUS = 10,
+    HIGHEST = 11
+}
+export declare enum FcrUIWindowType {
+    VIDEO = 1,
+    BOARD = 2
+}
+export interface FcrUIVideoWindowData {
+    windowId: string;
+    type: FcrUIWindowType;
+    videoStreamId?: string;
+    audioStreamId?: string;
+    hasMicrophoneAudioStream: boolean;
+    hasLoopbackAudioStream: boolean;
+    hasVideoStream: boolean;
+    hasScreenSharing: boolean;
+    audioStreamConnectorType: FcrRoomConnectorType;
+    videoStreamConnectorType: FcrRoomConnectorType;
+    userId: string;
+    userName: string;
+    isMySelf: boolean;
+    isPin: boolean;
+    isSpeakerSpotlight: boolean;
+    videoSourceType: FcrVideoSourceType;
+    ownerRoleType: FcrUserRole;
+    sortingPriority: number;
+    phoneMicEnabled?: boolean;
+}

package/lib/type.js

@@ -16,21 +16,35 @@ Object.defineProperty(exports, "FcrStreamLatencyLevel", {
     return _fcrCore.FcrStreamLatencyLevel;
   }
 });
-exports.FcrUIExitReason = void 0;
+exports.FcrUIWindowType = exports.FcrUIVideoWindowMainSortingPriority = exports.FcrUIVideoWindowLayoutType = exports.FcrUIVideoWindowFoldSortingPriority = exports.FcrUIVideoEffectType = exports.FcrUINotificationContentType = exports.FcrUIExitReason = exports.FcrUIConnectType = void 0;
 Object.defineProperty(exports, "FcrUserRole", {
   enumerable: true,
   get: function get() {
     return _fcrCore.FcrUserRole;
   }
 });
+exports.VideoRatio = exports.GalleryMaxSize = void 0;
 var _fcrCore = require("fcr-core");
+// Public
 /**
  * FcrUIExitReason enum represents the reason for exiting a UI scene.
  */
 var FcrUIExitReason = exports.FcrUIExitReason = /*#__PURE__*/function (FcrUIExitReason) {
+  /**
+   * The user leaves the room.
+   */
   FcrUIExitReason["LEAVE_ROOM"] = "LEAVE_ROOM";
+  /**
+   * The user leaves the room due to the room being closed.
+   */
   FcrUIExitReason["CLOSE_ROOM"] = "CLOSE_ROOM";
+  /**
+   * The user is kicked out of the room.
+   */
   FcrUIExitReason["KICKED_OUT"] = "KICKED_OUT";
+  /**
+   * The user failed to join the room due to various reasons such as User ID conflict.
+   */
   FcrUIExitReason["ABORTED"] = "ABORTED";
   return FcrUIExitReason;
 }({});
@@ -39,4 +53,69 @@ var FcrUIExitReason = exports.FcrUIExitReason = /*#__PURE__*/function (FcrUIExit
  */
 /**
  * FcrUISceneObserver interface represents an observer for a UI scene.
- */
+ */
+// Private
+var FcrUIVideoEffectType = exports.FcrUIVideoEffectType = /*#__PURE__*/function (FcrUIVideoEffectType) {
+  FcrUIVideoEffectType[FcrUIVideoEffectType["NONE"] = 0] = "NONE";
+  FcrUIVideoEffectType[FcrUIVideoEffectType["BEAUTY"] = 1] = "BEAUTY";
+  FcrUIVideoEffectType[FcrUIVideoEffectType["VIRTUAL_BACKGROUND"] = 2] = "VIRTUAL_BACKGROUND";
+  return FcrUIVideoEffectType;
+}({});
+var FcrUIConnectType = exports.FcrUIConnectType = /*#__PURE__*/function (FcrUIConnectType) {
+  FcrUIConnectType[FcrUIConnectType["NONE"] = 0] = "NONE";
+  FcrUIConnectType[FcrUIConnectType["COMPUTER"] = 1] = "COMPUTER";
+  FcrUIConnectType[FcrUIConnectType["PHONE"] = 2] = "PHONE";
+  return FcrUIConnectType;
+}({});
+var FcrUINotificationContentType = exports.FcrUINotificationContentType = /*#__PURE__*/function (FcrUINotificationContentType) {
+  FcrUINotificationContentType["WAITING_ROOM"] = "WAITING_ROOM";
+  FcrUINotificationContentType["INTERPRETER_STATUS"] = "INTERPRETER_STATUS";
+  return FcrUINotificationContentType;
+}({});
+var FcrUIVideoWindowLayoutType = exports.FcrUIVideoWindowLayoutType = /*#__PURE__*/function (FcrUIVideoWindowLayoutType) {
+  /** Show a carousel on top and a big video on the rest of the screen. */
+  FcrUIVideoWindowLayoutType["Speaker"] = "speaker";
+  /** Show videos in grid, filling the screen. */
+  FcrUIVideoWindowLayoutType["Gallery"] = "gallery";
+  return FcrUIVideoWindowLayoutType;
+}({});
+var GalleryMaxSize = exports.GalleryMaxSize = /*#__PURE__*/function (GalleryMaxSize) {
+  GalleryMaxSize[GalleryMaxSize["Normal"] = 16] = "Normal";
+  GalleryMaxSize[GalleryMaxSize["Large"] = 25] = "Large";
+  return GalleryMaxSize;
+}({});
+var VideoRatio = exports.VideoRatio = 19 / 32;
+var FcrUIVideoWindowMainSortingPriority = exports.FcrUIVideoWindowMainSortingPriority = /*#__PURE__*/function (FcrUIVideoWindowMainSortingPriority) {
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["NONE"] = 0] = "NONE";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["MICROPHONE_OPEN"] = 1] = "MICROPHONE_OPEN";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["CAMERA_OPEN"] = 2] = "CAMERA_OPEN";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["BOTH_OPEN"] = 3] = "BOTH_OPEN";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["CO_HOST"] = 4] = "CO_HOST";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["MYSELF"] = 5] = "MYSELF";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["HOST"] = 6] = "HOST";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["SCREEN_SHARING_OWNER"] = 7] = "SCREEN_SHARING_OWNER";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["SPEAKER_SPOTLIGHT"] = 8] = "SPEAKER_SPOTLIGHT";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["FOCUS"] = 9] = "FOCUS";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["HIGHEST"] = 10] = "HIGHEST";
+  return FcrUIVideoWindowMainSortingPriority;
+}({});
+var FcrUIVideoWindowFoldSortingPriority = exports.FcrUIVideoWindowFoldSortingPriority = /*#__PURE__*/function (FcrUIVideoWindowFoldSortingPriority) {
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["NONE"] = 0] = "NONE";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["MICROPHONE_OPEN"] = 1] = "MICROPHONE_OPEN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["CAMERA_OPEN"] = 2] = "CAMERA_OPEN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["BOTH_OPEN"] = 3] = "BOTH_OPEN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["CO_HOST"] = 4] = "CO_HOST";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["MYSELF"] = 5] = "MYSELF";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["HOST"] = 6] = "HOST";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["SCREEN_SHARING_OWNER"] = 7] = "SCREEN_SHARING_OWNER";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["SCREEN_SHARING_STREAM"] = 8] = "SCREEN_SHARING_STREAM";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["PIN"] = 9] = "PIN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["FOCUS"] = 10] = "FOCUS";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["HIGHEST"] = 11] = "HIGHEST";
+  return FcrUIVideoWindowFoldSortingPriority;
+}({});
+var FcrUIWindowType = exports.FcrUIWindowType = /*#__PURE__*/function (FcrUIWindowType) {
+  FcrUIWindowType[FcrUIWindowType["VIDEO"] = 1] = "VIDEO";
+  FcrUIWindowType[FcrUIWindowType["BOARD"] = 2] = "BOARD";
+  return FcrUIWindowType;
+}({});

package/lib/ui-manager.d.ts

@@ -1,23 +1,27 @@
 import { FcrCoreEngine } from 'fcr-core';
-import { FcrUISceneConfig, FcrUISceneObserver, FcrUISettingConfig } from './type';
+import { FcrUISceneConfig } from './type';
 import { FcrCoreEngineConfig } from 'fcr-core/lib/type';
-import { AgoraObservable } from 'agora-foundation/lib/utilities/observable';
+import { FcrMainRoomControl } from 'fcr-core/lib/room-control/type';
+import { FcrUIEventProvider } from './providers/event-provider';
+import { FcrUISharedConfigDataSource } from './shared-data-source/config';
+import { FcrUIDeviceProvider } from './providers/device-provider';
+import { FcrUIRoomProviderImpl } from './providers/room-provider';
+import { FcrUISharedSettingDataSource } from './shared-data-source/setting';
+import { FcrUISharedLayoutDataSource } from './shared-data-source/layout-data';
+import { FcrUISharedSpeakerSpotlightDataSource } from './shared-data-source/speaker-spotlight';
+import { FcrUISharedPinDataSource } from './shared-data-source/pin-data';
+import { FcrUIMessageProvider } from './providers/message-provider';
+import { FcrUIDialogProvider } from './providers/dialog-provider';
+import { FcrUIVideoWindowDataSource } from './shared-data-source/video-window';
+import { FcrUISharedDevicePrivilegeDataSource } from './shared-data-source/device-privilege-data';
 export declare class DefaultSceneUIManager {
     private _sceneConfig;
     private _coreConfig;
     private _engine;
-    private _observable;
-    private _settingConfig;
-    constructor(_sceneConfig: FcrUISceneConfig, _coreConfig: FcrCoreEngineConfig, _engine: FcrCoreEngine, _observable: AgoraObservable<FcrUISceneObserver>, _settingConfig: FcrUISettingConfig);
-    render(dom: HTMLElement): void;
-    destroy(): void;
-    private _disposeRoomControl;
-    private _renderDevicePretestUi;
-    private _runSettingConfig;
-    private _renderWithErrorBoundary;
-    private _logError;
-    private _renderLayers;
-    private _renderPullingUi;
-    private _renderRoomUi;
-    private _renderWaitingRoomUi;
+    constructor(_sceneConfig: FcrUISceneConfig, _coreConfig: FcrCoreEngineConfig, _engine: FcrCoreEngine);
+    renderDevicePretestUi(dom: HTMLElement, deviceProvider: FcrUIDeviceProvider, onJoin: () => void, onExit: () => void): void;
+    renderPullingUi(dom: HTMLElement, roomControl: FcrMainRoomControl): () => void;
+    renderMainSceneUI(dom: HTMLElement, eventProvider: FcrUIEventProvider, deviceProvider: FcrUIDeviceProvider, roomProvider: FcrUIRoomProviderImpl, sharedConfigDataSource: FcrUISharedConfigDataSource, sharedSettingDataSource: FcrUISharedSettingDataSource, sharedLayoutDataSource: FcrUISharedLayoutDataSource, sharedSpeakerSpotlightDataSource: FcrUISharedSpeakerSpotlightDataSource, sharedPinDataSource: FcrUISharedPinDataSource, dialogProvider: FcrUIDialogProvider, messageProvider: FcrUIMessageProvider, sharedVideoWindowDataSource: FcrUIVideoWindowDataSource, sharedDevicePrivilegeDataSource: FcrUISharedDevicePrivilegeDataSource): () => void;
+    renderWaitingSceneUI(dom: HTMLElement, eventProvider: FcrUIEventProvider, deviceProvider: FcrUIDeviceProvider, roomProvider: FcrUIRoomProviderImpl, sharedConfigDataSource: FcrUISharedConfigDataSource, dialogProvider: FcrUIDialogProvider, messageProvider: FcrUIMessageProvider, sharedLayoutDataSource: FcrUISharedLayoutDataSource, sharedSettingDataSource: FcrUISharedSettingDataSource, sharedDevicePrivilegeDataSource: FcrUISharedDevicePrivilegeDataSource): () => void;
+    renderLoading(dom: HTMLElement): void;
 }