fcr-ui-scene 3.4.4 → 3.5.0

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() {
@@ -30,9 +30,21 @@ var _fcrCore = require("fcr-core");
  * 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;
 }({});
@@ -42,6 +54,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,10 +77,13 @@ 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) {
+  /** 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;
 }({});
@@ -70,6 +92,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;
 }