@netless/app-slide 0.2.98 → 0.2.100-alpha.0

package/dist/index.d.ts

@@ -2,6 +2,8 @@ import { RegisterParams, ReadonlyTeleBox, Room, AppContext, Player, View, Netles
 import { SlideError, VolumeAdjuster } from '@netless/ppt-player';
 import { IPlugin } from '@netless/plugin-system';
 
+declare type SyncEventQueuePolicy = "fifo" | "latest-pending-render";
+
 declare class AliTrackLogger {
     private logList;
     private checkTimer;
@@ -235,6 +237,12 @@ interface ISlideConfig {
      * "local" Local mode, no synchronization events will be triggered
      */
     mode: "interactive" | "sync" | "local" | "addLink";
+    /**
+     * Queue policy for received synchronization events.
+     * Default is "fifo". "latest-pending-render" lets interactive clients skip pending intermediate pages.
+     * Non-interactive modes always use "fifo".
+     */
+    syncEventQueuePolicy?: SyncEventQueuePolicy;
     /**
      * Whether to enable global clicking, after turning on, as long as you click within the ppt viewport range,
      * and do not trigger interactive elements inside ppt, it will trigger the next action.
@@ -303,13 +311,18 @@ interface ISlideConfig {
     skipActionWhenFrozen?: boolean;
     enableAutoForward?: boolean;
     customLinks?: CustomLink[];
+    /**
+     * Disable the built-in ResizeObserver and rely on external notifyFrameResize() calls.
+     * Set this to true when using window-manager's boxSizeChange event as the resize signal.
+     * @default false
+     */
+    disableFrameResizeObserver?: boolean;
     resourceMaxRetries?: number;
     onResourceMaxRetries?: (url: string, error: Error) => void;
 }
 interface MediaState {
     type: "pause" | "play";
     time: number;
-    frozenTime?: number;
     fullscreen?: boolean;
 }
 interface TimeNodeSeqState {
@@ -460,12 +473,14 @@ declare class Slide extends Slide_base {
     private userInputTime;
     private isSyncingSlideState;
     private frozenTaskManager;
+    private frozenMediaTimes;
     private randomId;
     private resize;
     private isAnimating;
     private renderingTaskManager;
     private isLoading;
     private interactive;
+    private syncCatchUpInputBlocked;
     private anchor;
     private tracker;
     private player?;
@@ -481,6 +496,7 @@ declare class Slide extends Slide_base {
     private enableGlobalClick;
     private lastEmitedState;
     private syncQueue;
+    private selfSyncEvents;
     private playerController;
     private lock;
     private isInitResized;
@@ -504,6 +520,10 @@ declare class Slide extends Slide_base {
     private get dispatchIncrId();
     constructor(initConfig: ISlideConfig);
     private _updateVolumeByStaticAdjuster;
+    private handleSyncQueueCompact;
+    private handleSyncQueueCompactRenderComplete;
+    private handleSyncQueueCatchUpStateChange;
+    private updatePlayerInteractive;
     private recoverHandler;
     private reportError;
     initSlideConfig(config: ISlideConfig): ISlideConfig;
@@ -522,6 +542,12 @@ declare class Slide extends Slide_base {
     private updateStageCountLimit;
     private setMedianControllerAttribute;
     private frameResizeHandler;
+    /**
+     * Notify the slide that its frame container may have changed size.
+     * Call this when using an external resize signal (e.g. window-manager's boxSizeChange event)
+     * instead of the built-in ResizeObserver.
+     */
+    notifyFrameResize(): void;
     /**
      *  Update ppt fixed height and width, this method only takes effect when the fixedFrameSize configuration item is set.
      * @param width Width value that needs to be updated, unit px.
@@ -644,6 +670,7 @@ declare class Slide extends Slide_base {
      * @param isForward Whether to flip forward or backward, affecting the page transition animation.
      */
     doRenderSlide(index: number, isForward?: boolean): Promise<void>;
+    private enqueueRenderSlide;
     getSnapshot(): string | null;
     /**
      * 执行下一个主序列动画
@@ -669,6 +696,11 @@ declare class Slide extends Slide_base {
      * @param val boolean
      */
     setInteractive(val: boolean): void;
+    /**
+     * Set how received synchronization events are scheduled.
+     * Changing the policy does not reorder or clear the current pending queue by itself.
+     */
+    setSyncEventQueuePolicy(policy: SyncEventQueuePolicy): void;
     /**
      * Pause playback, asynchronous operation.
      */
@@ -689,6 +721,10 @@ declare class Slide extends Slide_base {
     release(callback?: () => void): void;
     private _doDestroy;
     private waitLoadEnd;
+    /**
+     * Preload a slide. Destroying or evicting the pending slide rejects with
+     * PreloadCancelledError.
+     */
     preload(index: number): Promise<void>;
     preloadResource(index: number): Promise<void>;
     /**
@@ -1008,7 +1044,6 @@ declare class ResizableContainer {
     private whiteboardContainer;
     private slide;
     private scale;
-    private resizeObserver;
     private slideWidth;
     private slideHeight;
     private scrollBar;
@@ -1016,7 +1051,7 @@ declare class ResizableContainer {
     private translateX;
     private translateY;
     private enableResize;
-    constructor(parent: HTMLElement, context: AppContext<Attributes, MagixEvents, AppOptions>, enableResize: boolean);
+    constructor(parent: HTMLElement, context: AppContext<Attributes, MagixEvents, AppOptions>, enableResize: boolean, _box?: ReadonlyTeleBox);
     getTranslate(): {
         x: number;
         y: number;
@@ -1034,7 +1069,7 @@ declare class ResizableContainer {
     addSlideContainer(slideContainer: HTMLDivElement): void;
     addWhiteboardContainer(whiteboardContainer: HTMLDivElement): void;
     getCurrentScale(): number;
-    destroy(): void;
+    destroy(_box?: ReadonlyTeleBox): void;
 }
 
 type MountSlideOptions = Omit<SlideControllerOptions, "context" | "onPageChanged"> & {
@@ -1066,18 +1101,36 @@ declare class SlideDocsViewer {
     protected readonly appId: string;
     protected isViewMounted: boolean;
     protected justSildeReadonly: boolean;
+    protected syncEventQueuePolicy: SyncEventQueuePolicy;
     private enableScale;
+    private boxSizeEventCount;
+    private latestBoxSize;
+    private lastObserverSize;
+    private lastAppliedSize;
+    private lastAppliedSource;
+    private offBoxSizeChange;
+    private contentResizeObserver;
     constructor({ context, box, view, mountSlideController, mountWhiteboard, baseScenePath, appId, urlInterrupter, enableScale, onPagesReady, onNavigate, }: SlideDocsViewerConfig);
     $slide: HTMLDivElement;
     $whiteboardView: HTMLDivElement;
     $overlay: HTMLDivElement;
     resizableContainer: ResizableContainer;
     setJustSildeReadonly(justSildeReadonly: boolean): void;
+    setSyncEventQueuePolicy(policy: SyncEventQueuePolicy): void;
+    protected applyInteractionState(): void;
     render(): void;
     protected renderOverlay(): HTMLDivElement;
     protected renderSlideContainer(): HTMLDivElement;
     protected renderWhiteboardView(): HTMLDivElement;
     mount(): this;
+    private _getContentSize;
+    private _applyResize;
+    private _applyCurrentBoxSize;
+    private _onObserverSize;
+    private _reconnectContentObserver;
+    private _observeContentSize;
+    private _onContextBoxSizeChange;
+    private _registerBoxSizeChange;
     protected onError: ({ error, index }: {
         error: Error;
         index: number;
@@ -1198,7 +1251,7 @@ declare class SlidePreviewer {
 declare const usePlugin: (plugin: any) => any;
 declare const version: string;
 
-interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "resourceTimeout" | "loaderDelegate" | "urlInterrupter" | "navigatorDelegate" | "fixedFrameSize" | "logger" | "enableGlobalClick" | "skipActionWhenFrozen"> {
+interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "resourceTimeout" | "loaderDelegate" | "urlInterrupter" | "navigatorDelegate" | "fixedFrameSize" | "logger" | "enableGlobalClick" | "skipActionWhenFrozen" | "syncEventQueuePolicy"> {
     /** show debug controller */
     debug?: boolean;
     /** scale */
@@ -1247,6 +1300,7 @@ interface AppResult {
     prevPage: () => boolean;
     jumpToPage: (page: number) => boolean;
     setSildeReadonly: (bol: boolean) => void;
+    setSyncEventQueuePolicy: (policy: NonNullable<ISlideConfig["syncEventQueuePolicy"]>) => void;
     onScaleChanged: (cb: (scale: number) => void) => void;
     scaleView: (to: number) => void;
     getViewScale: () => number | undefined;