Documents
Writing Docs Gigedit SFZ Instrument Scripts NKSP Language NKSP Reference

change_reso()

This function can be used to modify the filter resonance of active voices during their entire life time. You need to pass the note ID of the voices you want to alter. This function will change the resonance of all active voices associated with the requested note. So if you are using a layered instrument patch, then it will change the filter resonance of all layers.

The resonance changes set by calling this function are always applied relatively to the resonance calculated by the synthesis model and sampler format. That means the various sources of resonance factors like Filter Envelopes, Filter LFOs and other resonance factors that may be defined by the instrument patch, are always processed and calculated for the voices first, and the final resonance applied is always a relative combination of all those factors and the one set with this function call. Or in other words: you cannot replace the resonance set by other synthesis sources with this function.

There will only be audible changes with this function if a filter is actually already turned on (i.e. by enabling it in the instrument patch) and only if the filter is not closed by other sources (i.e. cutoff frequency should be set open in the instrument patch). Release Trigger Samples: In case the affected voices cause release trigger samples to be spawned later on, the resonance of those release trigger voices will not be affected by this function at all. So if you need to control the resonance of release trigger samples by script, then you might rather also trigger those release trigger samples by script with play_note() instead of using the sampler format's internal support for release trigger samples.

Function Prototype

change_reso(note, resonance)

Arguments

Argument Name Data Type Description
note Note ID Number or Note ID Array All voices of this note will be modified.
[required]
resonance Integer Number New Resonance Value (abstract absolute value between 0 and 1000000).
[required]

Return Value

None.

Examples

None yet.

Availabilty

Since LinuxSampler 2.0.0.svn12.

This function exists only with NKSP, it is not available with KSP, because KSP does not allow to change filter parameters on note level.

Document Updated:  2016-07-13  |  Author:  Christian Schoenebeck