@netless/app-slide 0.2.105 → 0.2.106-beta.1

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as _netless_window_manager from '@netless/window-manager';
 import { RegisterParams, ReadonlyTeleBox, Room, AppContext, Player, View, NetlessApp } from '@netless/window-manager';
 import { SlideError, VolumeAdjuster } from '@netless/ppt-player';
 import { IPlugin } from '@netless/plugin-system';
@@ -486,6 +487,7 @@ declare class Slide extends Slide_base {
     private lifecycle;
     private lifecycleGeneration;
     private renderVisibilityTimers;
+    private destroyPromise?;
     private isLoading;
     private isReleasing;
     private interactive;
@@ -744,12 +746,12 @@ declare class Slide extends Slide_base {
     /**
      * Enter freeze state, cache the ppt screen as an image, and release the WebGL context.
      */
-    frozen(callback?: () => void): void;
+    frozen(callback?: () => void): Promise<void>;
     private _doRelease;
     /**
      * Recover from frozen state.
      */
-    release(callback?: () => void): void;
+    release(callback?: () => void): Promise<void>;
     private _doDestroy;
     private waitLoadEnd;
     /**
@@ -761,7 +763,7 @@ declare class Slide extends Slide_base {
     /**
      * Destruction method.
      */
-    destroy(): void;
+    destroy(): Promise<void>;
     /**
      * Destroy the local cache of the current Slide instance, need to be called before destroy.
      */
@@ -1051,11 +1053,12 @@ declare class SlideControllerBase {
     get page(): number;
     protected createSlide(anchor: HTMLDivElement, defaults?: Partial<ISlideConfig>): Slide;
     protected destroyed: boolean;
-    destroy(): void;
+    protected destroyPromise?: Promise<void>;
+    destroy(): Promise<void>;
     timestamp: () => number;
     isFrozen: boolean;
     protected _toFreeze: -1 | 0 | 1;
-    freeze: () => void;
+    freeze: () => Promise<void>;
     unfreeze: () => Promise<void>;
     protected bindAppStateChangeEvent: () => void;
     protected onAppStateChangeHandler: (state: "normal" | "minimized" | "maximized") => void;
@@ -1104,6 +1107,7 @@ declare class ResizableContainer {
     handleNormalizeTranslate(x: number, y: number, options: {
         triggerScrollBar: boolean;
         triggerSync: boolean;
+        force?: boolean;
     }): void;
     scaleContainer(applyScale: number): void;
     private cancelScheduledLayoutUpdate;
@@ -1183,9 +1187,9 @@ declare class SlideDocsViewer {
     protected _onPageChanged: () => void;
     protected refreshPages: () => void;
     protected getPageIndex(page: number): number;
-    unmount(): this;
+    unmount(): Promise<this>;
     setReadonly(readonly: boolean): void;
-    destroy(): void;
+    destroy(): Promise<void>;
     toggleClickThrough(tool?: string): void;
     protected scaleDocsToFit: () => void;
     protected onPlay: () => void;
@@ -1279,7 +1283,8 @@ declare class SlidePreviewer {
         error: Error;
     }) => void;
     protected destroyed: boolean;
-    destroy(): void;
+    protected destroyPromise?: Promise<void>;
+    destroy(): Promise<void>;
     protected refreshPages: () => void;
     protected getPageIndex(page: number): number;
     protected renderSlideContainer(): HTMLDivElement;
@@ -1324,6 +1329,11 @@ interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "
     enableScale?: boolean;
     resourceMaxRetries?: number;
     onResourceMaxRetries: (url: string, error: Error) => void;
+    /**
+     * Max time (ms) `setup()` waits for the first `renderEnd` before resolving
+     * anyway (the slide keeps loading in background). Default: 5_000.
+     */
+    setupReadyTimeout?: number;
 }
 interface ILogger {
     info?(msg: string): void;
@@ -1349,7 +1359,9 @@ interface AppResult {
     onPptMediaPermissionRequest: (callback: () => void) => () => void;
     playPptMedia: () => void;
 }
-declare const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, AppResult>;
+declare const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, AppResult> & {
+    teardown(context: _netless_window_manager.AppContext): Promise<void>;
+};
 
 export { DefaultUrl, DocsViewer, FreezerLength, SideEffectManager, Slide, SlideController, SlideControllerBase, SlideDocsViewer, SlidePreviewer, addHooks, apps, SlideApp as default, getFreezerLength, log, logger, onCreated, onDestroyed, previewSlide, setFreezerLength, syncSceneWithSlide, useFreezer, usePlugin, version };
 export type { AddHooks, AppOptions, AppResult, Attributes, FreezableSlide, ILogger, PreviewParams };