ez-web-audio/dist/beat.d.ts

Making the Web Audio API super EZ since 2024.

/**
 * A single beat position in a rhythmic pattern.
 *
 * Beat represents one position in a drum machine lane. When active, it triggers
 * playback when its time comes. When inactive, it creates a rest (silence).
 * Beat tracks timing and provides properties for UI synchronization.
 *
 * @example
 * ```typescript
 * // Beats are typically created by BeatTrack, not directly
 * const track = await createBeatTrack(['snare.mp3'], { numBeats: 8 })
 *
 * // Toggle a beat on/off
 * track.beats[2].active = true
 * track.beats[2].active = false
 *
 * // Check if this beat was just played
 * if (beat.isPlaying) {
 *   // Highlight in UI
 * }
 * ```
 */
export interface BeatOptions {
    duration?: number;
    playIn: (time: number) => void;
    play: () => void;
    setTimeout?: (fn: () => void, delayMillis: number) => number;
}
export declare class Beat {
    constructor(audioContext: AudioContext, opts: BeatOptions);
    private parentPlayIn;
    private parentPlay;
    private setTimeout;
    /**
     * Whether this beat should play when triggered.
     * When false, the beat position becomes a rest (silence).
     * @default false
     */
    active: boolean;
    /**
     * Whether this beat's time position is currently active (playing or resting).
     * True for both active beats and rests during their time slot.
     * Automatically resets to false after `duration` milliseconds.
     * @default false
     */
    currentTimeIsPlaying: boolean;
    /**
     * Whether this beat is currently playing audio (only true for active beats).
     * Automatically resets to false after `duration` milliseconds.
     * Use this for visual feedback that should only appear when sound plays.
     * @default false
     */
    isPlaying: boolean;
    /**
     * How long (in milliseconds) the `isPlaying` flags stay true.
     * Useful for controlling visual feedback duration.
     * @default 100
     */
    duration: number;
    /**
     * Play this beat after a delay.
     *
     * Sets `isPlaying` and `currentTimeIsPlaying` to true after the offset elapses,
     * then resets them after `duration` milliseconds.
     *
     * @param offset - Number of seconds from now to play
     *
     * @example
     * ```typescript
     * beat.playIn(0.5) // plays in 0.5 seconds
     * ```
     */
    playIn(offset?: number): void;
    /**
     * Play this beat after a delay, but only if active.
     *
     * If active, plays and sets `isPlaying` to true after the offset.
     * Always sets `currentTimeIsPlaying` to true (for UI beat indicators).
     *
     * @param offset - Number of seconds from now to play
     */
    ifActivePlayIn(offset?: number): void;
    /**
     * Play this beat immediately.
     *
     * Sets `isPlaying` and `currentTimeIsPlaying` to true immediately,
     * then resets them after `duration` milliseconds.
     *
     * @example
     * ```typescript
     * beat.play() // plays immediately
     * ```
     */
    play(): void;
    /**
     * Play this beat immediately, but only if active.
     *
     * If active, plays and sets `isPlaying` to true.
     * Always sets `currentTimeIsPlaying` to true (for UI beat indicators).
     */
    playIfActive(): void;
    /**
     * Mark this beat as currently playing and schedule reset.
     * @internal
     */
    private markPlaying;
    /**
     * Mark this beat's time slot as active and schedule reset.
     * @internal
     */
    private markCurrentTimePlaying;
}
export default Beat;
//# sourceMappingURL=beat.d.ts.map