fcr-ui-scene 3.4.5 → 3.5.1

package/lib/type.d.ts

@@ -1,6 +1,6 @@
-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 { FcrConnectionState, FcrError } from 'fcr-core';
+import { FcrChatRoomReceivedBaseMessage } from 'fcr-core/lib/room-control/chatroom-control/type';
+import { FcrBaseRoomControl, 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';
@@ -51,44 +51,7 @@ export interface FcrUISceneCreatorConfig {
 /**
  * FcrUISceneConfig interface represents the configuration for a UI scene.
  */
-export interface FcrUISceneConfig {
-    /**
-     * The token for authentication.
-     */
-    roomToken: string;
-    /**
-     * The ID of the room.
-     */
-    roomId: string;
-    /**
-     * The name of the user.
-     */
-    userName: string;
-    /**
-     * The role of the user.
-     */
-    userRole: FcrUIUserRole;
-    /**
-     * The language of the user interface. Supported languages are: 'en', 'zh'.
-     */
-    language: string;
-    /**
-     * Link to share the room.
-     */
-    inviteLink: string;
-    /**
-     * Flexible properties of the user.
-     */
-    userProperties?: Record<string, unknown>;
-    /**
-     * UI Resources such as virtual background images and videos.
-     */
-    resource?: FcrUIResource;
-    /**
-     * The password for the room.
-     */
-    password?: string;
-}
+export type FcrUISceneConfig = FcrUISceneConfigSchema;
 /**
  * FcrUISceneObserver interface represents an observer for a UI scene.
  */
@@ -114,9 +77,9 @@ export interface FcrUISceneObserver {
      */
     onLaunchFailure?: FcrUISceneFailureCallback;
 }
-export type FcrUISceneCancelCallback = (roomId: string) => void;
-export type FcrUISceneSuccessCallback = (roomId: string) => void;
-export type FcrUISceneFailureCallback = (roomId: string, error: FcrError) => void;
+export type FcrUISceneCancelCallback = FcrUISceneCallbackSchema;
+export type FcrUISceneSuccessCallback = FcrUISceneCallbackSchema;
+export type FcrUISceneFailureCallback = FcrUISceneFailureCallbackSchema;
 export type FcrUISceneExitCallback = (roomId: string, reason: FcrUIExitReason) => void;
 export interface FcrUIMediaConfig {
     autoConnectAudio: boolean;
@@ -126,6 +89,45 @@ export interface FcrUIMediaConfig {
 export interface FcrUISettingConfig {
     media: FcrUIMediaConfig;
 }
+/**
+ * FcrUIBaseWidgetConfig interface represents the base configuration for a widget.
+ */
+export interface FcrUIBaseWidgetConfig {
+    /**
+     * The unique ID of the widget.
+     */
+    id: string;
+    /**
+     * The display name of the widget.
+     */
+    name: string;
+    /**
+     * The display icon of the widget, supports file/http/https.
+     */
+    icon: string;
+    /**
+     * The roles that can use the widget.
+     * If not set or set to an empty array, all roles can use the widget.
+     */
+    supportedRoles?: FcrUserRole[];
+    /**
+     * The popup size of the widget (PC).
+     */
+    popupSize?: {
+        width: number;
+        height: number;
+    };
+}
+/**
+ * FcrUIWebWidgetConfig interface extends FcrUIBaseWidgetConfig and represents
+ * the configuration for a web-based widget.
+ */
+export interface FcrUIWebWidgetConfig extends FcrUIBaseWidgetConfig {
+    /**
+     * The HTML address of the widget content, supports file/http/https.
+     */
+    url: string;
+}
 export type FcrUIBeautyKey = 'none' | 'smoothnessLevel' | 'lighteningLevel' | 'lighteningLevel';
 export interface FcrUIDeviceObserver {
     /**
@@ -238,6 +240,11 @@ export type FcrUIRoomObserver = {
      * @param roomState
      */
     onExitRoom?: () => void;
+    /**
+     * 用户被收回等候室管理员权限
+     *
+     */
+    onWaitingRoomManageCanceled?: () => void;
 };
 export type FcrUIConnectionObserver = {
     onConnectionStateUpdated?: (state: FcrConnectionState) => void;
@@ -257,11 +264,13 @@ export interface FcrUIToastParams {
 }
 export declare enum FcrUINotificationContentType {
     WAITING_ROOM = "WAITING_ROOM",
-    INTERPRETER_STATUS = "INTERPRETER_STATUS"
+    INTERPRETER_STATUS = "INTERPRETER_STATUS",
+    TOAST = "TOAST"
 }
+export type Placement = 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight';
 export interface FcrUINotificationParams {
     duration?: number;
-    placement: 'top' | 'topLeft' | 'topRight' | 'bottom' | 'bottomLeft' | 'bottomRight';
+    placement: Placement;
     type: FcrUINotificationContentType;
     onOk?: () => void;
     onClose?: () => void;
@@ -289,7 +298,7 @@ export interface FcrUIUpdateAsideParams {
     chat?: boolean;
 }
 export interface FcrUINewChatMessagesParams {
-    latestMessage: FcrChatRoomReceiveBaseMessage;
+    latestMessage: FcrChatRoomReceivedBaseMessage;
     count: number;
     type: FcrRoomType;
 }
@@ -322,9 +331,10 @@ export interface FcrUISpotlightStreamChangedParams {
     type: 'add' | 'remove';
     streamId: string;
 }
-export type FcrUIJoinRoomResponse = readonly [FcrRoomType.Mainroom, FcrMainRoomControl] | readonly [FcrRoomType.Waitingroom, FcrWaitingRoomControl];
+export type FcrUIJoinRoomResponse = FcrBaseRoomControl;
 import { FcrRoomConnectorType, FcrVideoSourceType } from 'fcr-core';
 import { FcrUserRole } from 'fcr-core/lib/type';
+import { FcrUISceneCallbackSchema, FcrUISceneConfigSchema, FcrUISceneFailureCallbackSchema } from './schema';
 export declare enum FcrUIVideoWindowLayoutType {
     /** Show a carousel on top and a big video on the rest of the screen. */
     Speaker = "speaker",
@@ -335,6 +345,10 @@ export declare enum GalleryMaxSize {
     Normal = 16,
     Large = 25
 }
+export declare enum FcrUIRoomType {
+    MAIN_ROOM = "MAIN_ROOM",
+    WAITING_ROOM = "WAITING_ROOM"
+}
 export declare const VideoRatio: number;
 export declare enum FcrUIVideoWindowMainSortingPriority {
     NONE = 0,
@@ -376,6 +390,7 @@ export interface FcrUIVideoWindowData {
     hasLoopbackAudioStream: boolean;
     hasVideoStream: boolean;
     hasScreenSharing: boolean;
+    hasLoopbackSharing: boolean;
     audioStreamConnectorType: FcrRoomConnectorType;
     videoStreamConnectorType: FcrRoomConnectorType;
     userId: string;
@@ -387,4 +402,5 @@ export interface FcrUIVideoWindowData {
     ownerRoleType: FcrUserRole;
     sortingPriority: number;
     phoneMicEnabled?: boolean;
+    hasBoardSharing: boolean;
 }

package/lib/type.js

@@ -16,7 +16,7 @@ Object.defineProperty(exports, "FcrStreamLatencyLevel", {
     return _fcrCore.FcrStreamLatencyLevel;
   }
 });
-exports.FcrUIWindowType = exports.FcrUIVideoWindowMainSortingPriority = exports.FcrUIVideoWindowLayoutType = exports.FcrUIVideoWindowFoldSortingPriority = exports.FcrUIVideoEffectType = exports.FcrUINotificationContentType = exports.FcrUIExitReason = exports.FcrUIConnectType = void 0;
+exports.FcrUIWindowType = exports.FcrUIVideoWindowMainSortingPriority = exports.FcrUIVideoWindowLayoutType = exports.FcrUIVideoWindowFoldSortingPriority = exports.FcrUIVideoEffectType = exports.FcrUIRoomType = exports.FcrUINotificationContentType = exports.FcrUIExitReason = exports.FcrUIConnectType = void 0;
 Object.defineProperty(exports, "FcrUserRole", {
   enumerable: true,
   get: function get() {
@@ -42,6 +42,13 @@ var FcrUIExitReason = exports.FcrUIExitReason = /*#__PURE__*/function (FcrUIExit
 /**
  * FcrUISceneObserver interface represents an observer for a UI scene.
  */
+/**
+ * FcrUIBaseWidgetConfig interface represents the base configuration for a widget.
+ */
+/**
+ * FcrUIWebWidgetConfig interface extends FcrUIBaseWidgetConfig and represents
+ * the configuration for a web-based widget.
+ */
 // Private
 var FcrUIVideoEffectType = exports.FcrUIVideoEffectType = /*#__PURE__*/function (FcrUIVideoEffectType) {
   FcrUIVideoEffectType[FcrUIVideoEffectType["NONE"] = 0] = "NONE";
@@ -58,6 +65,7 @@ var FcrUIConnectType = exports.FcrUIConnectType = /*#__PURE__*/function (FcrUICo
 var FcrUINotificationContentType = exports.FcrUINotificationContentType = /*#__PURE__*/function (FcrUINotificationContentType) {
   FcrUINotificationContentType["WAITING_ROOM"] = "WAITING_ROOM";
   FcrUINotificationContentType["INTERPRETER_STATUS"] = "INTERPRETER_STATUS";
+  FcrUINotificationContentType["TOAST"] = "TOAST";
   return FcrUINotificationContentType;
 }({});
 var FcrUIVideoWindowLayoutType = exports.FcrUIVideoWindowLayoutType = /*#__PURE__*/function (FcrUIVideoWindowLayoutType) {
@@ -70,6 +78,11 @@ var GalleryMaxSize = exports.GalleryMaxSize = /*#__PURE__*/function (GalleryMaxS
   GalleryMaxSize[GalleryMaxSize["Large"] = 25] = "Large";
   return GalleryMaxSize;
 }({});
+var FcrUIRoomType = exports.FcrUIRoomType = /*#__PURE__*/function (FcrUIRoomType) {
+  FcrUIRoomType["MAIN_ROOM"] = "MAIN_ROOM";
+  FcrUIRoomType["WAITING_ROOM"] = "WAITING_ROOM";
+  return FcrUIRoomType;
+}({});
 var VideoRatio = exports.VideoRatio = 19 / 32;
 var FcrUIVideoWindowMainSortingPriority = exports.FcrUIVideoWindowMainSortingPriority = /*#__PURE__*/function (FcrUIVideoWindowMainSortingPriority) {
   FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["NONE"] = 0] = "NONE";

package/lib/ui-manager.d.ts

@@ -14,6 +14,7 @@ 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';
+import { FcrUIWidgetProvider } from './providers/widget-provider';
 export declare class DefaultSceneUIManager {
     private _sceneConfig;
     private _coreConfig;
@@ -21,7 +22,7 @@ export declare class DefaultSceneUIManager {
     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;
+    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, widgetProvider: FcrUIWidgetProvider): () => void;
+    renderWaitingSceneUI(dom: HTMLElement, eventProvider: FcrUIEventProvider, deviceProvider: FcrUIDeviceProvider, roomProvider: FcrUIRoomProviderImpl, sharedConfigDataSource: FcrUISharedConfigDataSource, dialogProvider: FcrUIDialogProvider, messageProvider: FcrUIMessageProvider, sharedLayoutDataSource: FcrUISharedLayoutDataSource, sharedSettingDataSource: FcrUISharedSettingDataSource, sharedDevicePrivilegeDataSource: FcrUISharedDevicePrivilegeDataSource, widgetProvider: FcrUIWidgetProvider): () => void;
     renderLoading(dom: HTMLElement): void;
 }

package/lib/ui-manager.js

@@ -83,7 +83,7 @@ var DefaultSceneUIManager = exports.DefaultSceneUIManager = /*#__PURE__*/functio
     }
   }, {
     key: "renderMainSceneUI",
-    value: function renderMainSceneUI(dom, eventProvider, deviceProvider, roomProvider, sharedConfigDataSource, sharedSettingDataSource, sharedLayoutDataSource, sharedSpeakerSpotlightDataSource, sharedPinDataSource, dialogProvider, messageProvider, sharedVideoWindowDataSource, sharedDevicePrivilegeDataSource) {
+    value: function renderMainSceneUI(dom, eventProvider, deviceProvider, roomProvider, sharedConfigDataSource, sharedSettingDataSource, sharedLayoutDataSource, sharedSpeakerSpotlightDataSource, sharedPinDataSource, dialogProvider, messageProvider, sharedVideoWindowDataSource, sharedDevicePrivilegeDataSource, widgetProvider) {
       var scene = new _mainScene.FcrMainUIScene({
         engine: this._engine,
         eventProvider: eventProvider,
@@ -97,20 +97,20 @@ var DefaultSceneUIManager = exports.DefaultSceneUIManager = /*#__PURE__*/functio
         dialogProvider: dialogProvider,
         messageProvider: messageProvider,
         sharedVideoWindowDataSource: sharedVideoWindowDataSource,
-        sharedDevicePrivilegeDataSource: sharedDevicePrivilegeDataSource
+        sharedDevicePrivilegeDataSource: sharedDevicePrivilegeDataSource,
+        widgetProvider: widgetProvider
       });
       scene.nodeWillActive();
       scene.mount(dom);
       return function () {
-        var _roomProvider$mainRoo;
         scene.unmount(dom);
         scene.nodeWillInactive();
-        (_roomProvider$mainRoo = roomProvider.mainRoomControl) === null || _roomProvider$mainRoo === void 0 || _roomProvider$mainRoo.leave();
+        roomProvider.leaveRoom();
       };
     }
   }, {
     key: "renderWaitingSceneUI",
-    value: function renderWaitingSceneUI(dom, eventProvider, deviceProvider, roomProvider, sharedConfigDataSource, dialogProvider, messageProvider, sharedLayoutDataSource, sharedSettingDataSource, sharedDevicePrivilegeDataSource) {
+    value: function renderWaitingSceneUI(dom, eventProvider, deviceProvider, roomProvider, sharedConfigDataSource, dialogProvider, messageProvider, sharedLayoutDataSource, sharedSettingDataSource, sharedDevicePrivilegeDataSource, widgetProvider) {
       var scene = new _waitingScene.FcrWaitingUIScene({
         engine: this._engine,
         eventProvider: eventProvider,
@@ -121,7 +121,8 @@ var DefaultSceneUIManager = exports.DefaultSceneUIManager = /*#__PURE__*/functio
         messageProvider: messageProvider,
         sharedLayoutDataSource: sharedLayoutDataSource,
         sharedSettingDataSource: sharedSettingDataSource,
-        sharedDevicePrivilegeDataSource: sharedDevicePrivilegeDataSource
+        sharedDevicePrivilegeDataSource: sharedDevicePrivilegeDataSource,
+        widgetProvider: widgetProvider
       });
       scene.nodeWillActive();
       scene.mount(dom);
@@ -129,7 +130,7 @@ var DefaultSceneUIManager = exports.DefaultSceneUIManager = /*#__PURE__*/functio
         scene.unmount(dom);
         scene.nodeWillInactive();
         // roomProvider.waitingRoomControl?.leave();
-        roomProvider.leaveWaitingRoom();
+        roomProvider.leaveRoom();
       };
     }
   }, {

package/lib/ui-scene.d.ts

@@ -1,14 +1,19 @@
 import { FcrUISceneConfig, FcrUISceneCreatorConfig, FcrUISceneObserver, FcrUISettingConfig } from './type';
+import { FcrRegisteredWidgetConfigs } from './modules/widget/type';
 export declare class FcrUIDefaultScene {
     private _config;
     private _creatorConfig;
     private _dom;
     private _settingConfig;
-    constructor(_config: FcrUISceneConfig, _creatorConfig: FcrUISceneCreatorConfig, _dom: HTMLElement, _settingConfig: FcrUISettingConfig);
+    private _registeredWidgetConfigs;
+    constructor(_config: FcrUISceneConfig, _creatorConfig: FcrUISceneCreatorConfig, _dom: HTMLElement, _settingConfig: FcrUISettingConfig, _registeredWidgetConfigs: FcrRegisteredWidgetConfigs);
     exit(): void;
     addObserver(observer: FcrUISceneObserver): void;
     removeObserver(observer: FcrUISceneObserver): void;
     launch(): void;
+    private _removeLocalMeetingTimeKey;
+    private _setLocalMeetingTimeKey;
+    private _resetLocalMeetingTimeKey;
     private _addObservers;
     private _joinRoom;
     private _renderSceneUI;
@@ -16,4 +21,5 @@ export declare class FcrUIDefaultScene {
     private _disposeRoomControl;
     private _handleBeforeUnload;
     private _downloadResources;
+    private _addLogObserver;
 }