Documents
Writing Docs Gigedit SFZ Instrument Scripts NKSP Language NKSP Reference

change_pan()

This function can be used to modify the stereo panorama (stereo balance) of active voices during their entire life time. So you may for example implement pan envelopes by script by using this function. You need to pass the note ID of the voices you want to alter. This function will change the panning of all active voices associated with the requested note. So if you are using a layered instrument patch, then it will change the panning of all layers.

The panning changes set by calling this function are always applied relatively to the panning/balance calculated by the synthesis model and sampler format. That means the various sources of panning/balance factors like MIDI CC #10 and other panning factors that may be defined by the instrument patch, are always processed and calculated for the voices first, and the final stereo balance applied is always a relative combination of all those factors and the one set with this function call. This does also not change when you pass 1 for argument relative. Or in other words: you cannot replace the panning/balance set by other synthesis sources with this function.

Release Trigger Samples: In case the affected voices cause release trigger samples to be spawned later on, the panning of those release trigger voices will not be affected by this function at all. So if you need to control the panning 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_pan(note, pan, [relative])

Arguments

Argument Name Data Type Description
note Note ID Number or Note ID Array All voices of this note will be modified.
[required]
pan Integer Number Value between -1000 (most left) and +1000 (most right).
[required]
relative Integer Number Whether change_pan() calls should be relative to each other.
0: A call to change_pan() upon the same note will replace the panning change value set by previous change_pan() calls upon the same note.
1: Successive calls to change_pan() upon the same note will be relatively applied against each other.
[optional, default: 0]

Return Value

None.

Examples

None yet.

Availability

Since LinuxSampler 2.0.0.svn11.

The third argument of this function relative is only optional with NKSP. If you want to keep compatibility with KSP, then you should always pass a value for that third argument of this function.

Document Updated:  2017-05-28  |  Author:  Christian Schoenebeck