spessasynth_core documentation
    Preparing search index...

    Class DefaultXGVariationSealed

    The default implementation for XGVariationBlock.

    Hierarchy (View Summary)

    Implements

    Index
    insertionMode: boolean = true

    Indicates if variation is in the insertion mode (CONNECTION). If false, then variation is in the system mode.

    The two connection modes work as following:

    • system routes all channels via sends (like reverb and chorus).
    • insertion routes a single partNumber channel straight through. Note that variation is processed last, after all insertion effects.
    pan: number = 64

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

    partNumber: number = 127

    The channel routed through the insertion effect, 0-based.

    127 or a value that's above the current channel count means OFF.

    processor: DefaultXGEffectProcessor

    The currently used processor.

    return: number = 64

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

    sendToChorus: number = 0

    The amount of variation being sent to the chorus effect.

    0 is none, 64 is 100% and 127 is 200%.

    sendToReverb: number = 0

    The amount of variation being sent to the reverb effect.

    0 is none, 64 is 100% and 127 is 200%.

    • Mixes the staged wet output into the system effect destination, applying return and pan.

      Parameters

      • 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.

      Returns void

    • Process the effect in system mode and adds it to the output. Feeds the chorus and reverb buffers according to the send amounts. The DSP's wet is fixed at 100% in this case.

      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.

      • chorusLeft: Float32Array

        The left chorus send buffer. It always starts at index 0.

      • chorusRight: Float32Array

        The right chorus send buffer. It always starts at index 0.

      • reverbLeft: Float32Array

        The left reverb send buffer. It always starts at index 0.

      • reverbRight: Float32Array

        The right reverb send buffer. It always starts at index 0.

      • 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