wavesurfer.js 7.8.5-beta.0 → 7.8.6

package/dist/plugins/wavesurfer.d.ts

@@ -1,221 +0,0 @@
-import BasePlugin, { type GenericPlugin } from './base-plugin.js';
-import * as dom from './dom.js';
-import Player from './player.js';
-export type WaveSurferOptions = {
-    /** Required: an HTML element or selector where the waveform will be rendered */
-    container: HTMLElement | string;
-    /** The height of the waveform in pixels, or "auto" to fill the container height */
-    height?: number | 'auto';
-    /** The width of the waveform in pixels or any CSS value; defaults to 100% */
-    width?: number | string;
-    /** The color of the waveform */
-    waveColor?: string | string[] | CanvasGradient;
-    /** The color of the progress mask */
-    progressColor?: string | string[] | CanvasGradient;
-    /** The color of the playpack cursor */
-    cursorColor?: string;
-    /** The cursor width */
-    cursorWidth?: number;
-    /** If set, the waveform will be rendered with bars like this: ▁ ▂ ▇ ▃ ▅ ▂ */
-    barWidth?: number;
-    /** Spacing between bars in pixels */
-    barGap?: number;
-    /** Rounded borders for bars */
-    barRadius?: number;
-    /** A vertical scaling factor for the waveform */
-    barHeight?: number;
-    /** Vertical bar alignment */
-    barAlign?: 'top' | 'bottom';
-    /** Minimum pixels per second of audio (i.e. the zoom level) */
-    minPxPerSec?: number;
-    /** Stretch the waveform to fill the container, true by default */
-    fillParent?: boolean;
-    /** Audio URL */
-    url?: string;
-    /** Pre-computed audio data, arrays of floats for each channel */
-    peaks?: Array<Float32Array | number[]>;
-    /** Pre-computed audio duration in seconds */
-    duration?: number;
-    /** Use an existing media element instead of creating one */
-    media?: HTMLMediaElement;
-    /** Whether to show default audio element controls */
-    mediaControls?: boolean;
-    /** Play the audio on load */
-    autoplay?: boolean;
-    /** Pass false to disable clicks on the waveform */
-    interact?: boolean;
-    /** Allow to drag the cursor to seek to a new position. If an object with `debounceTime` is provided instead
-     * then `dragToSeek` will also be true. If `true` the default is 200ms
-     */
-    dragToSeek?: boolean | {
-        debounceTime: number;
-    };
-    /** Hide the scrollbar */
-    hideScrollbar?: boolean;
-    /** Audio rate, i.e. the playback speed */
-    audioRate?: number;
-    /** Automatically scroll the container to keep the current position in viewport */
-    autoScroll?: boolean;
-    /** If autoScroll is enabled, keep the cursor in the center of the waveform during playback */
-    autoCenter?: boolean;
-    /** Decoding sample rate. Doesn't affect the playback. Defaults to 8000 */
-    sampleRate?: number;
-    /** Render each audio channel as a separate waveform */
-    splitChannels?: Array<Partial<WaveSurferOptions> & {
-        overlay?: boolean;
-    }>;
-    /** Stretch the waveform to the full height */
-    normalize?: boolean;
-    /** The list of plugins to initialize on start */
-    plugins?: GenericPlugin[];
-    /** Custom render function */
-    renderFunction?: (peaks: Array<Float32Array | number[]>, ctx: CanvasRenderingContext2D) => void;
-    /** Options to pass to the fetch method */
-    fetchParams?: RequestInit;
-    /** Playback "backend" to use, defaults to MediaElement */
-    backend?: 'WebAudio' | 'MediaElement';
-};
-declare const defaultOptions: {
-    waveColor: string;
-    progressColor: string;
-    cursorWidth: number;
-    minPxPerSec: number;
-    fillParent: boolean;
-    interact: boolean;
-    dragToSeek: boolean;
-    autoScroll: boolean;
-    autoCenter: boolean;
-    sampleRate: number;
-};
-export type WaveSurferEvents = {
-    /** After wavesurfer is created */
-    init: [];
-    /** When audio starts loading */
-    load: [url: string];
-    /** During audio loading */
-    loading: [percent: number];
-    /** When the audio has been decoded */
-    decode: [duration: number];
-    /** When the audio is both decoded and can play */
-    ready: [duration: number];
-    /** When visible waveform is drawn */
-    redraw: [];
-    /** When all audio channel chunks of the waveform have drawn */
-    redrawcomplete: [];
-    /** When the audio starts playing */
-    play: [];
-    /** When the audio pauses */
-    pause: [];
-    /** When the audio finishes playing */
-    finish: [];
-    /** On audio position change, fires continuously during playback */
-    timeupdate: [currentTime: number];
-    /** An alias of timeupdate but only when the audio is playing */
-    audioprocess: [currentTime: number];
-    /** When the user seeks to a new position */
-    seeking: [currentTime: number];
-    /** When the user interacts with the waveform (i.g. clicks or drags on it) */
-    interaction: [newTime: number];
-    /** When the user clicks on the waveform */
-    click: [relativeX: number, relativeY: number];
-    /** When the user double-clicks on the waveform */
-    dblclick: [relativeX: number, relativeY: number];
-    /** When the user drags the cursor */
-    drag: [relativeX: number];
-    /** When the user starts dragging the cursor */
-    dragstart: [relativeX: number];
-    /** When the user ends dragging the cursor */
-    dragend: [relativeX: number];
-    /** When the waveform is scrolled (panned) */
-    scroll: [visibleStartTime: number, visibleEndTime: number, scrollLeft: number, scrollRight: number];
-    /** When the zoom level changes */
-    zoom: [minPxPerSec: number];
-    /** Just before the waveform is destroyed so you can clean up your events */
-    destroy: [];
-    /** When source file is unable to be fetched, decoded, or an error is thrown by media element */
-    error: [error: Error];
-};
-declare class WaveSurfer extends Player<WaveSurferEvents> {
-    options: WaveSurferOptions & typeof defaultOptions;
-    private renderer;
-    private timer;
-    private plugins;
-    private decodedData;
-    protected subscriptions: Array<() => void>;
-    protected mediaSubscriptions: Array<() => void>;
-    protected abortController: AbortController | null;
-    static readonly BasePlugin: typeof BasePlugin;
-    static readonly dom: typeof dom;
-    /** Create a new WaveSurfer instance */
-    static create(options: WaveSurferOptions): WaveSurfer;
-    /** Create a new WaveSurfer instance */
-    constructor(options: WaveSurferOptions);
-    private updateProgress;
-    private initTimerEvents;
-    private initPlayerEvents;
-    private initRendererEvents;
-    private initPlugins;
-    private unsubscribePlayerEvents;
-    /** Set new wavesurfer options and re-render it */
-    setOptions(options: Partial<WaveSurferOptions>): void;
-    /** Register a wavesurfer.js plugin */
-    registerPlugin<T extends GenericPlugin>(plugin: T): T;
-    /** For plugins only: get the waveform wrapper div */
-    getWrapper(): HTMLElement;
-    /** For plugins only: get the scroll container client width */
-    getWidth(): number;
-    /** Get the current scroll position in pixels */
-    getScroll(): number;
-    /** Set the current scroll position in pixels */
-    setScroll(pixels: number): void;
-    /** Move the start of the viewing window to a specific time in the audio (in seconds) */
-    setScrollTime(time: number): void;
-    /** Get all registered plugins */
-    getActivePlugins(): GenericPlugin[];
-    private loadAudio;
-    /** Load an audio file by URL, with optional pre-decoded audio data */
-    load(url: string, channelData?: WaveSurferOptions['peaks'], duration?: number): Promise<void>;
-    /** Load an audio blob */
-    loadBlob(blob: Blob, channelData?: WaveSurferOptions['peaks'], duration?: number): Promise<void>;
-    /** Zoom the waveform by a given pixels-per-second factor */
-    zoom(minPxPerSec: number): void;
-    /** Get the decoded audio data */
-    getDecodedData(): AudioBuffer | null;
-    /** Get decoded peaks */
-    exportPeaks({ channels, maxLength, precision }?: {
-        channels?: number | undefined;
-        maxLength?: number | undefined;
-        precision?: number | undefined;
-    }): Array<number[]>;
-    /** Get the duration of the audio in seconds */
-    getDuration(): number;
-    /** Toggle if the waveform should react to clicks */
-    toggleInteraction(isInteractive: boolean): void;
-    /** Jump to a specific time in the audio (in seconds) */
-    setTime(time: number): void;
-    /** Seek to a percentage of audio as [0..1] (0 = beginning, 1 = end) */
-    seekTo(progress: number): void;
-    /** Play or pause the audio */
-    playPause(): Promise<void>;
-    /** Stop the audio and go to the beginning */
-    stop(): void;
-    /** Skip N or -N seconds from the current position */
-    skip(seconds: number): void;
-    /** Empty the waveform */
-    empty(): void;
-    /** Set HTML media element */
-    setMediaElement(element: HTMLMediaElement): void;
-    /**
-     * Export the waveform image as a data-URI or a blob.
-     *
-     * @param format The format of the exported image, can be `image/png`, `image/jpeg`, `image/webp` or any other format supported by the browser.
-     * @param quality The quality of the exported image, for `image/jpeg` or `image/webp`. Must be between 0 and 1.
-     * @param type The type of the exported image, can be `dataURL` (default) or `blob`.
-     * @returns A promise that resolves with an array of data-URLs or blobs, one for each canvas element.
-     */
-    exportImage(format: string, quality: number, type: 'dataURL'): Promise<string[]>;
-    exportImage(format: string, quality: number, type: 'blob'): Promise<Blob[]>;
-    /** Unmount wavesurfer */
-    destroy(): void;
-}
-export default WaveSurfer;

package/dist/plugins/webaudio.d.ts

@@ -1,63 +0,0 @@
-import EventEmitter from './event-emitter.js';
-type WebAudioPlayerEvents = {
-    loadedmetadata: [];
-    canplay: [];
-    play: [];
-    pause: [];
-    seeking: [];
-    timeupdate: [];
-    volumechange: [];
-    emptied: [];
-    ended: [];
-};
-/**
- * A Web Audio buffer player emulating the behavior of an HTML5 Audio element.
- */
-declare class WebAudioPlayer extends EventEmitter<WebAudioPlayerEvents> {
-    private audioContext;
-    private gainNode;
-    private bufferNode;
-    private playStartTime;
-    private playedDuration;
-    private _muted;
-    private _playbackRate;
-    private _duration;
-    private buffer;
-    currentSrc: string;
-    paused: boolean;
-    crossOrigin: string | null;
-    seeking: boolean;
-    autoplay: boolean;
-    constructor(audioContext?: AudioContext);
-    /** Subscribe to an event. Returns an unsubscribe function. */
-    addEventListener: <EventName extends keyof WebAudioPlayerEvents>(event: EventName, listener: (...args: WebAudioPlayerEvents[EventName]) => void, options?: {
-        once?: boolean;
-    }) => () => void;
-    /** Unsubscribe from an event */
-    removeEventListener: <EventName extends keyof WebAudioPlayerEvents>(event: EventName, listener: (...args: WebAudioPlayerEvents[EventName]) => void) => void;
-    load(): Promise<void>;
-    get src(): string;
-    set src(value: string);
-    private _play;
-    private _pause;
-    play(): Promise<void>;
-    pause(): void;
-    stopAt(timeSeconds: number): void;
-    setSinkId(deviceId: string): Promise<void>;
-    get playbackRate(): number;
-    set playbackRate(value: number);
-    get currentTime(): number;
-    set currentTime(value: number);
-    get duration(): number;
-    set duration(value: number);
-    get volume(): number;
-    set volume(value: number);
-    get muted(): boolean;
-    set muted(value: boolean);
-    canPlayType(mimeType: string): boolean;
-    /** Get the GainNode used to play the audio. Can be used to attach filters. */
-    getGainNode(): GainNode;
-    /** Get decoded audio */
-    getChannelData(): Float32Array[];
-}
-export default WebAudioPlayer;