@netless/slide 0.2.7 → 0.2.10

package/lib/Slide.d.ts

@@ -1,3 +1,64 @@
+export interface RtcAudio {
+    /**
+     * 开始播放音频.
+     */
+    play(): void;
+    /**
+     * 暂停音频播放, 且音频当前播放时间不变
+     */
+    pause(): void;
+    /**
+     * 当音频对象不再使用时候被调用
+     */
+    destroy(): 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;
+}
+export interface RtcAudioClazz {
+    /**
+     * 创建 rtc 播放器, url 为音频地址
+     * @param url
+     */
+    new (url: string): RtcAudio;
+}
 export declare const delay: (value: number) => Promise<unknown>;
 export declare function waitUntil(fn: () => boolean, timeout: number): Promise<void>;
 export declare const SLIDE_EVENTS: {
@@ -17,7 +78,13 @@ export declare const SLIDE_EVENTS: {
     readonly mainSeqStepStart: "mainSeqStepStart";
     /** 主序列动画结束时触发 */
     readonly mainSeqStepEnd: "mainSeqStepEnd";
+    /**
+     * 任意动画开始时触发
+     */
     readonly animateStart: "animateStart";
+    /**
+     * 任意动画结束时触发
+     */
     readonly animateEnd: "animateEnd";
     /** slide 状态变化触发 */
     readonly stateChange: "stateChange";
@@ -63,6 +130,10 @@ export interface ISlideConfig {
      * 默认为 false
      */
     enableGlobalClick?: boolean;
+    /**
+     * 提供的音频播放器类, 用于 rtc 混音
+     */
+    rtcAudio?: RtcAudioClazz;
 }
 interface MediaState {
     type: "pause" | "play";