spessasynth_core documentation
    Preparing search index...

    Interface SynthesizerEvent

    SynthesizerEvent represents an event that SpessaSynthProcessor emits.

    Events can be received by specifying a SpessaSynthProcessor.onEventCall callback.

    Here are all the event types SpessaSynthProcessor emits as a summary.

    Name Interface Description
    noteOn NoteOnEvent Key has been pressed.
    noteOff NoteOffEvent Key has been released.
    controllerChange ControllerChangeEvent Controller has been changed.
    programChange ProgramChangeEvent Program has been changed.
    channelPressure — Channel's pressure has been changed.
    polyPressure PolyPressureEvent Note's pressure has been changed.
    stopAll StopAllEvent All voices were stopped on a given channel.
    channelAdded — A new channel was added to the synth.
    presetListChange — The preset list has been changed/initialized.
    reset — The synthesizer has been reset.
    displayMessage — The synthesizer has received a display message.
    globalParamChange GlobalMIDIParameterChangeEvent A global MIDI Parameter has been changed.
    channelParamChange ChannelMIDIParameterChangeEvent A channel MIDI Parameter has been changed.
    effectChange EffectChangeEvent An effect parameter has been changed.
    userDrumSetChange UserDrumSetChangeEvent A GS User Drum Set has been changed.
    interface SynthesizerEvent {
        channelAdded: void;
        channelParamChange: ChannelMIDIParameterChangeEvent;
        controllerChange: ControllerChangeEvent;
        displayMessage: DisplayMessageData;
        effectChange: EffectChangeEvent;
        globalParamChange: GlobalMIDIParameterChangeEvent;
        noteOff: NoteOffEvent;
        noteOn: NoteOnEvent;
        polyPressure: PolyPressureEvent;
        presetListChange: MIDIPatchFull[];
        programChange: ProgramChangeEvent;
        reset: MIDISystem;
        stopAll: StopAllEvent;
        userDrumSetChange: UserDrumSetChangeEvent;
    }
    Index
    channelAdded channelParamChange controllerChange displayMessage effectChange globalParamChange noteOff noteOn polyPressure presetListChange programChange reset stopAll userDrumSetChange
    channelAdded: void

    This event is triggered when a new channel is added to the synthesizer. Either manually, or when the sequencer detects a Multi-Port MIDI file. Consider reading About Multi-Port MIDI Files

    channelParamChange: ChannelMIDIParameterChangeEvent

    This event is triggered when a ChannelMIDIParameter changes.

    controllerChange: ControllerChangeEvent

    This event is triggered when a controller is changed on any channel (usually MIDI controller change), though some system exclusives can change it too.

    displayMessage: DisplayMessageData

    This event is triggered when a SysEx to display some text has been received.

    The data is the entire system exclusive, excluding the F0 status byte.

    Notable messages that can trigger this event:

    • All messages with GS Model ID of 0x45 (Display Data)
    • GS Patch Name
    • GS Drum Map Name
    • XG Display Letter
    • XG Display Bitmap
    effectChange: EffectChangeEvent

    This event is triggered when an effect processor has one of its parameters changed.

    The effects and their parameters can be found here:

    globalParamChange: GlobalMIDIParameterChangeEvent

    This event is triggered when a GlobalMIDIParameter changes.

    noteOff: NoteOffEvent

    This event is triggered when a note is released on any channel.

    noteOn: NoteOnEvent

    This event is triggered when a note is pressed on any channel.

    polyPressure: PolyPressureEvent

    This event is triggered when a MIDI polyphonic pressure event is received. This controls the pressure of a single note. By default, this controls vibrato in SpessaSynth, though it can be changed with sound bank modulators.

    presetListChange: MIDIPatchFull[]

    This event is triggered when the preset list has been changed or initialized, by adding, removing or changing sound banks, or when a MIDI with an embedded sound bank is loaded.

    The event data is the preset list.

    programChange: ProgramChangeEvent

    This event is triggered when a program is changed on any channel (usually MIDI program change), though some system exclusives can change it too.

    It is also called when receiving a system reset message.

    reset: MIDISystem

    This event is triggered when all controllers and programs have been reset. Effectively a system reset.

    The data is the new system the synthesizer was reset with.

    stopAll: StopAllEvent

    This event is triggered when all voices are stopped on a given channel. Either manually or when receiving a system reset.

    userDrumSetChange: UserDrumSetChangeEvent

    This event is triggered when a GS User Drum Set changes.

    Settings
    Member Visibility

    On This Page
    Table summary
    Properties