/[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 3251 by schoenebeck, Sun May 28 16:47:02 2017 UTC revision 3252 by schoenebeck, Mon May 29 22:42:46 2017 UTC
# Line 44  play_note(??note??, [??velocity??], [??o Line 44  play_note(??note??, [??velocity??], [??o
44          <td><code>??offset-us??</code></td>          <td><code>??offset-us??</code></td>
45          <td>Integer Number</td>          <td>Integer Number</td>
46          <td>Start offset of the sample to be played in microseconds.<br>          <td>Start offset of the sample to be played in microseconds.<br>
47              [optional, default: <code>0</code>]</td>              <code>-1</code>: Do not override the start offset and use the
48                                 regular start offset as defined by the
49                                 instrument file.<br>
50                [optional, default: <code>-1</code>]</td>
51        </tr>        </tr>
52        <tr>        <tr>
53          <td><code>??duration-us??</code></td>          <td><code>??duration-us??</code></td>
# Line 60  play_note(??note??, [??velocity??], [??o Line 63  play_note(??note??, [??velocity??], [??o
63    
64      <note>      <note>
65      You need at least LinuxSampler 2.0.0.svn2 or higher for passing a value      You need at least LinuxSampler 2.0.0.svn2 or higher for passing a value
66      higher than <code>0</code> for <code>??duration-us??</code>, and you need      higher than <code>0</code> for <code>??duration-us??</code>.<br>
67      at least LinuxSampler 2.0.0.svn3 or higher for passing <code>-1</code> for      <br>
68      <code>??duration-us??</code>.      You need at least LinuxSampler 2.0.0.svn3 or higher for passing <code>-1</code> for
69      </note>      <code>??duration-us??</code>.<br>
70        <br>
71      <note class="important">      You need at least LinuxSampler 2.0.0.svn55 or higher for passing any other value than <code>0</code> for
72      Passing any other value than <code>0</code> for <code>??offset-us??</code>      <code>??offset-us??</code>.
     is not supported by LinuxSampler yet.  
73      </note>      </note>
74    
75      <h3>Return Value</h3>      <h3>Return Value</h3>
# Line 121  on note Line 123  on note
123  end on  end on
124      </code>      </code>
125    
126        <h3>See also</h3>
127        <p><code>note_off()</code>, <code>set_controller()</code><p>
128    
129        <h3>Availability</h3>
130        <p>Since LinuxSampler 2.0.0<p>
131    
132        <note>
133        The special value <code>-1</code> for <code>??offset-us??</code> only exists
134        with NKSP, it is not available with KSP.<br>
135        <br>
136        Dynamic, optional arguments are
137        only supported by NKSP. If you want to retain compatibility to KSP,
138        then you should always pass a value for all arguments of this function.
139        </note>
140    
141    </body>    </body>
142  </html>  </html>
Legend:
Removed from v.3251  
changed lines
  Added in v.3252
  ViewVC Help
Powered by ViewVC