@netless/slide 1.1.2 → 1.1.3

package/lib/Slide.d.ts

@@ -6,82 +6,83 @@ export type { ErrorType } from "@netless/ppt-player";
 export declare type UrlInterrupter = (url: string) => Promise<string>;
 export interface ILoaderDelegate {
     /**
-     * 加载 json 资源, 需返回 json 文本
-     * @param url 原始资源地址
+     * Load JSON resources, need to return JSON text.
+     * @param url Original resource address
      */
     loadJson(url: string): Promise<string>;
     /**
-     * 加载图片资源, 需返回 Blob 对象
-     * @param url 原始资源地址
+     * Load image resources, return Blob object.
+     * @param url Original resource address
      */
     loadImage(url: string): Promise<Blob>;
     /**
-     * 媒体文件重定向, mp3 和 mp4 资源会调用这个代理函数, 需返回重定向后的 url
-     * @param url 原始资源地址
+     * Media file redirection, mp3 and mp4 resources will call this proxy function, and the redirected URL should be returned.
+     * @param url Original resource address
      */
     redirectMedia(url: string): string;
 }
 export interface RtcAudio {
     /**
-     * 开始播放音频.
+     * Start playing audio.
      */
     play(): void;
     /**
-     * 暂停音频播放, 且音频当前播放时间不变
+     * Pause audio playback, and the current playback time of the audio remains unchanged.
      */
     pause(): void;
     /**
-     * 当音频对象不再使用时候被调用
+     * When the audio object is no longer in use, it is called.
      */
     destroy(): void;
     /**
-     * 设置音量, 参数值范围 0 ~ 1
+     * Set volume, parameter value range 0 ~ 1.
      */
     volume(value: number): void;
     /**
-     * 获取音频当前播放时间, 单位为:秒
+     * Get the current playing time of the audio, in seconds.
      */
     get currentTime(): number;
     /**
-     * 设置音频当前播放时间, 单位为:秒。需注意, 无论音频是否正在播放, 都需要确保能设置成功。
-     * 如果音频暂停状态下, 设置此值, 那么需保证, 下次恢复播放是从此值位置开始播放。
+     * Set the current playback time of the audio, in seconds. Please note that whether the audio is playing or not, it needs to be ensured that the setting is successful.
+     * If the audio is in a paused state, set this value to ensure that the next time playback resumes, it starts playing from this position.
      */
     set currentTime(time: number);
     /**
-     * 返回音频是否暂停状态
+     * Return whether the audio is in a paused state.
      */
     get isPaused(): boolean;
     /**
-     * 返回音频时长
+     * Return audio duration.
      */
     get duration(): number;
     /**
-     * 当音频加载完成时触发, 例如: 音频 meta 数据加载完成, 这时候知道了音频实际时长, 就需要触发此事件, 需要保证此事件触发时,
-     * 能通过 duration 属性获取到更新后的音频时长
+     * When the audio is loaded, for example: when the audio meta data is loaded and the actual duration of the audio is known,
+     * this event needs to be triggered. It is necessary to ensure that this event is triggered when
+     * You can obtain the updated audio duration through the duration attribute.
      * @param event
      * @param listener
      */
     on(event: "load", listener: () => void): this;
     /**
-     * 当音频暂停时候触发
+     * Trigger when the audio is paused.
      * @param event
      * @param listener
      */
     on(event: "pause", listener: () => void): this;
     /**
-     * 当音频开始播放时候触发
+     * Trigger when the audio is beginning.
      * @param event
      * @param listener
      */
     on(event: "play", listener: () => void): this;
     /**
-     * 移除参数指定事件的所有监听器
+     * Remove all listeners for the specified event.
      */
     removeAllListeners(event: string): void;
 }
 export interface RtcAudioClazz {
     /**
-     * 创建 rtc 播放器, url 为音频地址
+     * Create an RTC player, with the URL as the audio address.
      * @param url
      */
     new (url: string): RtcAudio;
@@ -94,152 +95,161 @@ interface ILogger {
     warn?(msg: string): void;
 }
 export declare const SLIDE_EVENTS: {
-    /** 同步事件派发 */
+    /** Synchronous event dispatch. */
     readonly syncDispatch: "syncDispatch";
-    /** 同步事件接收 */
+    /** Synchronous event reception */
     readonly syncReceive: "syncReceive";
     /**
-     * 同步模式下才会触发这个事件, 指示同步消息滞后, 需要全量同步
+     * This event is only triggered in synchronous mode, indicating that synchronous messages are delayed and require full synchronization.
      */
     readonly syncEventLag: "syncEventLag";
-    /** 当前 slide 渲染开始触发 */
+    /** The current slide rendering starts triggering. */
     readonly renderStart: "renderStart";
-    /** 当前 slide 渲染完毕触发 */
+    /** The current slide rendering is complete. */
     readonly renderEnd: "renderEnd";
-    /** 当前 slide 渲染出错触发 */
+    /** Current slide rendering error triggered. */
     readonly renderError: "renderError";
-    /** slide 页码变化时触发 */
+    /** Page number change triggers */
     readonly slideChange: "slideChange";
-    /** 主序列动画开始时触发 */
+    /** Trigger at the beginning of the main sequence animation. */
     readonly mainSeqStepStart: "mainSeqStepStart";
-    /** 主序列动画结束时触发 */
+    /** Triggered at the end of the main sequence animation. */
     readonly mainSeqStepEnd: "mainSeqStepEnd";
     /**
-     * 任意动画开始时触发
+     * Trigger at the start of any animation.
      */
     readonly animateStart: "animateStart";
     /**
-     * 任意动画结束时触发
+     * Trigger at the end of any animation.
      */
     readonly animateEnd: "animateEnd";
-    /** slide 状态变化触发 */
+    /** slide State change trigger */
     readonly stateChange: "stateChange";
-    /** ppt 已经没有下一步动作触发 **/
+    /** ppt There is no next action trigger. **/
     readonly slideStepEnd: "slideEnd";
-    /** ppt 已经没有上一步动作触发 **/
+    /** ppt There is no previous action triggered. **/
     readonly slideStepStart: "slideStart";
 };
 export interface ISlideRenderOptions {
-    /** 预期最低渲染 fps, 默认 40 */
+    /** Minimum expected rendering fps, default is 40 */
     minFPS?: number;
-    /** 预期最高渲染 fps, 默认 50 */
+    /** Expected maximum rendering fps, default is 50 */
     maxFPS?: number;
-    /** 渲染分辨倍率, 整数,  默认为 window.devicePixelRatio */
+    /** 渲染分辨倍率, 整数,  default is window.devicePixelRatio */
     resolution?: number;
-    /** 是否根据 fps, 自动调整分辨率, 默认为 false */
+    /** Whether to automatically adjust the resolution based on fps., default is false */
     autoResolution?: boolean;
-    /** 是否自动降低渲染 fps */
+    /** Automatically reduce rendering. fps */
     autoFPS?: boolean;
-    /** 播放切页动画时候的背景颜色, 接受 css 颜色字符串或者 16进制颜色值("#ffffff",0xffffff) */
+    /** Background color when playing page transition animation, accepts CSS color strings or hexadecimal color values ("#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
+     * Used to set the maximum display resolution. This value not only affects the canvas rendering resolution, but also affects the texture quality.
+     * On low-end devices, reducing this value can greatly improve memory usage and image black screen phenomenon.
+     * [1] Minimum 960 * 540, less than 1 is calculated as 1;
+     * [2] Normal 1280 * 720; --- default setting for mobile devices.
+     * [3] HD 1920 * 1080;
+     * [4] 3K 3200 × 1800, greater than 4 is calculated as 4; --- default setting for PC devices.
+     * By default, PC devices are set to 3K, and mobile devices are set to 720P.
      */
     maxResolutionLevel?: number;
     /**
-     * 是否强制使用 2d 渲染, 强制使用 2d 渲染会丢失部分 3d、滤镜、特效
+     * Whether to force the use of 2D rendering, forcing the use of 2D rendering will lose some 3D, filters, and effects.
      */
     forceCanvas?: boolean;
     /**
-     * @deprecated 当前版本已经修复花屏问题, 无需开启这个参数
-     * 是否开启 NVIDIA 显卡检测, windows 11 配合 NVIDIA 显卡在
-     * 播放部分切页动画时会花屏。
-     * 开启这个选项, 会自动检测是否 NVIDIA, 如果是 NVIDIA 显卡则
-     * 使用不同的逻辑播放切页动画, 不会花屏, 但是切页响应会慢 200 ~ 1000 ms
+     * @deprecated The current version has fixed the screen flickering issue, so there is no need to enable this parameter.
+     * Should NVIDIA graphics card detection be enabled, Windows 11 with NVIDIA graphics card may experience screen flickering when playing certain page transition animations.
+     * Enabling this option will automatically detect whether it is an NVIDIA graphics card. If it is,
+     * it will use different logic to play page transition animations without screen flickering, but the response time for page transitions will be slower by 200 to 1000 ms.
      */
     enableNvidiaDetect?: boolean;
 }
 export interface INavigatorDelegate {
-    gotoPage(index: number): void;
+    gotoPage?: (index: number) => void;
+    openUrl?: (url: string) => void;
 }
 export interface ISlideConfig {
-    /** canvas 挂载点 */
+    /** canvas mount dom */
     anchor: HTMLDivElement;
-    /** 是否可互动 */
+    /** can it interact */
     interactive: boolean;
-    /** 渲染选项, 可选 */
+    /** render options, Optional */
     renderOptions?: ISlideRenderOptions;
-    /** 是否展示控制栏和stats */
+    /** Whether to display the control bar and stats */
     controller?: boolean;
-    /** 是否根据窗口大小自动调整分辨率 */
+    /** Whether to automatically adjust the resolution according to the window size */
     resize?: boolean;
-    /** 获取房间时间 */
+    /** Get room time */
     timestamp?: () => number;
     /**
-     * 运行模式
+     * Operating mode
      *
-     * "interactive" 互动模式, 所有人都可以操作 ppt
-     * "sync" 同步模式, 只有一个人能操作 ppt
-     * "local" 本地模式, 不会触发任意同步事件
+     * "interactive" Interactive mode, everyone can operate ppt
+     * "sync" Synchronization mode, only one person can operate ppt
+     * "local" Local mode, no synchronization events will be triggered
      */
     mode: "interactive" | "sync" | "local";
     /**
-     * 是否启用全局点击, 开启后, 只要点击到 ppt 视口范围,
-     * 并且没有触发 ppt 内部可互动元素, 就会触发下一步动作.
-     * 默认为 false
+     * 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.
+     * Default is false
      */
     enableGlobalClick?: boolean;
     /**
-     * 提供的音频播放器类, 用于 rtc 混音
+     * The provided audio player class, used for rtc mixing
      */
     rtcAudio?: RtcAudioClazz;
     /**
-     * 提供 logger 对象, 用以记录运行日志
+     * Provide logger object for recording operation logs
      */
     logger?: ILogger;
     /**
-     * 是否启用本地缓存，启用后会将 ppt 远程资源缓存在 indexDB 中
-     * 默认为 true
+     * Whether to enable local caching, after enabling, ppt remote resources will be cached in indexDB
+     * Default is true
      */
     useLocalCache?: boolean;
     /**
-     * 资源加载超时时间, 默认 15 秒
+     * Resource loading timeout, default 15 seconds
      */
     resourceTimeout?: number;
     /**
-     * 远程资源代理, 详细使用参考 README
+     * Remote resource proxy, for detailed use refer to README
      */
     loaderDelegate?: ILoaderDelegate;
     /**
-     * ppt 页码导航代理, 添加此属性后, ppt 内部动作引起的页码变换, 全部走代理逻辑.
+     * PPT page navigation proxy, after adding this property,
+     * the page number changes caused by actions within the ppt,
+     * all go through the proxy logic.
+     * PPT opens the webpage, needs to open through the openUrl method,
+     * PPT page turning, needs to turn pages through the gotoPage method.
      */
     navigatorDelegate?: INavigatorDelegate;
     /**
-     * 设置 ppt 固定高宽, 设置后 ppt 不会跟随父元素的大小自动变化
-     * 如果有缩放需求，需要调用 updateFixedFrameSize 方法
-     * width 及 height 属性单位为 px
+     * Set a fixed height and width for ppt, after setting, ppt will not change automatically with the size of the parent element
+     * If there is a need for scaling, you need to call the updateFixedFrameSize method
+     * The units of width and height attributes are px
      */
     fixedFrameSize?: {
         width: number;
         height: number;
     };
     /**
-     * 客户端 id, 在同步及互动场景下, 需要能区分每个不同的客户端。对于收到同步消息的一端来说, 需要用这个
-     * clientId 区分是不是自己发出的消息又被自己接收了。
-     * 如果同步及互动场景下, 没有给这个值会造成某些情况下的状态不同步，已知的场景有:
-     * 1. ppt 某一页有自动动画, 动画过程中进行的下一步动作, 在其他客户端可能表现为下一页(即翻页)
+     * Client id, in synchronization and interactive scenarios, it needs to be able to distinguish each different client.
+     * For the end that receives the synchronization message, this needs to be used
+     * ClientId distinguishes whether the message sent by oneself is received by oneself.
+     * If in the synchronization and interactive scenarios,
+     * not giving this value will cause the status to be out of sync in some cases,
+     * the known scenarios are:
+     * 1. A certain page of ppt has automatic animation, the next action performed during the animation,
+     * on other clients may appear as the next page (i.e. page turning)
      */
     clientId?: string;
     urlInterrupter?: UrlInterrupter;
     /**
-     * 是否开启日志追踪, 开启后会向 sdk 远程服务器定时定量上传本地日志
-     * 默认 true
+     * Whether to enable log tracking, after enabling,
+     * local logs will be regularly and quantitatively uploaded to the sdk remote server
+     * default is true
      */
     enableTracking?: boolean;
 }
@@ -436,16 +446,16 @@ export declare class Slide extends Slide_base {
     private setMedianControllerAttribute;
     private frameResizeHandler;
     /**
-     *  更新 ppt 固定高宽, 此方法只有在设置了 fixedFrameSize 配置项的情况下才会生效
-     * @param width 需要更新的宽度值, 单位 px
-     * @param height 需要更新的高度值, 单位 px
+     *  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.
+     * @param height Height value that needs to be updated, unit px.
      */
     updateFixedFrameSize(width: number, height: number, callback?: () => void): void;
     private resizeView;
     private receiveSyncHandler;
     /**
-     * 设置整个 slide 的状态, slide 会以传入的状态更新画面.
-     * 供整体同步时候调用.
+     * Set the state of the entire slide, the slide will update the screen with the incoming state.
+     * It is called when synchronizing the whole.
      * @param state ISlideState
      */
     setSlideState(state: Partial<ISlideState>): Promise<void>;
@@ -456,71 +466,72 @@ export declare class Slide extends Slide_base {
      */
     get slideCount(): number;
     /**
-     * 获取 slide 设计高宽, 单位为 px, 返回数组形式为 [width, height]
-     * 可以在 renderSlide 之前调用
+     * Get the width and height of the slide in pixels,
+     * return the array in the form [width, height].
+     * Can be called before rendering the slide.
      */
     getSizeAsync(): Promise<[number, number]>;
     /**
-     * 获取 slide 总页数, 可以在 renderSlide 之前调用
+     * Get the total number of slides, you can call it before renderSlide.
      */
     getSlideCountAsync(): Promise<number>;
     /**
-     * 整个 slide 的状态, 将获取的值传递给另一个客户端, 并调用 setSlideState
-     * 可以完成整体同步. 只读属性.
+     * The state of the entire slide, pass the obtained value to another client,
+     * and call setSlideState to achieve overall synchronization. Read-only property.
      * @readonly
      */
     get slideState(): ISlideState;
     /**
-     * 主序列动画步数, 只读属性
+     * Main sequence animation steps, read-only property.
      * @readonly
      */
     get mainSeqLength(): number;
     /**
-     * 主序列动画, 当前步, 只读属性
+     * Main sequence animation, current step, read-only property.
      * @readonly
      */
     get mainSeqStep(): number;
     /**
-     * 主序列动画, 当前状态, 只读属性
-     *   "idle": 动画尚未运行
-     *   "running": 动画运行中
-     *   "end": 动画已经结束
-     *   null: 当前 Slide 没有主序列动画
+     * Main sequence animation, current state, read-only property
+     * "idle": Animation has not started
+     * "running": Animation is in progress
+     * "end": Animation has ended
+     * null: The current slide does not have a main sequence animation
      * @readonly
      */
     get mainSeqState(): "idle" | "running" | "end" | null;
     /**
-     * 实时渲染属性, 只读属性.
+     * Real-time rendering properties, read-only properties.
      * @readonly
      */
     get renderOptions(): ISlideRenderOptions | null;
     /**
-     * drawCall 次数, 即每帧调用 gpu drawElements 次数, 只读属性.
+     * drawCall count, which means the number of times gpu drawElements is called per frame, read-only property.
      * @readonly
      */
     get drawCall(): number;
     /**
-     * 渲染 fps, 只读属性.
+     * Rendering fps, read-only property.
      * @readonly
      */
     get renderFps(): number;
     /**
-     * js 运行时 fps, 只读属性.
+     * js runtime fps, read-only.
      * @readonly
      */
     get runtimeFps(): number;
     /**
-     * 渲染 Slide 的 canvas 元素.
+     * Render the canvas element of the Slide.
      * @readonly
      */
     get view(): HTMLCanvasElement | null;
     /**
-     * Slide 宽度. 此宽度为设计宽度, 由 ppt 决定. 只读属性.
+     * Slide width. This width is the design width determined by ppt. Read-only property.
      * @readonly
      */
     get width(): number;
     /**
-     * Slide 高度. 此高度为设计高度, 由 ppt 决定. 只读属性.
+     * Slide height. This height is the design height determined by ppt. Read-only property.
      * @readonly
      */
     get height(): number;
@@ -530,9 +541,9 @@ export declare class Slide extends Slide_base {
      */
     updateRenderOption(renderOptions: ISlideRenderOptions): void;
     /**
-     * 设置 ppt 转换后的资源
-     * @param taskId 转换任务 id
-     * @param url 资源 url 前缀
+     * Set resources after converting ppt
+     * @param taskId task id
+     * @param url Resource URL prefix
      */
     setResource(taskId: string, url: string): void;
     private _renderSlide;
@@ -540,17 +551,18 @@ export declare class Slide extends Slide_base {
     private handleNextSlide;
     private handleGotoSlide;
     /**
-     * 渲染 index 参数对应的 ppt 页.
-     * @param index 要显示的页码, 从 1 开始
+     * Render the ppt page corresponding to the index parameter.
+     * @param index Page number to display, starting from 1.
      */
     renderSlide(index: number, isForward?: boolean): void;
     private needCreateNewPlayer;
     private poseRenderSlide;
     /**
-     * 直接渲染 index 指定的页码, 不论当前是 sync 还是 interactive 模式.
-     * 即调用此方法不会触发 syncDispatch 事件
-     * @param index 要渲染的页码
-     * @param isForward 是否向前翻页, 影响切页动画时正放还是倒放
+     * Render the page specified by the index directly,
+     * regardless of whether the current mode is sync or interactive.
+     * Calling this method will not trigger the syncDispatch event.
+     * @param index Page number to render
+     * @param isForward Whether to flip forward or backward, affecting the page transition animation.
      */
     doRenderSlide(index: number, isForward?: boolean): Promise<void>;
     getSnapshot(): string | null;
@@ -560,7 +572,7 @@ export declare class Slide extends Slide_base {
     nextStep(): void;
     private doNextStep;
     /**
-     * 执行上一个主序列动画
+     * Execute the previous main sequence animation.
      */
     prevStep(): void;
     private doPrevStep;
@@ -568,75 +580,76 @@ export declare class Slide extends Slide_base {
     private emitStateChange;
     private emitSyncDispatch;
     /**
-     * 重置主序列动画
-     * @param index 将要重置到的步数
-     * @param status 将要重置到的状态, "start" 重置到动画开始, "end" 重置到动画结束
+     * Reset main sequence animation.
+     * @param index Number of steps to reset to.
+     * @param status The state to be reset to, "start" resets to the beginning of the animation, "end" resets to the end of the animation.
      */
     setMainSeqStep(index: number, status: "start" | "end"): void;
     /**
-     * 设置是否可以互动
+     * Set whether interaction is allowed.
      * @param val boolean
      */
     setInteractive(val: boolean): void;
     /**
-     * 暂停播放, 非同步操作
+     * Pause playback, asynchronous operation.
      */
     pause(): void;
     /**
-     * 恢复播放状态, 非同步操作
+     * Resume playback state, asynchronous operation.
      */
     resume(): void;
     private _doFrozen;
     /**
-     * 进入冻结状态, 将 ppt 画面缓存为一张图片, 并释放 webgl 上下文
+     * Enter freeze state, cache the ppt screen as an image, and release the WebGL context.
      */
     frozen(): void;
     private _doRelease;
     /**
-     * 从冻结状态恢复
+     * Recover from frozen state.
      */
     release(): void;
     private _doDestroy;
     private waitLoadEnd;
     preload(index: number): Promise<void>;
     /**
-     * 销毁方法.
+     * Destruction method.
      */
     destroy(): void;
     /**
-     * 销毁当前 Slide 实例的本地缓存, 需要在 destroy 之前调用。
+     * Destroy the local cache of the current Slide instance, need to be called before destroy.
      */
     clearSlideCache(): void;
     /**
-     * 返回 ppt 是否存在下一步动作
+     * Return whether there is a next action in the ppt.
      */
     hasNextStep(): boolean;
     /**
-     * 返回 ppt 是否存在上一步动作
+     * Return whether there is a previous action in the ppt.
      */
     hasPrevStep(): boolean;
     /**
-     * 截取当前状态的截图
-     * @return 图片 dataUrl, 如果失败则返回 null
+     * Capture a screenshot of the current state.
+     * @return 图片 dataUrl, if failed return null
      */
     snapshot(): Promise<string | null>;
     /**
-     * 截取动画最后一步状态的截图
-     * @param index 要截取的页码
-     * @return 图片 dataUrl, 如果失败则返回 null
+     * Capture a screenshot of the final step of the animation.
+     * @param index The index of the slide to be captured.
+     * @return 图片 dataUrl, if failed return null
      */
     snapshotWithTimingEnd(index: number): Promise<string | null>;
     /**
-     * 设置此 Slide 实例全局音量, 非同步操作, 只会修改本地音量，不会触发同步事件
-     * @param v 数值范围 0 ~ 1
+     * Set the global volume of this Slide instance, asynchronous operation,
+     * only modify the local volume, will not trigger synchronous events.
+     * @param v Value range 0 ~ 1
      */
     updateGlobalVolume(v: number): void;
     /**
-     * 获取此 Slide 实例全局音量
+     * Get the global volume of this Slide instance.
      */
     getGlobalVolume(): number;
     /**
-     * 销毁历史所有本地缓存
+     * Destroy all local cache of historical records.
      */
     static clearLocalCache(): void;
     /**