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

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

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

revision 2944 by schoenebeck, Wed Jul 13 16:52:58 2016 UTC revision 3604 by schoenebeck, Tue Sep 17 17:37:51 2019 UTC
# Line 16  Line 16 
16        all layers.        all layers.
17      </p>      </p>
18      <p>      <p>
19          Internally the sampler always fades the tuning from its current value to
20          the new tuning as requested, however that tuning fade by default is so fast
21          that it sounds like its value jumps directly from its old to the new value.
22          You may also override that automated fade time explicitly by calling
23          <code lang="nksp">change_tune_time()</code> before calling the
24          <code lang="nksp">change_tune()</code> function.
25        </p>
26        <p>
27        The tuning changes set by calling this function are always applied relatively to        The tuning changes set by calling this function are always applied relatively to
28        the tuning/pitch calculated by the synthesis model and sampler format. That means        the tuning/pitch calculated by the synthesis model and sampler format. That means
29        the various sources of tuning/pitch factors like MIDI pitch bend wheel, Pitch Envelopes,        the various sources of tuning/pitch factors like MIDI pitch bend wheel, Pitch Envelopes,
# Line 59  change_tune(??note??, ??tuning??, [??rel Line 67  change_tune(??note??, ??tuning??, [??rel
67          <td>Integer Number</td>          <td>Integer Number</td>
68          <td>Tuning change in milli cents.          <td>Tuning change in milli cents.
69              A positive value increases the tuning,              A positive value increases the tuning,
70              a negative value decreases the tuning.</td>              a negative value decreases the tuning.<br>
71                [required]</td>
72        </tr>        </tr>
73        <tr>        <tr>
74          <td><code>??relative??</code></td>          <td><code>??relative??</code></td>
75          <td>Integer Number</td>          <td>Integer&nbsp;Number&nbsp;or<br>
76                Real&nbsp;Number</td>
77          <td>Whether change_tune() calls should be relative to each other.<br>          <td>Whether change_tune() calls should be relative to each other.<br>
78              0: A call to <code>change_tune()</code> upon the same note will              <code>0</code>: A call to <code>change_tune()</code> upon the same note will
79                 replace the tuning change value set by previous                 replace the tuning change value set by previous
80                 <code>change_tune()</code> calls upon the same note.<br>                 <code>change_tune()</code> calls upon the same note.<br>
81              1: Successive calls to <code>change_tune()</code> upon the same              <code>1</code>: Successive calls to <code>change_tune()</code> upon the same
82                 note will be relatively applied against each other.<br>                 note will be relatively applied against each other.<br>
83              [optional, default: 0]</td>              [optional, default: <code>0</code>]</td>
84        </tr>        </tr>
85      </table>      </table>
86    
87      <h3>Return Value</h3>      <h3>Return Value</h3>
88      <p>None.</p>      <p>None.</p>
89    
90        <h3>Remarks</h3>
91        <p>
92          This functions optionally accepts <code>c</code> for "Cents" as standard unit and
93          finalness for its argument <code>??tuning??</code>.
94        </p>
95    
96      <h3>Examples</h3>      <h3>Examples</h3>
97      <p>None yet.<p>      <p>None yet.<p>
98    
99      <h3>Availabilty</h3>      <h3>See also</h3>
100        <p><code>change_tune_time()</code><p>
101    
102        <h3>Availability</h3>
103      <p>Since LinuxSampler 2.0.0.svn11.<p>      <p>Since LinuxSampler 2.0.0.svn11.<p>
104    
105        <note>
106          The third argument of this function <code>??relative??</code> is only
107          optional with NKSP. If you want to keep compatibility with KSP, then you
108          should always pass a value for that third argument of this function.
109        </note>
110        
111    </body>    </body>
112  </html>  </html>
Legend:
Removed from v.2944  
changed lines
  Added in v.3604
  ViewVC Help
Powered by ViewVC