Class MIDIPatchTools

A class containing useful functions for working with MIDI patches.

Index

Methods

compare fromFullMIDIString fromMIDIString isXGDrum matches selectPatch toFullMIDIString toMIDIString

Methods

`Static`compare

compare(a: MIDIPatch, b: MIDIPatch): number
A comparison function for .sort() or .toSorted(), ordering the patches in ascending order.
Parameters
- a: MIDIPatch
- b: MIDIPatch
Returns number
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:183

`Static`fromFullMIDIString

fromFullMIDIString(string: string): MIDIPatchFull
Gets MIDIPatchFull from a given string.
Parameters
- string: string
Returns MIDIPatchFull
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:142

`Static`fromMIDIString

fromMIDIString(string: string): MIDIPatch
Gets MIDIPatch from a given string.
Parameters
- string: string
Returns MIDIPatch
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:106

`Static`isXGDrum

isXGDrum(p: MIDIPatchFull): boolean
Checks if the given MIDIPatchFull is an XG/GM2 drum patch.
Parameters
- p: MIDIPatchFull
Returns boolean
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:201

`Static`matches

matches(patch1: MIDIPatch, patch2: MIDIPatch): boolean
Checks if two MIDI patches represent the same one.
Parameters
- patch1: MIDIPatch
- patch2: MIDIPatch
Returns boolean
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:164

`Static`selectPatch

selectPatch<T extends MIDIPatchFull>(
    patches: T[],
    patch: MIDIPatch,
    system: MIDISystem,
): T
A sophisticated patch selection system based on the MIDI Patch system. This is the algorithm that the synthesizer uses for selecting presets.
Type Parameters
- T extends MIDIPatchFull
Parameters
- patches: T[]
  The MIDIPatchFull array to select from.
- patch: MIDIPatch
  The MIDIPatch to select.
- system: MIDISystem
  The MIDI system to select for.
Returns T
The selected patch.

Throws
Error An error if the array is empty,
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:214

`Static`toFullMIDIString

toFullMIDIString(patch: MIDIPatchFull): string
Converts a given MIDIPatchFull to string. The format is:
- <MIDIPatch string> D <name> for isDrum set to true.
- <MIDIPatch string> M <name> for isDrum set to false.
Parameters
- patch: MIDIPatchFull
Returns string
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:134

`Static`toMIDIString

toMIDIString(patch: MIDIPatch): string
Converts a given MIDIPatch to a string. The format is:
- DRUM:program for isGMGSDrum set to true.
- bankLSB:bankMSB:program for isGMGSDrum set to false.
Parameters
- patch: MIDIPatch
Returns string
- Defined in src/soundbank/basic_soundbank/midi_patch.ts:95