@waveform-playlist/browser 5.0.0-alpha.9 → 5.1.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { default as default_3 } from 'waveform-data';
 import { DragEndEvent } from '@dnd-kit/core';
 import { Fade as Fade_2 } from '@waveform-playlist/core';
 import { Gain } from 'tone';
+import { MediaElementPlayout } from '@waveform-playlist/media-element-playout';
 import { MutableRefObject } from 'react';
 import react__default from 'react';
 import { ReactNode } from 'react';
@@ -50,7 +51,7 @@ declare interface AnnotationActionOptions {
     [key: string]: unknown;
 }
 
-declare interface AnnotationData {
+export declare interface AnnotationData {
     id: string;
     start: number;
     end: number;
@@ -58,6 +59,19 @@ declare interface AnnotationData {
     language?: string;
 }
 
+/**
+ * Shared annotation types used across Waveform components
+ */
+/**
+ * Base annotation data structure
+ */
+declare interface AnnotationData_2 {
+    id: string;
+    start: number;
+    end: number;
+    lines: string[];
+}
+
 /**
  * Represents a single audio clip on the timeline
  *
@@ -410,6 +424,21 @@ export declare const FastForwardButton: default_2.FC<{
     className?: string;
 }>;
 
+/**
+ * Custom function to generate the label shown on annotation boxes in the waveform.
+ * Receives the annotation data and its index in the list, returns a string label.
+ * Default behavior: displays annotation.id
+ *
+ * @example
+ * // Show sequence numbers
+ * getAnnotationBoxLabel={(annotation, index) => String(index + 1)}
+ *
+ * @example
+ * // Show formatted time
+ * getAnnotationBoxLabel={(annotation) => formatTime(annotation.start)}
+ */
+export declare type GetAnnotationBoxLabelFn = (annotation: AnnotationData_2, index: number) => string;
+
 export declare const getEffectDefinition: (id: string) => EffectDefinition | undefined;
 
 export declare const getEffectsByCategory: (category: EffectDefinition["category"]) => EffectDefinition[];
@@ -530,12 +559,165 @@ export declare interface MasterVolumeControls {
     setMasterVolume: (volume: number) => void;
 }
 
+export declare interface MediaElementAnimationContextValue {
+    isPlaying: boolean;
+    currentTime: number;
+    currentTimeRef: default_2.RefObject<number>;
+}
+
+export declare interface MediaElementControlsContextValue {
+    play: (startTime?: number) => void;
+    pause: () => void;
+    stop: () => void;
+    seekTo: (time: number) => void;
+    setPlaybackRate: (rate: number) => void;
+    setContinuousPlay: (enabled: boolean) => void;
+    setAnnotations: (annotations: AnnotationData[]) => void;
+    setActiveAnnotationId: (id: string | null) => void;
+    setAutomaticScroll: (enabled: boolean) => void;
+    setScrollContainer: (element: HTMLDivElement | null) => void;
+    scrollContainerRef: default_2.RefObject<HTMLDivElement | null>;
+}
+
+export declare interface MediaElementDataContextValue {
+    duration: number;
+    peaksDataArray: TrackClipPeaks[];
+    sampleRate: number;
+    waveHeight: number;
+    timeScaleHeight: number;
+    samplesPerPixel: number;
+    playoutRef: default_2.RefObject<MediaElementPlayout | null>;
+    controls: {
+        show: boolean;
+        width: number;
+    };
+    barWidth: number;
+    barGap: number;
+    progressBarWidth: number;
+}
+
+/**
+ * MediaElementPlaylistProvider
+ *
+ * A simplified playlist provider for single-track playback using HTMLAudioElement.
+ * Key features:
+ * - Pitch-preserving playback rate (0.5x - 2.0x)
+ * - Pre-computed peaks visualization (no AudioBuffer needed)
+ * - Simpler API than full WaveformPlaylistProvider
+ *
+ * Use this for:
+ * - Language learning apps (speed control)
+ * - Podcast players
+ * - Single-track audio viewers
+ *
+ * For multi-track editing, use WaveformPlaylistProvider instead.
+ */
+export declare const MediaElementPlaylistProvider: default_2.FC<MediaElementPlaylistProviderProps>;
+
+declare interface MediaElementPlaylistProviderProps {
+    /** Single track configuration with source URL and waveform data */
+    track: MediaElementTrackConfig;
+    /** Initial samples per pixel (zoom level) */
+    samplesPerPixel?: number;
+    /** Height of each waveform track */
+    waveHeight?: number;
+    /** Show timescale */
+    timescale?: boolean;
+    /** Initial playback rate (0.5 to 2.0) */
+    playbackRate?: number;
+    /** Enable automatic scroll to keep playhead centered */
+    automaticScroll?: boolean;
+    /** Theme configuration */
+    theme?: Partial<WaveformPlaylistTheme>;
+    /** Track controls configuration */
+    controls?: {
+        show: boolean;
+        width: number;
+    };
+    /** Annotations */
+    annotationList?: {
+        annotations?: any[];
+        isContinuousPlay?: boolean;
+    };
+    /** Width of waveform bars */
+    barWidth?: number;
+    /** Gap between waveform bars */
+    barGap?: number;
+    /** Width of progress bars */
+    progressBarWidth?: number;
+    /** Callback when audio is ready */
+    onReady?: () => void;
+    children: ReactNode;
+}
+
+export declare interface MediaElementStateContextValue {
+    continuousPlay: boolean;
+    annotations: AnnotationData[];
+    activeAnnotationId: string | null;
+    playbackRate: number;
+    isAutomaticScroll: boolean;
+}
+
+export declare interface MediaElementTrackConfig {
+    /** Audio source URL or Blob URL */
+    source: string;
+    /** Pre-computed waveform data (required for visualization) */
+    waveformData: WaveformDataObject;
+    /** Track name for display */
+    name?: string;
+}
+
+/**
+ * Simplified Waveform component for MediaElementPlaylistProvider
+ *
+ * This is a stripped-down version of Waveform that works with the
+ * MediaElement context. It supports:
+ * - Single track visualization
+ * - Click to seek
+ * - Annotation display and click-to-play
+ * - Playhead animation
+ *
+ * For multi-track editing, use the full Waveform with WaveformPlaylistProvider.
+ */
+export declare const MediaElementWaveform: default_2.FC<MediaElementWaveformProps>;
+
+export declare interface MediaElementWaveformProps {
+    /** Height in pixels for the annotation text list */
+    annotationTextHeight?: number;
+    /** Custom function to generate the label shown on annotation boxes */
+    getAnnotationBoxLabel?: GetAnnotationBoxLabelFn;
+    /**
+     * Custom render function for annotation items in the text list.
+     * When provided, completely replaces the default annotation item rendering.
+     * Use this to customize the appearance of each annotation (e.g., add furigana).
+     */
+    renderAnnotationItem?: (props: RenderAnnotationItemProps) => default_2.ReactNode;
+    /** Whether annotation boundaries can be edited by dragging. Defaults to false. */
+    editable?: boolean;
+    /**
+     * Callback when annotations are updated (e.g., boundaries dragged).
+     * Called with the full updated annotations array.
+     */
+    onAnnotationUpdate?: OnAnnotationUpdateFn;
+    /** Where to position the active annotation when auto-scrolling: 'center', 'start', 'end', or 'nearest'. Defaults to 'center'. */
+    scrollActivePosition?: ScrollLogicalPosition;
+    /** Which scrollable containers to scroll: 'nearest' (only the annotation list) or 'all' (including viewport). Defaults to 'nearest'. */
+    scrollActiveContainer?: 'nearest' | 'all';
+    className?: string;
+}
+
 declare interface MicrophoneDevice {
     deviceId: string;
     label: string;
     groupId: string;
 }
 
+/**
+ * Callback when annotations are updated (e.g., boundaries dragged).
+ * Called with the full updated annotations array.
+ */
+export declare type OnAnnotationUpdateFn = (annotations: AnnotationData_2[]) => void;
+
 /**
  * Effect definitions for all available Tone.js effects
  * Each effect has parameters with min/max/default values for UI controls
@@ -656,6 +838,8 @@ declare interface PlaylistDataContextValue {
     barGap: number;
     /** Width in pixels of progress bars. Defaults to barWidth + barGap (fills gaps). */
     progressBarWidth: number;
+    /** Whether the playlist has finished loading all tracks */
+    isReady: boolean;
 }
 
 declare interface PlaylistStateContextValue {
@@ -673,6 +857,17 @@ declare interface PlaylistStateContextValue {
     loopEnd: number;
 }
 
+/**
+ * Props passed to the renderAnnotationItem function for custom rendering
+ */
+export declare interface RenderAnnotationItemProps {
+    annotation: AnnotationData;
+    index: number;
+    isActive: boolean;
+    onClick: () => void;
+    formatTime: (seconds: number) => string;
+}
+
 /**
  * Type for custom playhead render functions.
  * Receives position, color, and animation refs for smooth 60fps animation.
@@ -1303,6 +1498,14 @@ declare interface UseMasterVolumeProps {
     onVolumeChange?: (volume: number) => void;
 }
 
+export declare const useMediaElementAnimation: () => MediaElementAnimationContextValue;
+
+export declare const useMediaElementControls: () => MediaElementControlsContextValue;
+
+export declare const useMediaElementData: () => MediaElementDataContextValue;
+
+export declare const useMediaElementState: () => MediaElementStateContextValue;
+
 export declare const usePlaybackAnimation: () => PlaybackAnimationContextValue;
 
 /**
@@ -1653,6 +1856,21 @@ export declare interface WaveformProps {
     annotationControls?: AnnotationAction[];
     annotationListConfig?: AnnotationActionOptions;
     annotationTextHeight?: number;
+    /**
+     * Custom render function for annotation items in the text list.
+     * Use this to completely customize how each annotation is displayed.
+     */
+    renderAnnotationItem?: (props: RenderAnnotationItemProps) => ReactNode;
+    /**
+     * Custom function to generate the label shown on annotation boxes in the waveform.
+     * Receives the annotation data and its index, returns a string label.
+     * Default: annotation.id
+     */
+    getAnnotationBoxLabel?: GetAnnotationBoxLabelFn;
+    /** Where to position the active annotation when auto-scrolling: 'center', 'start', 'end', or 'nearest'. Defaults to 'center'. */
+    scrollActivePosition?: ScrollLogicalPosition;
+    /** Which scrollable containers to scroll: 'nearest' (only the annotation list) or 'all' (including viewport). Defaults to 'nearest'. */
+    scrollActiveContainer?: 'nearest' | 'all';
     className?: string;
     showClipHeaders?: boolean;
     interactiveClips?: boolean;