smplr 0.15.0 → 0.16.0

package/README.md

@@ -1,4 +1,4 @@
-# smplr
+# [smplr](https://github.com/danigb/smplr)
 
 [![npm version](https://img.shields.io/npm/v/smplr)](https://www.npmjs.com/package/smplr)
 
@@ -467,11 +467,14 @@ const context = new AudioContext();
 const drums = new DrumMachine(context, { instrument: "TR-808" });
 drums.start({ note: "kick" });
 
-// Drum samples could have variations:
-const now = context.currentTime;
-drums.getVariations("kick").forEach((variation, index) => {
-  drums.start({ note: variation, time: now + index });
-});
+// Drum samples are grouped and can have sample variations:
+drums.getSampleNames(); // => ['kick-1', 'kick-2', 'snare-1', 'snare-2', ...]
+drums.getGroupNames(); // => ['kick', 'snare']
+drums.getSampleNamesForGroup("kick") => // => ['kick-1', 'kick-2']
+
+// You can trigger samples by group name or specific sample
+drums.start("kick"); // Play the first sample of the group
+drums.start("kick-1"); // Play this specific sample
 ```
 
 ### Smolken double bass

package/dist/index.d.mts

@@ -232,6 +232,7 @@ declare class Sampler {
 }
 
 type QueuedPlayerConfig = {
+    disableScheduler: boolean;
     scheduleLookaheadMs: number;
     scheduleIntervalMs: number;
     onStart?: (sample: SampleStart) => void;
@@ -244,9 +245,9 @@ type DrumMachineInstrument = {
     baseUrl: string;
     name: string;
     samples: string[];
-    sampleNames: string[];
-    nameToSample: Record<string, string | undefined>;
-    sampleNameVariations: Record<string, string[]>;
+    groupNames: string[];
+    nameToSampleName: Record<string, string | undefined>;
+    sampleGroupVariations: Record<string, string[]>;
 };
 
 declare function getDrumMachineNames(): string[];
@@ -262,11 +263,17 @@ declare class DrumMachine {
     readonly load: Promise<this>;
     readonly output: OutputChannel;
     constructor(context: AudioContext, options?: DrumMachineOptions);
-    loaded(): Promise<this>;
-    get sampleNames(): string[];
-    getVariations(name: string): string[];
+    getSampleNames(): string[];
+    getGroupNames(): string[];
+    getSampleNamesForGroup(groupName: string): string[];
     start(sample: SampleStart): StopFn;
     stop(sample: SampleStop): void;
+    /** @deprecated */
+    loaded(): Promise<this>;
+    /** @deprecated */
+    get sampleNames(): string[];
+    /** @deprecated */
+    getVariations(groupName: string): string[];
 }
 
 type SfzInstrument = {

package/dist/index.d.ts

@@ -232,6 +232,7 @@ declare class Sampler {
 }
 
 type QueuedPlayerConfig = {
+    disableScheduler: boolean;
     scheduleLookaheadMs: number;
     scheduleIntervalMs: number;
     onStart?: (sample: SampleStart) => void;
@@ -244,9 +245,9 @@ type DrumMachineInstrument = {
     baseUrl: string;
     name: string;
     samples: string[];
-    sampleNames: string[];
-    nameToSample: Record<string, string | undefined>;
-    sampleNameVariations: Record<string, string[]>;
+    groupNames: string[];
+    nameToSampleName: Record<string, string | undefined>;
+    sampleGroupVariations: Record<string, string[]>;
 };
 
 declare function getDrumMachineNames(): string[];
@@ -262,11 +263,17 @@ declare class DrumMachine {
     readonly load: Promise<this>;
     readonly output: OutputChannel;
     constructor(context: AudioContext, options?: DrumMachineOptions);
-    loaded(): Promise<this>;
-    get sampleNames(): string[];
-    getVariations(name: string): string[];
+    getSampleNames(): string[];
+    getGroupNames(): string[];
+    getSampleNamesForGroup(groupName: string): string[];
     start(sample: SampleStart): StopFn;
     stop(sample: SampleStop): void;
+    /** @deprecated */
+    loaded(): Promise<this>;
+    /** @deprecated */
+    get sampleNames(): string[];
+    /** @deprecated */
+    getVariations(groupName: string): string[];
 }
 
 type SfzInstrument = {