--- doc/docbase/instrument_scripts/nksp/reference/functions/nksp_play_note_function.html 2017/05/30 12:08:45 3253 +++ doc/docbase/instrument_scripts/nksp/reference/functions/nksp_play_note_function.html 2017/05/30 12:17:15 3254 @@ -53,23 +53,27 @@ ??duration-us?? Integer Number Length of the note to be played in microseconds.
+ 0: The entire note's sample will be played to its end.
-1: The note will be stopped when the event handler's note stops (must only be used with note event handlers).
- 0: The entire note's sample will be played to its end.
+ -2: The note will be stopped when a note-off event was received on the passed ??note?? number (argument 1).
[optional, default: 0] - You need at least LinuxSampler 2.0.0.svn2 or higher for passing a value + You need at least LinuxSampler 2.0.0.svn2 for passing a value higher than 0 for ??duration-us??.

- You need at least LinuxSampler 2.0.0.svn3 or higher for passing -1 for + You need at least LinuxSampler 2.0.0.svn3 for passing -1 for ??duration-us??.

- You need at least LinuxSampler 2.0.0.svn55 or higher for passing any other value than 0 for - ??offset-us??. + You need at least LinuxSampler 2.0.0.svn55 for passing any other value than 0 for + ??offset-us??.
+
+ You need at least LinuxSampler 2.0.0.svn56 for passing -2 for + ??duration-us??.

Return Value

@@ -133,6 +137,9 @@ The special value -1 for ??offset-us?? only exists with NKSP, it is not available with KSP.

+ The special value -2 for ??duration-us?? only exists + with NKSP, it is not available with KSP.
+
Dynamic, optional arguments are only supported by NKSP. If you want to retain compatibility to KSP, then you should always pass a value for all arguments of this function.