spessasynth_core documentation
    Preparing search index...

    Interface SynthProcessorOptions

    Additional options when initializing a SpessaSynthProcessor.

    interface SynthProcessorOptions {
        effectsEnabled: boolean;
        eventsEnabled: boolean;
        gsChorusProcessor?: GSChorusProcessor;
        gsDelayProcessor?: GSDelayProcessor;
        gsInsertionBlock?: GSInsertionBlock;
        gsReverbProcessor?: GSReverbProcessor;
        initialTime: number;
        maxBufferSize: number;
        xgChorusBlock?: XGChorusBlock;
        xgInsertionBlocks?: XGInsertionBlock[];
        xgReverbBlock?: XGReverbBlock;
        xgVariationBlock?: XGVariationBlock;
    }
    Index
    effectsEnabled eventsEnabled gsChorusProcessor? gsDelayProcessor? gsInsertionBlock? gsReverbProcessor? initialTime maxBufferSize xgChorusBlock? xgInsertionBlocks? xgReverbBlock? xgVariationBlock?
    effectsEnabled: boolean

    If the synthesizer processes the audio effects. This can be changed later.

    eventsEnabled: boolean

    If the event system is enabled. This can be changed later.

    Event types are described here: SynthesizerEvent

    gsChorusProcessor?: GSChorusProcessor

    Optional custom GS chorus processor for the synthesizer. Leave undefined to use DefaultGSChorus.

    gsDelayProcessor?: GSDelayProcessor

    Optional custom GS delay processor for the synthesizer. Leave undefined to use DefaultGSDelay.

    gsInsertionBlock?: GSInsertionBlock

    Optional custom GS insertion block for the synthesizer. Leave undefined to use DefaultGSInsertion.

    gsReverbProcessor?: GSReverbProcessor

    Optional custom GS reverb processor for the synthesizer. Leave undefined to use DefaultGSReverb.

    initialTime: number

    The initial time of the synthesizer, in seconds.

    maxBufferSize: number

    The maximum buffer size the synthesizer can render at once. Attempting to .process() more samples than this will result in an error. Defaults to 128.

    xgChorusBlock?: XGChorusBlock

    Optional custom XG chorus block for the synthesizer. Leave undefined to use DefaultXGChorus.

    xgInsertionBlocks?: XGInsertionBlock[]

    Optional custom XG insertion blocks for the synthesizer. Leave undefined to use DefaultXGInsertion. Default amount is 4 but theoretically any amount up to 127 (so 128 blocks) can be addressed.

    xgReverbBlock?: XGReverbBlock

    Optional custom XG reverb block for the synthesizer. Leave undefined to use DefaultXGReverb.

    xgVariationBlock?: XGVariationBlock

    Optional custom XG variation block for the synthesizer. Leave undefined to use DefaultXGVariation.

    Settings
    Member Visibility

    On This Page
    Properties