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

Making the Web Audio API super EZ since 2024.

import { AcceptableNote, Accidental, IMusicallyAware, NoteLetter, Octave } from './musical-identity';
declare const Note_base: {
    new (...args: any[]): {
        [x: string]: any;
        letter: NoteLetter;
        accidental: Accidental;
        octave: Octave;
        readonly name: string;
        frequency: number;
        identifier: "C0" | "Db0" | "D0" | "Eb0" | "E0" | "F0" | "Gb0" | "G0" | "Ab0" | "A0" | "Bb0" | "B0" | "C1" | "Db1" | "D1" | "Eb1" | "E1" | "F1" | "Gb1" | "G1" | "Ab1" | "A1" | "Bb1" | "B1" | "C2" | "Db2" | "D2" | "Eb2" | "E2" | "F2" | "Gb2" | "G2" | "Ab2" | "A2" | "Bb2" | "B2" | "C3" | "Db3" | "D3" | "Eb3" | "E3" | "F3" | "Gb3" | "G3" | "Ab3" | "A3" | "Bb3" | "B3" | "C4" | "Db4" | "D4" | "Eb4" | "E4" | "F4" | "Gb4" | "G4" | "Ab4" | "A4" | "Bb4" | "B4" | "C5" | "Db5" | "D5" | "Eb5" | "E5" | "F5" | "Gb5" | "G5" | "Ab5" | "A5" | "Bb5" | "B5" | "C6" | "Db6" | "D6" | "Eb6" | "E6" | "F6" | "Gb6" | "G6" | "Ab6" | "A6" | "Bb6" | "B6" | "C7" | "Db7" | "D7" | "Eb7" | "E7" | "F7" | "Gb7" | "G7" | "Ab7" | "A7" | "Bb7" | "B7" | "C8" | "Db8" | "D8" | "Eb8";
    };
} & {
    new (): {};
};
/**
 * A musical note without audio data.
 *
 * Note represents musical identity (letter, accidental, octave, frequency)
 * without any audio capabilities. Use SampledNote for notes with audio.
 * Note is useful for UI components that display note information.
 *
 * @example
 * ```typescript
 * import { Note } from 'ez-web-audio'
 *
 * const note = new Note({ letter: 'A', octave: '4' })
 * console.log(note.frequency)  // 440
 * console.log(note.identifier) // "A4"
 *
 * // Or create from frequency
 * const noteFromFreq = new Note({ frequency: 440 })
 * console.log(noteFromFreq.identifier) // "A4"
 *
 * // Or create from identifier
 * const noteFromId = new Note({ identifier: 'Bb3' })
 * console.log(noteFromId.letter)     // "B"
 * console.log(noteFromId.accidental) // "b"
 * console.log(noteFromId.octave)     // "3"
 * ```
 */
export declare class Note extends Note_base implements IMusicallyAware {
    constructor(opts?: {
        letter?: NoteLetter;
        accidental?: Accidental;
        octave?: Octave;
        frequency?: number;
        identifier?: AcceptableNote;
    });
}
export {};
//# sourceMappingURL=note.d.ts.map