web-music-score 0.0.1 → 6.0.0-pre.1

package/dist/instrument-DS-9C6_8.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Instrument interface.
+ * <p>To create your own instrument just create a class that implement this simple interface.</p>
+ *
+ * ```ts
+ *   import * as Audio from "web-music-score/audio";
+ *
+ *   class MyCoolInstrument implements Audio.Instrument {
+ *       constructor() { }
+ *       getName() { return "My Cool Instrument"; }
+ *       playNote(note: string, duration: number, linearVolume: number) { }
+ *       stop() { }
+ *   }
+ *
+ *   // Add and use my cool instrument.
+ *   Audio.addInstrument(new MyCoolInstrument());
+ * ```
+ */
+interface Instrument {
+    /**
+     * Get instrument name.
+     * @return - Instrument name.
+     */
+    getName(): string;
+    /**
+     * Play a note.
+     * @param note - Note to play (e.g. "C4").
+     * @param duration - Play duration in seconds.
+     * @param linearVolume - Linear volume in range [0, 1].
+     */
+    playNote(note: string, duration: number, linearVolume: number): void;
+    /**
+     * Stop playback.
+     */
+    stop(): void;
+}
+/**
+ * Linear volume to decibels converter.
+ * @param linearVolume - Linear volume in range [0, 1].
+ * @returns - Volume in decibels.
+ */
+declare function linearToDecibels(linearVolume: number): number;
+
+export { type Instrument as I, linearToDecibels as l };