fcr-ui-scene 3.4.1 → 3.4.2

package/lib/type.js

@@ -16,14 +16,16 @@ 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.
  */
@@ -39,4 +41,67 @@ 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) {
+  FcrUIVideoWindowLayoutType["Speaker"] = "speaker";
+  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;
 }