v0.12.0 (#54)

* feat: add changelog and documentation * chore: bump deps
danigb · Dec 15, 2023 · 66b4654 · 66b4654
1 parent 410c86b
commit 66b4654
Show file tree

Hide file tree

Showing 4 changed files with 447 additions and 6,821 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # smplr
 
+## 0.12.0
+
+### Minor Changes
+
+- SplendidGrandPiano supports loading a subset of notes
+
 ## 0.11.x
 
 - 0.11.3 Add support for standardized audio context

diff --git a/README.md b/README.md
@@ -371,6 +371,30 @@ const piano = new SplendidGrandPiano(new AudioContext());
 piano.start({ note: "C4" });
 ```
 
+#### SplendidGrandPiano constructor
+
+The second argument of the constructor accepts the following options:
+
+- `baseUrl`:
+- `detune`: global detune in cents (0 if not specified)
+- `velocity`: default velocity (100 if not specified)
+- `volume`: default volume (100 if not specified)
+- `decayTime`: default decay time (0.5 seconds)
+- `notesToLoad`: an object with the following shape: `{ notes: number[], velocityRange: [number, number]}` to specify a subset of notes to load
+
+Example:
+
+```ts
+const piano = new SplendidGrandPiano(context, {
+  detune: -20,
+  volume: 80,
+  notesToLoad: {
+    notes: [60],
+    velocityRange: [1, 127],
+  },
+});
+```
+
 ### Electric Piano
 
 A sampled electric pianos. Samples from https://github.com/sfzinstruments/GregSullivan.E-Pianos