spessasynth_lib documentation
    Preparing search index...

    Interface SynthConfig

    Configuration options for the synthesizer.

    interface SynthConfig {
        audioNodeCreators?: AudioNodeCreators;
        convolverMode: boolean;
        eventsEnabled: boolean;
    }
    Index
    audioNodeCreators?: AudioNodeCreators

    Custom audio node creation functions for Web Audio wrappers, such as standardized-audio-context. Pass undefined to use the Web Audio API.

    convolverMode: boolean

    If the convolver mode should be enabled. In the convolver mode, the synthesizer captures its reverb output and feeds it into a Web Audio ConvolverNode. This lets you use a custom impulse response for the synth's reverb tail instead of the built-in reverb engine.

    • When enabled, the reverb is removed from the main output and exposed as a separate stream that is processed by the ConvolverNode.
    • The impulse response is loaded internally from the library and can be replaced by assigning a new buffer to the BasicSynthesizer.convolverNode.
    eventsEnabled: boolean

    If the event system should be enabled. It can be changed later with the eventsEnabled GlobalSystemParameter.

    If false, no event will be emitted by the SynthEventHandler. The synthesizer state, such as BasicSynthesizer.presetList and BasicSynthesizer.midiChannels, and the Sequencer keep working, as the core still sends the data it needs to sync them.