fcr-ui-scene 3.1.1 → 3.3.0

package/lib/type.d.ts

@@ -1,4 +1,4 @@
-import { FcrError, FcrUserRole as FcrUIUserRole } from 'agora-edu-core';
+import { FcrBaseRoomControl, FcrError, FcrUserRole as FcrUIUserRole } from 'agora-edu-core';
 export { FcrUserRole, FcrRegion, FcrStreamLatencyLevel } from 'agora-edu-core';
 /**
  * FcrUIExitReason enum represents the reason for exiting a UI scene.
@@ -75,6 +75,10 @@ export interface FcrUISceneConfig {
      * UI Resources such as virtual background images and videos.
      */
     resource?: FcrUIResource;
+    /**
+     * The password for the room.
+     */
+    password?: string;
 }
 /**
  * FcrUISceneObserver interface represents an observer for a UI scene.
@@ -104,4 +108,4 @@ export interface FcrUISceneObserver {
 export type FcrUISceneCancelCallback = (roomId: string) => void;
 export type FcrUISceneSuccessCallback = (roomId: string) => void;
 export type FcrUISceneFailureCallback = (roomId: string, error: FcrError) => void;
-export type FcrUISceneExitCallback = (roomId: string, reason: FcrUIExitReason) => void;
+export type FcrUISceneExitCallback = (roomId: string, reason: FcrUIExitReason, roomControl?: FcrBaseRoomControl) => void;

package/lib/ui-manager.d.ts

@@ -1,4 +1,4 @@
-import { FcrCoreEngine, FcrMainRoomControl } from 'agora-edu-core';
+import { FcrCoreEngine } from 'agora-edu-core';
 import { FcrUISceneConfig, FcrUISceneObserver } from './type';
 import { FcrCoreEngineConfig } from 'agora-edu-core/lib/type';
 import { AgoraObservable } from 'agora-foundation/lib/utilities/observable';
@@ -6,12 +6,16 @@ export declare class DefaultSceneUIManager {
     private _sceneConfig;
     private _coreConfig;
     private _engine;
-    private _roomControl;
     private _observable;
-    constructor(_sceneConfig: FcrUISceneConfig, _coreConfig: FcrCoreEngineConfig, _engine: FcrCoreEngine, _roomControl: FcrMainRoomControl, _observable: AgoraObservable<FcrUISceneObserver>);
+    constructor(_sceneConfig: FcrUISceneConfig, _coreConfig: FcrCoreEngineConfig, _engine: FcrCoreEngine, _observable: AgoraObservable<FcrUISceneObserver>);
     render(dom: HTMLElement): void;
     destroy(): void;
     private _handleJoinRoom;
     private _renderDevicePretestUi;
     private _renderRoomUi;
+    private _renderWaitingRoomUi;
+    private _getJoinRoomOption;
+    private _createRoomControl;
+    private _judgeWaitingRoomPremissionAndCreateRoomControl;
+    private _destroyWaitingRoom;
 }