spessasynth_core documentation
    Preparing search index...

    Interface XGVariationBlockSnapshot

    A snapshot of a XGVariationBlock.

    interface XGVariationBlockSnapshot {
        insertionMode: boolean;
        pan: number;
        params: Int16Array;
        partNumber: number;
        return: number;
        sendToChorus: number;
        sendToReverb: number;
        type: number;
    }

    Hierarchy (View Summary)

    Index
    insertionMode: boolean

    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

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

    params: Int16Array

    The 16 parameter values for this effect block (14-bit wide params, 7-bit single-byte params).

    partNumber: number

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

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

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

    sendToChorus: number

    The amount of variation being sent to the chorus effect.

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

    sendToReverb: number

    The amount of variation being sent to the reverb effect.

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

    type: number

    The type of the processor. Per XG spec, BASIC EFFECT (LSB = 0) will be used if the exact match is missing. If both are missing, fallback will be used. The newly selected processor is reset to its type defaults, mirroring the GS insertion behavior.