spessasynth_core 1.0.3 → 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@ A fork of [SpessaSynth](https://github.com/spessasus/SpessaSynth).
|
|
|
4
4
|
|
|
5
5
|
`npm install --save spessasynth_core`
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
|
|
8
8
|
> Looking for a browser version? Try [SpessaSynth](https://github.com/spessasus/SpessaSynth).
|
|
9
9
|
|
|
10
10
|
## Features:
|
|
@@ -95,8 +95,8 @@ synth.render(outputChannels, reverbOutputChannels, chorusOutputChannels);
|
|
|
95
95
|
- outputChannels - two `Float32Arrays` that get filled with the audio data. Left is the left channel and right is the right channel. Can be any length. (except zero)
|
|
96
96
|
- reverbOutputChannels - two `Float32Arrays` that get filled with the unprocessed audio data for reverb processing. Left is the left channel and right is the right channel. Can be undefined.
|
|
97
97
|
- reverbOutputChannels - two `Float32Arrays` that get filled with the unprocessed audio data for chorus processing. Left is the left channel and right is the right channel. Can be undefined.
|
|
98
|
-
|
|
99
|
-
|
|
98
|
+
|
|
99
|
+
**All arrays must be the same length.**
|
|
100
100
|
|
|
101
101
|
### noteOn
|
|
102
102
|
|
|
@@ -121,7 +121,6 @@ synth.noteOff(channel, midiNote);
|
|
|
121
121
|
|
|
122
122
|
- channel - the MIDI channel to use. Usually ranges from 0 to 15, but it depends on the channel count.
|
|
123
123
|
- midiNote - the note to play. Ranges from 0 to 127.
|
|
124
|
-
> [!TIP]
|
|
125
124
|
> To stop a note instantly, use `synth.killNote` (takes the same arguments)
|
|
126
125
|
|
|
127
126
|
### stopAllChannels
|
|
@@ -132,7 +131,6 @@ Stops all notes. Equivalent of MIDI "panic".
|
|
|
132
131
|
synth.stopAllChannels(force);
|
|
133
132
|
```
|
|
134
133
|
- force - `boolean`, if true, ignores the release time and stops everything instantly. Defaults to false.
|
|
135
|
-
> [!TIP]
|
|
136
134
|
> To stop all notes on a specific channel, use `synth.stopAll(channel, force)`. channel is the channel number.
|
|
137
135
|
|
|
138
136
|
### programChange
|
|
@@ -145,7 +143,6 @@ synth.programChange(channel, programNumber);
|
|
|
145
143
|
|
|
146
144
|
- channel - the MIDI channel to change. Usually ranges from 0 to 15, but it depends on the channel count.
|
|
147
145
|
- programNumber - the MIDI program number to use. Ranges from 0 to 127. To use other banks, go to [controllerChange](#controllerchange).
|
|
148
|
-
> [!TIP]
|
|
149
146
|
> To lock the preset (prevent MIDI file from changing it) use `synth.workletProcessorChannels[channel].lockPreset = true;`
|
|
150
147
|
|
|
151
148
|
### pitchWheel
|
|
@@ -158,7 +155,6 @@ synth.pitchWheel(channel, MSB, LSB);
|
|
|
158
155
|
|
|
159
156
|
- channel - the MIDI channel to use. Usually ranges from 0 to 15, but it depends on the channel count.
|
|
160
157
|
- MSB and LSB. 7-bit numbers that form a 14-bit pitch bend value.
|
|
161
|
-
> [!TIP]
|
|
162
158
|
> [I highly recommend this article for more info.](https://www.recordingblogs.com/wiki/midi-pitch-wheel-message)
|
|
163
159
|
|
|
164
160
|
### systemExclusive
|
|
@@ -170,7 +166,6 @@ synth.systemExclusive(messageData);
|
|
|
170
166
|
```
|
|
171
167
|
|
|
172
168
|
- message data - Uint8Array, the message byte data **Excluding the 0xF0 byte!**
|
|
173
|
-
> [!TIP]
|
|
174
169
|
> Refer to [this table](https://github.com/spessasus/SpessaSynth/wiki/Synthetizer-Class#supported-system-exclusives) for the list of supported System Exclusives.
|
|
175
170
|
|
|
176
171
|
### setMainVolume
|
|
@@ -231,7 +226,6 @@ synth.controllerChange(channel, controllerNumber, controllerValue);
|
|
|
231
226
|
- channel - the MIDI channel to use. Usually ranges from 0 to 15, but it depends on the channel count.
|
|
232
227
|
- controllerName - the MIDI CC number. Refer to [this table](https://github.com/spessasus/SpessaSynth/wiki/Synthetizer-Class#default-supported-controllers) for the list of controllers supported by default.
|
|
233
228
|
- controllerValue - the value to set the given controller to. Ranges from 0 to 127.
|
|
234
|
-
> [!NOTE]
|
|
235
229
|
> Note that theoreticallly all controllers are supported as it depends on the SoundFont's modulators.
|
|
236
230
|
|
|
237
231
|
### resetAllControllers
|