ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_change_release_function.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 3304 - (show annotations) (download) (as text)
Mon Jul 10 18:02:41 2017 UTC (2 years, 4 months ago) by schoenebeck
File MIME type: text/html
File size: 3377 byte(s)
* NKSP: updated docs for functions change_attack(), change_decay() and

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>change_release() function</title>
5 <meta name="description" content="Modifies the release time of voices of a particular note.">
6 </head>
7 <body>
8 <h1>change_release()</h1>
9 <p>
10 This function can be used to modify the release time of active voices of a
11 particular note.
12 In contrast to other synthesis parameter related functions,
13 this function only allows to change the release time when the respective note
14 is new, that is either i.e. at the beginning of a <code lang="nksp">note</code>
15 event handler or right after calling <code>play_note()</code>. So you should
16 perform the release value change as soon as possible, especially before calling any
17 <code>wait()</code> function and before entering a loop which might take a
18 long time to execute (which might cause your script to get
19 forcely suspended by the script engine due to real-time constraints).
20 </p>
21 <p>
22 The release time changes set by calling this function are always applied relatively to
23 the release time calculated by the synthesis model and sampler format. That means
24 the various sources of release factors like MIDI CCs and other release parameter
25 factors that may be defined by the instrument patch, are always processed and
26 calculated for the voices first, and the final release time applied is always
27 a relative combination of all those factors and the one set with this function call.
28 Or in other words: you cannot replace the release set by other synthesis
29 sources with this function.
30 </p>
32 <note class="important">
33 Release Trigger Samples: In case the affected voices cause release trigger
34 samples to be spawned later on, the release time of those release trigger voices
35 will not be affected by this function at all. So if you need to control the
36 release time of release trigger samples by script, then you might rather also trigger
37 those release trigger samples by script with <code lang="nksp">play_note()</code>
38 instead of using the sampler format's internal support for release trigger samples.
39 </note>
41 <h3>Function Prototype</h3>
42 <p/>
43 <code lang="nksp">
44 change_release(??note??, ??time??)
45 </code>
47 <h3>Arguments</h3>
48 <table>
49 <tr>
50 <th>Argument&nbsp;Name</th> <th>Data&nbsp;Type</th> <th>Description</th>
51 </tr>
52 <tr>
53 <td><code>??note??</code></td>
54 <td>Note ID Number or Note ID Array</td>
55 <td>All voices of this note will be modified.<br>
56 [required]</td>
57 </tr>
58 <tr>
59 <td><code>??time??</code></td>
60 <td>Integer&nbsp;Number</td>
61 <td>Attack Time Value (abstract non-negative value,
62 <code>0</code> for shortest time, <code>1000000</code> for neutral time factor,
63 <code>2000000</code> for doubling the effective release time).<br>
64 [required]</td>
65 </tr>
66 </table>
68 <h3>Return Value</h3>
69 <p>None.</p>
71 <h3>Examples</h3>
72 <p>None yet.<p>
74 <h3>Availability</h3>
75 <p>
76 Since LinuxSampler 2.0.0.svn19.
77 Prior to LinuxSampler 2.0.0.svn68 the value range for <code>??time??</code>
78 was limited to a maximum value of <code>1000000</code>.
79 </p>
81 </body>
82 </html>

  ViewVC Help
Powered by ViewVC