@netless/app-slide 0.2.32 → 0.2.33

package/dist/index.d.ts

@@ -1,20 +1,974 @@
-import type { NetlessApp } from "@netless/window-manager";
-import type { ISlideConfig } from "@netless/slide";
-import type { Attributes, MagixEvents } from "./typings";
-import type { AddHooks, FreezableSlide } from "./utils/freezer";
-import { Slide } from "@netless/slide";
-import { DefaultUrl, SlideController } from "./SlideController";
-import { SlideDocsViewer } from "./SlideDocsViewer";
-import { apps, FreezerLength, addHooks } from "./utils/freezer";
-export type { PreviewParams } from "./SlidePreviewer";
-export { SlidePreviewer, default as previewSlide } from "./SlidePreviewer";
-export type { Attributes, AddHooks, FreezableSlide };
-export { Slide };
-export declare const usePlugin: (plugin: any) => any;
-export declare const version: string;
-export { DefaultUrl, apps, FreezerLength, addHooks };
-export { setFreezerLength, getFreezerLength, onCreated, onDestroyed } from "./utils/freezer";
-export interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "resourceTimeout" | "loaderDelegate" | "navigatorDelegate" | "fixedFrameSize" | "logger"> {
+import { ReadonlyTeleBox, RegisterParams, AppContext, View, NetlessApp } from '@netless/window-manager';
+import { VolumeAdjuster, SlideError } from '@netless/ppt-player';
+import { IPlugin } from '@netless/plugin-system';
+
+interface ILoaderDelegate {
+    /**
+     * 加载 json 资源, 需返回 json 文本
+     * @param url 原始资源地址
+     */
+    loadJson(url: string): Promise<string>;
+    /**
+     * 加载图片资源, 需返回 Blob 对象
+     * @param url 原始资源地址
+     */
+    loadImage(url: string): Promise<Blob>;
+    /**
+     * 媒体文件重定向, mp3 和 mp4 资源会调用这个代理函数, 需返回重定向后的 url
+     * @param url 原始资源地址
+     */
+    redirectMedia(url: string): string;
+}
+interface RtcAudio {
+    /**
+     * 开始播放音频.
+     */
+    play(): void;
+    /**
+     * 暂停音频播放, 且音频当前播放时间不变
+     */
+    pause(): void;
+    /**
+     * 当音频对象不再使用时候被调用
+     */
+    destroy(): void;
+    /**
+     * 设置音量, 参数值范围 0 ~ 1
+     */
+    volume(value: number): void;
+    /**
+     * 获取音频当前播放时间, 单位为:秒
+     */
+    get currentTime(): number;
+    /**
+     * 设置音频当前播放时间, 单位为:秒。需注意, 无论音频是否正在播放, 都需要确保能设置成功。
+     * 如果音频暂停状态下, 设置此值, 那么需保证, 下次恢复播放是从此值位置开始播放。
+     */
+    set currentTime(time: number);
+    /**
+     * 返回音频是否暂停状态
+     */
+    get isPaused(): boolean;
+    /**
+     * 返回音频时长
+     */
+    get duration(): number;
+    /**
+     * 当音频加载完成时触发, 例如: 音频 meta 数据加载完成, 这时候知道了音频实际时长, 就需要触发此事件, 需要保证此事件触发时,
+     * 能通过 duration 属性获取到更新后的音频时长
+     * @param event
+     * @param listener
+     */
+    on(event: "load", listener: () => void): this;
+    /**
+     * 当音频暂停时候触发
+     * @param event
+     * @param listener
+     */
+    on(event: "pause", listener: () => void): this;
+    /**
+     * 当音频开始播放时候触发
+     * @param event
+     * @param listener
+     */
+    on(event: "play", listener: () => void): this;
+    /**
+     * 移除参数指定事件的所有监听器
+     */
+    removeAllListeners(event: string): void;
+}
+interface RtcAudioClazz {
+    /**
+     * 创建 rtc 播放器, url 为音频地址
+     * @param url
+     */
+    new (url: string): RtcAudio;
+}
+interface ILogger$1 {
+    info?(msg: string): void;
+    error?(msg: string): void;
+    warn?(msg: string): void;
+}
+declare const SLIDE_EVENTS: {
+    /** 同步事件派发 */
+    readonly syncDispatch: "syncDispatch";
+    /** 同步事件接收 */
+    readonly syncReceive: "syncReceive";
+    /**
+     * 同步模式下才会触发这个事件, 指示同步消息滞后, 需要全量同步
+     */
+    readonly syncEventLag: "syncEventLag";
+    /** 当前 slide 渲染开始触发 */
+    readonly renderStart: "renderStart";
+    /** 当前 slide 渲染完毕触发 */
+    readonly renderEnd: "renderEnd";
+    /** 当前 slide 渲染出错触发 */
+    readonly renderError: "renderError";
+    /** slide 页码变化时触发 */
+    readonly slideChange: "slideChange";
+    /** 主序列动画开始时触发 */
+    readonly mainSeqStepStart: "mainSeqStepStart";
+    /** 主序列动画结束时触发 */
+    readonly mainSeqStepEnd: "mainSeqStepEnd";
+    /**
+     * 任意动画开始时触发
+     */
+    readonly animateStart: "animateStart";
+    /**
+     * 任意动画结束时触发
+     */
+    readonly animateEnd: "animateEnd";
+    /** slide 状态变化触发 */
+    readonly stateChange: "stateChange";
+    /** ppt 已经没有下一步动作触发 **/
+    readonly slideStepEnd: "slideEnd";
+    /** ppt 已经没有上一步动作触发 **/
+    readonly slideStepStart: "slideStart";
+};
+interface ISlideRenderOptions {
+    /** 预期最低渲染 fps, 默认 40 */
+    minFPS?: number;
+    /** 预期最高渲染 fps, 默认 50 */
+    maxFPS?: number;
+    /** 渲染分辨倍率, 整数,  默认为 window.devicePixelRatio */
+    resolution?: number;
+    /** 是否根据 fps, 自动调整分辨率, 默认为 false */
+    autoResolution?: boolean;
+    /** 是否自动降低渲染 fps */
+    autoFPS?: boolean;
+    /** 播放切页动画时候的背景颜色, 接受 css 颜色字符串或者 16进制颜色值("#ffffff",0xffffff) */
+    transactionBgColor?: string | number;
+    /**
+     * 用于设置最高显示分辨率。此值不仅影响 canvas 渲染分辨率, 同时也影响纹理质量，
+     * 在低端设备, 降低此值能极大改善内存占用及图片黑屏现象.
+     * [1] 最低 960 * 540, 小于 1 按 1 计算;
+     * [2] 普通 1280 * 720;                 --- 移动端默认设置.
+     * [3] 高清 1920 * 1080;
+     * [4] 3K 3200 × 1800, 大于 4 按 4 计算; --- pc 端默认设置.
+     * 默认情况下, pc 设备 3K, 移动设备 720P
+     */
+    maxResolutionLevel?: number;
+    /**
+     * 是否强制使用 2d 渲染, 强制使用 2d 渲染会丢失部分 3d、滤镜、特效
+     */
+    forceCanvas?: boolean;
+    /**
+     * @deprecated 当前版本已经修复花屏问题, 无需开启这个参数
+     * 是否开启 NVIDIA 显卡检测, windows 11 配合 NVIDIA 显卡在
+     * 播放部分切页动画时会花屏。
+     * 开启这个选项, 会自动检测是否 NVIDIA, 如果是 NVIDIA 显卡则
+     * 使用不同的逻辑播放切页动画, 不会花屏, 但是切页响应会慢 200 ~ 1000 ms
+     */
+    enableNvidiaDetect?: boolean;
+}
+interface INavigatorDelegate {
+    gotoPage(index: number): void;
+}
+interface ISlideConfig {
+    /** canvas 挂载点 */
+    anchor: HTMLDivElement;
+    /** 是否可互动 */
+    interactive: boolean;
+    /** 渲染选项, 可选 */
+    renderOptions?: ISlideRenderOptions;
+    /** 是否展示控制栏和stats */
+    controller?: boolean;
+    /** 是否根据窗口大小自动调整分辨率 */
+    resize?: boolean;
+    /** 获取房间时间 */
+    timestamp?: () => number;
+    /**
+     * 运行模式
+     *
+     * "interactive" 互动模式, 所有人都可以操作 ppt
+     * "sync" 同步模式, 只有一个人能操作 ppt
+     * "local" 本地模式, 不会触发任意同步事件
+     */
+    mode: "interactive" | "sync" | "local";
+    /**
+     * 是否启用全局点击, 开启后, 只要点击到 ppt 视口范围,
+     * 并且没有触发 ppt 内部可互动元素, 就会触发下一步动作.
+     * 默认为 false
+     */
+    enableGlobalClick?: boolean;
+    /**
+     * 提供的音频播放器类, 用于 rtc 混音
+     */
+    rtcAudio?: RtcAudioClazz;
+    /**
+     * 提供 logger 对象, 用以记录运行日志
+     */
+    logger?: ILogger$1;
+    /**
+     * 是否启用本地缓存，启用后会将 ppt 远程资源缓存在 indexDB 中
+     * 默认为 true
+     */
+    useLocalCache?: boolean;
+    /**
+     * 资源加载超时时间, 默认 15 秒
+     */
+    resourceTimeout?: number;
+    /**
+     * 远程资源代理, 详细使用参考 README
+     */
+    loaderDelegate?: ILoaderDelegate;
+    /**
+     * ppt 页码导航代理, 添加此属性后, ppt 内部动作引起的页码变换, 全部走代理逻辑.
+     */
+    navigatorDelegate?: INavigatorDelegate;
+    /**
+     * 设置 ppt 固定高宽, 设置后 ppt 不会跟随父元素的大小自动变化
+     * 如果有缩放需求，需要调用 updateFixedFrameSize 方法
+     * width 及 height 属性单位为 px
+     */
+    fixedFrameSize?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * 客户端 id, 在同步及互动场景下, 需要能区分每个不同的客户端。对于收到同步消息的一端来说, 需要用这个
+     * clientId 区分是不是自己发出的消息又被自己接收了。
+     * 如果同步及互动场景下, 没有给这个值会造成某些情况下的状态不同步，已知的场景有:
+     * 1. ppt 某一页有自动动画, 动画过程中进行的下一步动作, 在其他客户端可能表现为下一页(即翻页)
+     */
+    clientId?: string;
+}
+interface MediaState {
+    type: "pause" | "play";
+    time: number;
+    frozenTime?: number;
+    fullscreen?: boolean;
+}
+interface TimeNodeSeqState {
+    step: number;
+    state: "idle" | "running" | "end" | null;
+}
+interface ISlideState {
+    taskId: string;
+    url: string;
+    currentSlideIndex: number;
+    mainSeqStep: number;
+    mainSeqState: "idle" | "running" | "end" | null;
+    mediaState: {
+        [key: string]: MediaState;
+    };
+    interactiveSeqState: {
+        [key: string]: TimeNodeSeqState;
+    };
+}
+declare type SyncEvent = SyncInteractiveAnimEvent | SyncPrevStepEvent | SyncNextStepEvent | SyncRenderSlideEvent | SyncSetResourceEvent | SyncMediaPlayEvent | SyncMediaPauseEvent | SyncMediaSeekEvent | SyncMediaFullscreenEvent;
+interface BasicSyncEvent {
+    slideIndex: number;
+    uuid?: string;
+    incrId?: number;
+    clientId?: string;
+}
+interface SyncMediaPlayEvent extends BasicSyncEvent {
+    type: "mediaPlay";
+    id: string;
+    state: MediaState;
+}
+interface SyncMediaPauseEvent extends BasicSyncEvent {
+    type: "mediaPause";
+    id: string;
+    state: MediaState;
+}
+interface SyncMediaSeekEvent extends BasicSyncEvent {
+    type: "mediaSeek";
+    id: string;
+    time: number;
+    state: MediaState;
+}
+interface SyncMediaFullscreenEvent extends BasicSyncEvent {
+    type: "mediaFullscreen";
+    targetId: string;
+    state: boolean;
+}
+interface SyncInteractiveAnimEvent extends BasicSyncEvent {
+    type: "interactiveAnim";
+    action: string;
+    seqId: string;
+}
+interface SyncPrevStepEvent extends BasicSyncEvent {
+    type: "prevStep";
+    next: number;
+}
+interface SyncNextStepEvent extends BasicSyncEvent {
+    type: "nextStep";
+    next: number;
+}
+interface SyncRenderSlideEvent extends BasicSyncEvent {
+    type: "renderSlide";
+    index: number;
+    isForward: boolean;
+}
+interface SyncSetResourceEvent extends BasicSyncEvent {
+    type: "setResource";
+    taskId: string;
+    url: string;
+}
+interface SlideEventEmitter {
+    removeAllListeners(): this;
+    removeListener(event: keyof typeof SLIDE_EVENTS, fn?: any): this;
+    emit(event: typeof SLIDE_EVENTS.renderStart, index: number): boolean;
+    on(event: typeof SLIDE_EVENTS.renderStart, listener: (index: number) => void): this;
+    emit(event: typeof SLIDE_EVENTS.renderEnd, index: number): boolean;
+    on(event: typeof SLIDE_EVENTS.renderEnd, listener: (index: number) => void): this;
+    emit(event: typeof SLIDE_EVENTS.slideChange, nextSlideIndex: number): boolean;
+    on(event: typeof SLIDE_EVENTS.slideChange, listener: (nextSlideIndex: number) => void): this;
+    emit(event: typeof SLIDE_EVENTS.syncDispatch, args: SyncEvent): boolean;
+    on(event: typeof SLIDE_EVENTS.syncDispatch, listener: (event: SyncEvent) => void): this;
+    emit(event: typeof SLIDE_EVENTS.syncReceive, args: SyncEvent): boolean;
+    on(event: typeof SLIDE_EVENTS.syncReceive, listener: (event: SyncEvent) => void): this;
+    emit(event: typeof SLIDE_EVENTS.renderError, args: {
+        error: SlideError;
+        index: number;
+    }): boolean;
+    on(event: typeof SLIDE_EVENTS.renderError, listener: (args: {
+        error: SlideError;
+        index: number;
+    }) => void): this;
+    emit(event: typeof SLIDE_EVENTS.animateStart): boolean;
+    on(event: typeof SLIDE_EVENTS.animateStart, listener: () => void): this;
+    emit(event: typeof SLIDE_EVENTS.animateEnd): boolean;
+    on(event: typeof SLIDE_EVENTS.animateEnd, listener: () => void): this;
+    emit(event: typeof SLIDE_EVENTS.mainSeqStepStart, index: number): boolean;
+    on(event: typeof SLIDE_EVENTS.mainSeqStepStart, listener: (index: number) => void): this;
+    emit(event: typeof SLIDE_EVENTS.mainSeqStepEnd, index: number): boolean;
+    on(event: typeof SLIDE_EVENTS.mainSeqStepEnd, listener: (index: number) => void): this;
+    emit(event: typeof SLIDE_EVENTS.stateChange, state: ISlideState): boolean;
+    on(event: typeof SLIDE_EVENTS.stateChange, listener: (state: ISlideState) => void): this;
+    emit(event: typeof SLIDE_EVENTS.syncEventLag): boolean;
+    on(event: typeof SLIDE_EVENTS.syncEventLag, listener: () => void): this;
+    emit(event: typeof SLIDE_EVENTS.slideStepEnd): boolean;
+    on(event: typeof SLIDE_EVENTS.slideStepEnd, listener: () => void): this;
+    emit(event: typeof SLIDE_EVENTS.slideStepStart): boolean;
+    on(event: typeof SLIDE_EVENTS.slideStepStart, listener: () => void): this;
+}
+declare const Slide_base: new () => SlideEventEmitter;
+declare class Slide extends Slide_base {
+    static instances: Slide[];
+    static _tempFrozenIds: string[];
+    static _tempLog: string;
+    static _tempLogIndex: number;
+    static flushLog(force?: boolean): Promise<void>;
+    static remoteLogAddress: string | null;
+    static stopRemoteLog(): void;
+    static startRemoteLog(address: string): Promise<void>;
+    static appendLogString(logStr: string): void;
+    static usePlugin: (plugin: IPlugin) => void;
+    /**
+     * 设置全局音量, 对所有 Slide 实例都生效
+     */
+    static volumeAdjuster: VolumeAdjuster;
+    private iosResetCache;
+    private iosNewPlayer?;
+    private needClearCacheImage;
+    private version?;
+    private __slideState;
+    private userInputTime;
+    private isSyncingSlideState;
+    private frozenTaskManager;
+    private randomId;
+    private resize;
+    private isAnimating;
+    private renderingTaskManager;
+    private isLoading;
+    private interactive;
+    private anchor;
+    private player?;
+    private renderingIndex;
+    private frameWidth;
+    private frameHeight;
+    private frame;
+    private canvasContainer;
+    private medianController;
+    private frameResizeObserver;
+    private timestamp;
+    private mode;
+    private enableGlobalClick;
+    private lastEmitedState;
+    private syncQueue;
+    private playerController;
+    private lock;
+    private isInitResized;
+    private cacheImage;
+    private config;
+    private isTouchStart;
+    private touchStartId;
+    private taskId;
+    private volumeAdjuster;
+    private designWidth;
+    private designHeight;
+    private _slideCount;
+    private logger;
+    private _dispatchIncrId;
+    private _receiveIncrId;
+    private get dispatchIncrId();
+    constructor(initConfig: ISlideConfig);
+    private _updateVolumeByStaticAdjuster;
+    private recoverHandler;
+    private reportError;
+    initSlideConfig(config: ISlideConfig): ISlideConfig;
+    static handleFrozenAllSlide: () => void;
+    static handleReleaseAllSlide: () => void;
+    static handleLogReport: (sessionId: string) => Promise<void>;
+    static handleLogDownload: () => Promise<void>;
+    private initPlayer;
+    private userInputHandle;
+    private handleViewClick;
+    private handleViewTouchStart;
+    private handleViewTouchEnd;
+    private createController;
+    private handleSlideRef;
+    private setMedianControllerAttribute;
+    private frameResizeHandler;
+    /**
+     *  更新 ppt 固定高宽, 此方法只有在设置了 fixedFrameSize 配置项的情况下才会生效
+     * @param width 需要更新的宽度值, 单位 px
+     * @param height 需要更新的高度值, 单位 px
+     */
+    updateFixedFrameSize(width: number, height: number, callback?: () => void): void;
+    private resizeView;
+    private receiveSyncHandler;
+    /**
+     * 设置整个 slide 的状态, slide 会以传入的状态更新画面.
+     * 供整体同步时候调用.
+     * @param state ISlideState
+     */
+    setSlideState(state: Partial<ISlideState>): Promise<void>;
+    private initInteractiveSeq;
+    private initMedia;
+    /**
+     * 返回 slide 总页数
+     */
+    get slideCount(): number;
+    /**
+     * 获取 slide 设计高宽, 单位为 px, 返回数组形式为 [width, height]
+     * 可以在 renderSlide 之前调用
+     */
+    getSizeAsync(): Promise<[number, number]>;
+    /**
+     * 获取 slide 总页数, 可以在 renderSlide 之前调用
+     */
+    getSlideCountAsync(): Promise<number>;
+    /**
+     * 整个 slide 的状态, 将获取的值传递给另一个客户端, 并调用 setSlideState
+     * 可以完成整体同步. 只读属性.
+     * @readonly
+     */
+    get slideState(): ISlideState;
+    /**
+     * 主序列动画步数, 只读属性
+     * @readonly
+     */
+    get mainSeqLength(): number;
+    /**
+     * 主序列动画, 当前步, 只读属性
+     * @readonly
+     */
+    get mainSeqStep(): number;
+    /**
+     * 主序列动画, 当前状态, 只读属性
+     *   "idle": 动画尚未运行
+     *   "running": 动画运行中
+     *   "end": 动画已经结束
+     *   null: 当前 Slide 没有主序列动画
+     * @readonly
+     */
+    get mainSeqState(): "idle" | "running" | "end" | null;
+    /**
+     * 实时渲染属性, 只读属性.
+     * @readonly
+     */
+    get renderOptions(): ISlideRenderOptions | null;
+    /**
+     * drawCall 次数, 即每帧调用 gpu drawElements 次数, 只读属性.
+     * @readonly
+     */
+    get drawCall(): number;
+    /**
+     * 渲染 fps, 只读属性.
+     * @readonly
+     */
+    get renderFps(): number;
+    /**
+     * js 运行时 fps, 只读属性.
+     * @readonly
+     */
+    get runtimeFps(): number;
+    /**
+     * 渲染 Slide 的 canvas 元素.
+     * @readonly
+     */
+    get view(): HTMLCanvasElement | null;
+    /**
+     * Slide 宽度. 此宽度为设计宽度, 由 ppt 决定. 只读属性.
+     * @readonly
+     */
+    get width(): number;
+    /**
+     * Slide 高度. 此高度为设计高度, 由 ppt 决定. 只读属性.
+     * @readonly
+     */
+    get height(): number;
+    /**
+     * 更新渲染属性
+     * @param renderOptions
+     */
+    updateRenderOption(renderOptions: ISlideRenderOptions): void;
+    /**
+     * 设置 ppt 转换后的资源
+     * @param taskId 转换任务 id
+     * @param url 资源 url 前缀
+     */
+    setResource(taskId: string, url: string): void;
+    private _renderSlide;
+    private handlePrevSlide;
+    private handleNextSlide;
+    private handleGotoSlide;
+    /**
+     * 渲染 index 参数对应的 ppt 页.
+     * @param index 要显示的页码, 从 1 开始
+     */
+    renderSlide(index: number, isForward?: boolean): void;
+    private needCreateNewPlayer;
+    private poseRenderSlide;
+    /**
+     * 直接渲染 index 指定的页码, 不论当前是 sync 还是 interactive 模式.
+     * 即调用此方法不会触发 syncDispatch 事件
+     * @param index 要渲染的页码
+     * @param isForward 是否向前翻页, 影响切页动画时正放还是倒放
+     */
+    doRenderSlide(index: number, isForward?: boolean): Promise<void>;
+    getSnapshot(): string | null;
+    /**
+     * 执行下一个主序列动画
+     */
+    nextStep(): void;
+    private doNextStep;
+    /**
+     * 执行上一个主序列动画
+     */
+    prevStep(): void;
+    private doPrevStep;
+    private isSlideStateReady;
+    private emitStateChange;
+    private emitSyncDispatch;
+    /**
+     * 重置主序列动画
+     * @param index 将要重置到的步数
+     * @param status 将要重置到的状态, "start" 重置到动画开始, "end" 重置到动画结束
+     */
+    setMainSeqStep(index: number, status: "start" | "end"): void;
+    /**
+     * 设置是否可以互动
+     * @param val boolean
+     */
+    setInteractive(val: boolean): void;
+    /**
+     * 暂停播放, 非同步操作
+     */
+    pause(): void;
+    /**
+     * 恢复播放状态, 非同步操作
+     */
+    resume(): void;
+    private _doFrozen;
+    /**
+     * 进入冻结状态, 将 ppt 画面缓存为一张图片, 并释放 webgl 上下文
+     */
+    frozen(): void;
+    private _doRelease;
+    /**
+     * 从冻结状态恢复
+     */
+    release(): void;
+    private _doDestroy;
+    private waitLoadEnd;
+    preload(index: number): Promise<void>;
+    /**
+     * 销毁方法.
+     */
+    destroy(): void;
+    /**
+     * 销毁当前 Slide 实例的本地缓存, 需要在 destroy 之前调用。
+     */
+    clearSlideCache(): void;
+    /**
+     * 返回 ppt 是否存在下一步动作
+     */
+    hasNextStep(): boolean;
+    /**
+     * 返回 ppt 是否存在上一步动作
+     */
+    hasPrevStep(): boolean;
+    /**
+     * 截取当前状态的截图
+     * @return 图片 dataUrl, 如果失败则返回 null
+     */
+    snapshot(): Promise<string | null>;
+    /**
+     * 截取动画最后一步状态的截图
+     * @param index 要截取的页码
+     * @return 图片 dataUrl, 如果失败则返回 null
+     */
+    snapshotWithTimingEnd(index: number): Promise<string | null>;
+    /**
+     * 设置此 Slide 实例全局音量, 非同步操作, 只会修改本地音量，不会触发同步事件
+     * @param v 数值范围 0 ~ 1
+     */
+    updateGlobalVolume(v: number): void;
+    /**
+     * 获取此 Slide 实例全局音量
+     */
+    getGlobalVolume(): number;
+    /**
+     * 销毁历史所有本地缓存
+     */
+    static clearLocalCache(): void;
+    /**
+     * @deprecated 该 api 已经失效, 请用 slideInstance.clearSlideCache 和 Slide.clearLocalCache 替代
+     */
+    static disposeLocalCache(): void;
+}
+
+declare type SlideState = Slide["slideState"];
+interface Attributes {
+    /** convert task id */
+    taskId: string;
+    /** base url of converted resources */
+    url: string;
+    /** internal state of slide, do not change */
+    state: SlideState | null;
+}
+declare type MagixPayload = {
+    type: typeof SLIDE_EVENTS.syncDispatch;
+    payload: SyncEvent;
+};
+declare type MagixEvents = {
+    [SLIDE_EVENTS.syncDispatch]: MagixPayload;
+};
+
+interface FreezableSlide {
+    freeze: () => void;
+    unfreeze: () => void;
+}
+declare let FreezerLength: number;
+declare function getFreezerLength(): number;
+/** @param length - must be >= 1, default is 2 */
+declare function setFreezerLength(length: number): void;
+declare const apps: {
+    map: Map<string, FreezableSlide>;
+    boxes: Map<string, ReadonlyTeleBox>;
+    queue: string[];
+    validateQueue(): void;
+    set(appId: string, slide: FreezableSlide, box: ReadonlyTeleBox): void;
+    delete(appId: string): void;
+    focus(appId: string): void;
+};
+declare function onCreated(callback: (appId: string) => void): () => boolean;
+declare function onDestroyed(callback: (appId: string) => void): () => boolean;
+declare type AddHooks = NonNullable<RegisterParams["addHooks"]>;
+/**
+ * Put this function in your register code:
+ * `WindowManager.register({ kind: 'Slide', src: SlideApp, addHooks })`
+ * So that it will automatically freeze the app when it is not in focus.
+ */
+declare const addHooks: AddHooks;
+
+declare type SideEffectDisposer = () => any;
+declare class SideEffectManager {
+    /**
+     * Add a disposer directly.
+     * @param disposer a disposer or a list of disposers
+     * @param disposerID Optional id for the disposer
+     * @returns disposerID
+     */
+    addDisposer(disposer: SideEffectDisposer | SideEffectDisposer[], disposerID?: string): string;
+    /**
+     * @alias addDisposer
+     * Add a disposer directly.
+     * @param disposer a disposer or a list of disposers
+     * @param disposerID Optional id for the disposer
+     * @returns disposerID
+     */
+    push: (disposer: SideEffectDisposer | SideEffectDisposer[], disposerID?: string) => string;
+    /**
+     * Add a side effect.
+     * @param executor Executes side effect. Return a disposer or a list of disposers. Returns null or false to ignore.
+     * @param disposerID Optional id for the disposer
+     * @returns disposerID
+     */
+    add(executor: () => SideEffectDisposer | SideEffectDisposer[] | null | false, disposerID?: string): string;
+    /**
+     * Sugar for addEventListener.
+     * @param el
+     * @param type
+     * @param listener
+     * @param options
+     * @param disposerID Optional id for the disposer
+     * @returns disposerID
+     */
+    addEventListener<K extends keyof WindowEventMap>(el: Window, type: K, listener: (this: Window, ev: WindowEventMap[K]) => unknown, options?: boolean | AddEventListenerOptions, disposerID?: string): string;
+    addEventListener<K extends keyof DocumentEventMap>(el: Document, type: K, listener: (this: Document, ev: DocumentEventMap[K]) => unknown, options?: boolean | AddEventListenerOptions, disposerID?: string): string;
+    addEventListener<K extends keyof HTMLElementEventMap>(el: HTMLElement, type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => unknown, options?: boolean | AddEventListenerOptions, disposerID?: string): string;
+    addEventListener<K extends keyof MediaQueryListEventMap>(el: MediaQueryList, type: K, listener: (this: HTMLElement, ev: MediaQueryListEventMap[K]) => unknown, options?: boolean | AddEventListenerOptions, disposerID?: string): string;
+    /**
+     * Sugar for setTimeout.
+     * @param handler
+     * @param timeout
+     * @param disposerID Optional id for the disposer
+     * @returns disposerID
+     */
+    setTimeout(handler: () => void, timeout: number, disposerID?: string): string;
+    /**
+     * Sugar for setInterval.
+     * @param handler
+     * @param timeout
+     * @param disposerID Optional id for the disposer
+     * @returns disposerID
+     */
+    setInterval(handler: () => void, timeout: number, disposerID?: string): string;
+    /**
+     * Remove but not run the disposer. Do nothing if not found.
+     * @param disposerID
+     */
+    remove(disposerID: string): SideEffectDisposer | undefined;
+    /**
+     * Remove and run the disposer. Do nothing if not found.
+     * @param disposerID
+     */
+    flush(disposerID: string): void;
+    /**
+     * Remove and run all of the disposers.
+     */
+    flushAll(): void;
+    /**
+     * All disposers. Use this only when you know what you are doing.
+     */
+    readonly disposers: Map<string, SideEffectDisposer>;
+    genUID(): string;
+}
+
+interface DocsViewerPage {
+    src: string;
+    height: number;
+    width: number;
+    thumbnail?: string;
+}
+interface DocsViewerConfig {
+    readonly: boolean;
+    onNewPageIndex: (index: number) => void;
+    onPlay?: () => void;
+}
+declare class DocsViewer {
+    constructor({ readonly, onNewPageIndex, onPlay }: DocsViewerConfig);
+    protected readonly: boolean;
+    protected onNewPageIndex: (index: number) => void;
+    protected onPlay?: () => void;
+    private _pages;
+    set pages(value: DocsViewerPage[]);
+    get pages(): DocsViewerPage[];
+    $content: HTMLElement;
+    $preview: HTMLElement;
+    $previewMask: HTMLElement;
+    $footer: HTMLElement;
+    $pageNumberInput: HTMLInputElement;
+    $totalPage: HTMLSpanElement;
+    $btnPlay: HTMLButtonElement;
+    $btnSidebar: HTMLButtonElement;
+    pageIndex: number;
+    unmount(): void;
+    setReadonly(readonly: boolean): void;
+    destroy(): void;
+    setPageIndex(pageIndex: number): void;
+    refreshTotalPage(): void;
+    setSmallBox(isSmallBox: boolean): void;
+    render(): HTMLElement;
+    protected renderContent(): HTMLElement;
+    private previewLazyLoad?;
+    protected renderPreview(): HTMLElement;
+    private refreshPreview;
+    protected renderPreviewMask(): HTMLElement;
+    setPaused: () => void;
+    setPlaying: () => void;
+    refreshBtnSidebar(): void;
+    protected renderFooter(): HTMLElement;
+    protected renderFooterBtn(className: string, $icon: SVGElement, $iconActive?: SVGElement): HTMLButtonElement;
+    protected togglePreview(isShowPreview?: boolean): void;
+    protected wrapClassName(className: string): string;
+    protected namespace: string;
+    protected isShowPreview: boolean;
+    protected isSmallBox: boolean;
+    protected sideEffect: SideEffectManager;
+}
+
+declare const DefaultUrl = "https://convertcdn.netless.link/dynamicConvert";
+interface SlideControllerOptions {
+    context: AppContext<Attributes, MagixEvents, AppOptions>;
+    anchor: HTMLDivElement;
+    onRenderEnd: () => void;
+    onPageChanged: (page: number) => void;
+    onTransitionStart: () => void;
+    onTransitionEnd: () => void;
+    onError: (args: {
+        error: Error;
+        index: number;
+    }) => void;
+    onRenderError?: (error: Error, pageIndex: number) => void;
+    showRenderError?: boolean;
+}
+declare class SlideController {
+    readonly context: SlideControllerOptions["context"];
+    readonly slide: Slide;
+    readonly showRenderError: boolean;
+    readonly onRenderError?: (error: Error, pageIndex: number) => void;
+    private readonly room?;
+    private readonly player?;
+    private readonly sideEffect;
+    private readonly onPageChanged;
+    private readonly onTransitionStart;
+    private readonly onTransitionEnd;
+    private readonly onError;
+    private syncStateOnceFlag;
+    private visible;
+    private savedIsFrozen;
+    constructor({ context, anchor, onPageChanged, onTransitionStart, onTransitionEnd, onError, onRenderError, showRenderError, }: SlideControllerOptions);
+    ready: boolean;
+    private resolveReady;
+    readonly readyPromise: Promise<void>;
+    jumpToPage(page: number): void;
+    private initialize;
+    private kickStart;
+    private registerEventListeners;
+    private onSyncDispatch;
+    private magixEventListener;
+    private syncStateOnce;
+    private onStateChange;
+    private pollCount;
+    private pollReadyState;
+    private _pageCount;
+    get pageCount(): number;
+    get page(): number;
+    private createSlide;
+    private destroyed;
+    destroy(): void;
+    timestamp: () => number;
+    isFrozen: boolean;
+    private _toFreeze;
+    freeze: () => void;
+    unfreeze: () => Promise<void>;
+    private onVisibilityChange;
+}
+
+declare type MountSlideOptions = Omit<SlideControllerOptions, "context" | "onPageChanged"> & {
+    onReady: () => void;
+};
+interface SlideDocsViewerConfig {
+    box: ReadonlyTeleBox;
+    view: View;
+    mountSlideController: (options: MountSlideOptions) => SlideController;
+    mountWhiteboard: (dom: HTMLDivElement) => void;
+    baseScenePath: string;
+    appId: string;
+}
+declare class SlideDocsViewer {
+    viewer: DocsViewer;
+    slideController: SlideController | null;
+    protected readonly box: ReadonlyTeleBox;
+    protected readonly whiteboardView: SlideDocsViewerConfig["view"];
+    protected readonly mountSlideController: SlideDocsViewerConfig["mountSlideController"];
+    protected readonly mountWhiteboard: SlideDocsViewerConfig["mountWhiteboard"];
+    private readonly baseScenePath;
+    private readonly appId;
+    private isViewMounted;
+    constructor({ box, view, mountSlideController, mountWhiteboard, baseScenePath, appId, }: SlideDocsViewerConfig);
+    $slide: HTMLDivElement;
+    $whiteboardView: HTMLDivElement;
+    $overlay: HTMLDivElement;
+    render(): void;
+    protected renderOverlay(): HTMLDivElement;
+    protected renderSlideContainer(): HTMLDivElement;
+    protected renderWhiteboardView(): HTMLDivElement;
+    mount(): this;
+    protected onError: ({ error, index }: {
+        error: Error;
+        index: number;
+    }) => void;
+    protected onRenderEnd: () => void;
+    protected refreshPages: () => void;
+    protected getPageIndex(page: number): number;
+    unmount(): this;
+    setReadonly(readonly: boolean): void;
+    destroy(): void;
+    toggleClickThrough(tool?: string): void;
+    protected scaleDocsToFit: () => void;
+    protected onPlay: () => void;
+    protected onNewPageIndex: (index: number) => void;
+    protected sideEffect: SideEffectManager;
+    protected wrapClassName(className: string): string;
+    protected namespace: string;
+    private getWhiteSnapshot;
+    private reportProgress;
+    private toPdf;
+}
+
+interface PreviewParams {
+    container: HTMLElement;
+    taskId: string;
+    url?: string;
+    debug?: boolean;
+}
+declare function previewSlide({ container, taskId, url, debug, }: PreviewParams): SlidePreviewer;
+declare class SlidePreviewer {
+    readonly viewer: DocsViewer;
+    readonly bgColor: string;
+    readonly target: HTMLElement;
+    slide: Slide | null;
+    debug: boolean;
+    $slide: HTMLDivElement;
+    private readonly sideEffect;
+    ready: boolean;
+    private resolveReady;
+    readonly readyPromise: Promise<void>;
+    constructor(config: {
+        target: HTMLElement;
+    });
+    render(): void;
+    /**
+     * In case you have a different window -- for example, in electron.
+     * Use this method to re-register hotkeys.
+     *
+     * @example
+     * previewer.registerHotKeys(windowLike)
+     */
+    registerHotKeys(windowLike: Window): void;
+    private hotkeyListener;
+    mount(taskId: string, url: string): void;
+    protected renderStyle(): HTMLElement;
+    protected registerEventListeners(): void;
+    protected onPageChanged: (page: number) => void;
+    protected onTransitionStart: () => void;
+    protected onTransitionEnd: () => void;
+    protected onError: ({ error }: {
+        error: Error;
+    }) => void;
+    private destroyed;
+    destroy(): void;
+    protected refreshPages: () => void;
+    protected getPageIndex(page: number): number;
+    protected renderSlideContainer(): HTMLDivElement;
+    protected onPlay: () => void;
+    protected onNewPageIndex: (index: number) => void;
+    protected wrapClassName(className: string): string;
+    protected namespace: string;
+}
+
+declare const usePlugin: (plugin: any) => any;
+declare const version: string;
+
+interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCache" | "resourceTimeout" | "loaderDelegate" | "navigatorDelegate" | "fixedFrameSize" | "logger"> {
     /** show debug controller */
     debug?: boolean;
     /** scale */
@@ -40,12 +994,12 @@ export interface AppOptions extends Pick<ISlideConfig, "rtcAudio" | "useLocalCac
     /** whether to show an overlay of error message @default: true */
     showRenderError?: boolean;
 }
-export interface ILogger {
+interface ILogger {
     info?(msg: string): void;
     error?(msg: string): void;
     warn?(msg: string): void;
 }
-export interface AppResult {
+interface AppResult {
     viewer: () => SlideDocsViewer | null;
     controller: () => SlideController | null | undefined;
     slide: () => Slide | undefined;
@@ -57,4 +1011,5 @@ export interface AppResult {
     jumpToPage: (page: number) => boolean;
 }
 declare const SlideApp: NetlessApp<Attributes, MagixEvents, AppOptions, AppResult>;
-export default SlideApp;
+
+export { AddHooks, AppOptions, AppResult, Attributes, DefaultUrl, FreezableSlide, FreezerLength, ILogger, PreviewParams, Slide, SlidePreviewer, addHooks, apps, SlideApp as default, getFreezerLength, onCreated, onDestroyed, previewSlide, setFreezerLength, usePlugin, version };