/[svn]/doc/docbase/instrument_scripts/nksp/reference/functions/nksp_play_note_function.html
ViewVC logotype

Diff of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_play_note_function.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3253 by schoenebeck, Mon May 29 22:42:46 2017 UTC revision 3254 by schoenebeck, Tue May 30 12:17:15 2017 UTC
# Line 53  play_note(??note??, [??velocity??], [??o Line 53  play_note(??note??, [??velocity??], [??o
53          <td><code>??duration-us??</code></td>          <td><code>??duration-us??</code></td>
54          <td>Integer Number</td>          <td>Integer Number</td>
55          <td>Length of the note to be played in microseconds.<br>          <td>Length of the note to be played in microseconds.<br>
56                <code>0</code>: The entire note's sample will be played to its end.<br>
57              <code>-1</code>: The note will be stopped when the event              <code>-1</code>: The note will be stopped when the event
58                  handler's note stops (must only be used with                  handler's note stops (must only be used with
59                  <code>note</code> event handlers).<br>                  <code>note</code> event handlers).<br>
60              <code>0</code>: The entire note's sample will be played to its end.<br>              <code>-2</code>: The note will be stopped when a note-off event was received on the passed <code>??note??</code> number (argument 1).<br>
61              [optional, default: <code>0</code>]</td>              [optional, default: <code>0</code>]</td>
62        </tr>        </tr>
63      </table>      </table>
64    
65      <note>      <note>
66      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
67      higher than <code>0</code> for <code>??duration-us??</code>.<br>      higher than <code>0</code> for <code>??duration-us??</code>.<br>
68      <br>      <br>
69      You need at least LinuxSampler 2.0.0.svn3 or higher for passing <code>-1</code> for      You need at least LinuxSampler 2.0.0.svn3 for passing <code>-1</code> for
70      <code>??duration-us??</code>.<br>      <code>??duration-us??</code>.<br>
71      <br>      <br>
72      You need at least LinuxSampler 2.0.0.svn55 or higher for passing any other value than <code>0</code> for      You need at least LinuxSampler 2.0.0.svn55 for passing any other value than <code>0</code> for
73      <code>??offset-us??</code>.      <code>??offset-us??</code>.<br>
74        <br>
75        You need at least LinuxSampler 2.0.0.svn56 for passing <code>-2</code> for
76        <code>??duration-us??</code>.
77      </note>      </note>
78    
79      <h3>Return Value</h3>      <h3>Return Value</h3>
# Line 133  end on Line 137  end on
137      The special value <code>-1</code> for <code>??offset-us??</code> only exists      The special value <code>-1</code> for <code>??offset-us??</code> only exists
138      with NKSP, it is not available with KSP.<br>      with NKSP, it is not available with KSP.<br>
139      <br>      <br>
140        The special value <code>-2</code> for <code>??duration-us??</code> only exists
141        with NKSP, it is not available with KSP.<br>
142        <br>
143      Dynamic, optional arguments are      Dynamic, optional arguments are
144      only supported by NKSP. If you want to retain compatibility to KSP,      only supported by NKSP. If you want to retain compatibility to KSP,
145      then you should always pass a value for all arguments of this function.      then you should always pass a value for all arguments of this function.

Legend:
Removed from v.3253  
changed lines
  Added in v.3254

  ViewVC Help
Powered by ViewVC