spessasynth_core documentation
    Preparing search index...

    Interface XGReverbBlock

    Reverb is an effect that adds reverberation to a sound, as you would hear in a concert hall.

    This is a Yamaha XG-compatible reverb interface.

    It is used when GlobalMIDIParameter.system is xg.

    SpessaSynthProcessor allows you to supply a custom reverb block. A custom reverb block must implement this interface.

    Editing the parameters can be done via XG system exclusive messages.

    interface XGReverbBlock {
        pan: number;
        return: number;
        applySnapshot(snapshot: XGSystemEffectBlockSnapshot): void;
        getSnapshot(): XGSystemEffectBlockSnapshot;
        getType(): number;
        process(
            inputLeft: Float32Array,
            inputRight: Float32Array,
            outputLeft: Float32Array,
            outputRight: Float32Array,
            startIndex: number,
            sampleCount: number,
        ): void;
        reset(): void;
        setParameter(param: number, value: number): void;
        setType(type: number): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    pan: number

    The stereo panning of this effect. 1 is hard left, 64 is center, 127 is hard right.

    return: number

    The return (level) of the effect. 0 is silence (-Inf dB), 64 is normal (0 dB) and 127 is double the volume (+6 dB).

    • Process the effect and adds it to the output.

      Parameters

      • inputLeft: Float32Array

        The input buffer to process. It always starts at index 0.

      • inputRight: Float32Array

        The input buffer to process. It always starts at index 0.

      • outputLeft: Float32Array

        The left output buffer.

      • outputRight: Float32Array

        The right output buffer.

      • startIndex: number

        The index to start mixing at into the output buffers.

      • sampleCount: number

        The amount of samples to mix. This will never be larger than SynthProcessorOptions.maxBufferSize of the parent SpessaSynthProcessor instance.

      Returns void