soundfont2/src/types/key.ts

A SoundFont2 parser for Node.js and web browsers

import { Preset } from './preset';
import { Instrument } from './instrument';
import { Sample } from './sample';
import { ZoneMap } from './zone';
import { Generator } from './generator';
import { Modulator } from './modulator';

/**
 * Key data specific to a MIDI key.
 */
export interface Key {
  /**
   * The MIDI key number. Must be a number between 0 and 127.
   */
  keyNumber: number;

  /**
   * The preset for this MIDI key.
   */
  preset: Preset;

  /**
   * The instrument for this MIDI key.
   */
  instrument: Instrument;

  /**
   * The sample for this MIDI key.
   */
  sample: Sample;

  /**
   * The generators for this MIDI key. Note that these are the preset generators merged with the
   * instrument generators.
   */
  generators: ZoneMap<Generator>;

  /**
   * The modulators for this MIDI key. Note that these are the preset modulators merged with the
   * instrument modulators.
   */
  modulators: ZoneMap<Modulator>;
}