spessasynth_core documentation
    Preparing search index...

    Interface ChannelSystemParameter

    Channel System Parameters are API-only parameters that affect a single MIDI channel.

    Parameters that also appear at the global level can be overridden at the channel level.

    They are System Parameters, meaning that they can only be changed via the API, and not via MIDI messages.

    DEFAULT_CHANNEL_SYSTEM_PARAMETERS is provided with the library, containing the defaults.

    Examples:

    • presetLock
    • isMuted
    interface ChannelSystemParameter {
        fineTune: number;
        gain: number;
        interpolationType: InterpolationType | null;
        isMuted: boolean;
        keyShift: number;
        monophonicRetrigger: boolean | null;
        nrpnParamLock: boolean | null;
        pan: number;
        presetLock: boolean;
    }
    Index
    fineTune gain interpolationType isMuted keyShift monophonicRetrigger nrpnParamLock pan presetLock
    fineTune: number

    The channel tuning in cents. Drum channels DO NOT ignore this value.

    gain: number

    The gain for the channel. From 0 to any number. 1 is 100% volume.

    interpolationType: InterpolationType | null

    The interpolation type used for sample playback. Interpolation defines how sample points between the sample data are calculated. This has high cost on performance but can improve the quality.

    Overrides the global parameter if set.

    isMuted: boolean

    If the channel should not produce any sound and ignore incoming Note On messages.

    keyShift: number

    The channel key shift in semitones. Drum channels DO NOT ignore this value.

    monophonicRetrigger: boolean | null

    Indicates whether the channel is in monophonic retrigger mode. This emulates the behavior of Microsoft GS Wavetable Synth, Where a new note will kill the previous one if it is still playing.

    Overrides the global parameter if set.

    nrpnParamLock: boolean | null

    If the channel should prevent changing any parameters via NRPN.

    Overrides the global parameter if set.

    pan: number

    The panning of the channel. -1 (left) to 1 (right). 0 is center.

    presetLock: boolean

    If the preset is locked, preventing any program changes from being sent.

    Settings
    Member Visibility

    On This Page
    Properties