@netless/slide 1.4.31-alpha.3 → 1.4.32-alpha.0

package/lib/StateDriveSlide.d.ts

@@ -0,0 +1,237 @@
+export declare const SLIDE_EVENTS: {
+    /** 当前 slide 渲染开始触发 */
+    renderStart: string;
+    /** 当前 slide 渲染完毕触发 */
+    renderEnd: string;
+    /** 当前 slide 渲染出错触发 */
+    renderError: string;
+    /** slide 页码变化时触发 */
+    slideChange: string;
+    animateStart: string;
+    animateEnd: string;
+    /** slide 状态变化触发 */
+    stateChange: string;
+};
+export interface ISlideRenderOptions {
+    /** 预期最低渲染 fps, 默认 40 */
+    minFPS?: number;
+    /** 预期最高渲染 fps, 默认 50 */
+    maxFPS?: number;
+    /** 渲染分辨倍率, 整数,  默认为 window.devicePixelRatio */
+    resolution?: number;
+    /** 最小分辨倍率, 默认为 1 */
+    minResolution?: number;
+    /** 是否根据 fps, 自动调整分辨率, 默认为 false */
+    autoResolution?: boolean;
+    /** 是否自动降低渲染 fps */
+    autoFPS?: boolean;
+}
+export interface ITimeNodeSeqState {
+    id: string;
+    step: number;
+    state: "idle" | "running" | "end";
+    isMain: boolean;
+}
+export interface ISlideConfig {
+    /** canvas 挂载点 */
+    anchor: HTMLDivElement;
+    /** 是否可互动 */
+    interactive: boolean;
+    /** 渲染选项, 可选 */
+    renderOptions?: ISlideRenderOptions;
+    /** 是否展示控制栏和stats */
+    controller?: boolean;
+    /** 是否根据窗口大小自动调整分辨率 */
+    resize?: boolean;
+    /** 获取房间时间 */
+    timestamp?: () => number;
+}
+interface MediaState {
+    type: "pause" | "play";
+    time: number;
+}
+interface ISlideState {
+    taskId: string;
+    url: string;
+    currentSlideIndex: number;
+    timeNodeSeqState: {
+        [key: string]: ITimeNodeSeqState;
+    };
+    mediaState: {
+        [key: string]: MediaState;
+    };
+}
+export interface SlideEventEmitter {
+    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.renderError, args: {
+        error: Error;
+        index: number;
+    }): boolean;
+    on(event: typeof SLIDE_EVENTS.renderError, listener: (args: {
+        error: Error;
+        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.stateChange, state: ISlideState): boolean;
+    on(event: typeof SLIDE_EVENTS.stateChange, listener: (state: ISlideState) => void): this;
+}
+declare const StateDriveSlide_base: new () => SlideEventEmitter;
+export declare class StateDriveSlide extends StateDriveSlide_base {
+    private __slideState;
+    private resize;
+    private isAnimating;
+    private renderingTaskManager;
+    private isLoading;
+    private interactive;
+    private anchor;
+    private player;
+    private frameWidth;
+    private frameHeight;
+    private frame;
+    private medianController;
+    private frameResizeObserver;
+    private timestamp;
+    private mode;
+    private log;
+    private logId;
+    private lastEmitedState;
+    private persistLogId;
+    constructor(config: ISlideConfig);
+    private persistLog;
+    private handleSlideStateLog;
+    private handleLogDownload;
+    private setMedianControllerAttribute;
+    private frameResizeHandler;
+    private resizeView;
+    /**
+     * 设置整个 slide 的状态, slide 会以传入的状态更新画面.
+     * 供整体同步时候调用.
+     * @param state ISlideState
+     */
+    setSlideState(state: Partial<ISlideState>): Promise<void>;
+    private initMedia;
+    /**
+     * 返回 slide 总页数
+     */
+    get slideCount(): 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;
+    /**
+     * drawCall 次数, 即每帧调用 gpu drawElements 次数, 只读属性.
+     * @readonly
+     */
+    get drawCall(): number;
+    /**
+     * 渲染 fps, 只读属性.
+     * @readonly
+     */
+    get renderFps(): number;
+    /**
+     * js 运行时 fps, 只读属性.
+     * @readonly
+     */
+    get runtimeFps(): number;
+    /**
+     * 渲染 Slide 的 canvas 元素.
+     * @readonly
+     */
+    get view(): HTMLCanvasElement;
+    /**
+     * 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;
+    /**
+     * 渲染 index 参数对应的 ppt 页.
+     * @param index 要显示的页码, 从 1 开始
+     */
+    renderSlide(index: number): void;
+    private doRenderSlide;
+    /**
+     * 执行下一个主序列动画
+     */
+    nextStep(): void;
+    /**
+     * 执行上一个主序列动画
+     */
+    prevStep(): void;
+    private emitStateChange;
+    /**
+     * 重置主序列动画
+     * @param index 将要重置到的步数
+     * @param status 将要重置到的状态, "start" 重置到动画开始, "end" 重置到动画结束
+     */
+    setMainSeqStep(index: number, status: "idle" | "running" | "end"): void;
+    /**
+     * 设置是否可以互动
+     * @param val boolean
+     */
+    setInteractive(val: boolean): void;
+    /**
+     * 暂停播放
+     */
+    pause(): void;
+    /**
+     * 恢复播放状态
+     */
+    resume(): void;
+    /**
+     * 销毁方法.
+     */
+    destroy(): void;
+}
+export {};