1 |
<html> |
2 |
<head> |
3 |
<meta name="author" content="Christian Schoenebeck"> |
4 |
<title>get_event_par() function</title> |
5 |
<meta name="description" content="Get the current value of a specific note parameter."> |
6 |
</head> |
7 |
<body> |
8 |
<h1>get_event_par()</h1> |
9 |
<p> |
10 |
This function can be used to retrieve the current value of a certain |
11 |
parameter of the requested note. If the passed note ID is valid, then |
12 |
this function returns the note's current value of the requested |
13 |
parameter type. If the note ID is invalid or the note is no longer |
14 |
alive, then the value returned by this function is undefined. So you |
15 |
should call <code>event_status()</code> to ensure the note is still |
16 |
alive before calling this function. |
17 |
</p> |
18 |
<p> |
19 |
You might use function <code>set_event_par()</code> to change those |
20 |
parameters. |
21 |
</p> |
22 |
|
23 |
<h3>Function Prototype</h3> |
24 |
<p/> |
25 |
<code lang="nksp"> |
26 |
get_event_par(??note??, ??parameter??) |
27 |
</code> |
28 |
|
29 |
<h3>Arguments</h3> |
30 |
<table> |
31 |
<tr> |
32 |
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
33 |
</tr> |
34 |
<tr> |
35 |
<td><code>??note??</code></td> |
36 |
<td>Note ID Number or Note ID Array</td> |
37 |
<td>The note whose current parameter shall be retrieved.<br> |
38 |
[required]</td> |
39 |
</tr> |
40 |
<tr> |
41 |
<td><code>??parameter??</code></td> |
42 |
<td>Integer Number</td> |
43 |
<td>The actual parameter whose value should be retrieved. This must be one of the following built-in constants:<br> |
44 |
<code>$EVENT_PAR_NOTE</code>: To get the note's MIDI note number.<br> |
45 |
<code>$EVENT_PAR_TUNE</code>: To get the note's current tuning in milli cents (see <code>change_tune()</code>).<br> |
46 |
<code>$EVENT_PAR_VELOCITY</code>: To get the note's MIDI note velocity.<br> |
47 |
<code>$EVENT_PAR_VOLUME</code>: To get the note's current volume (see <code>change_vol()</code>).<br> |
48 |
<code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code>: To get the current value of one of the 4 |
49 |
possible user specific parameters. These user parameters are not used by the sampler itself, they can be |
50 |
used by the script author to pass data from one script (slot) to another script (slot) for example, or |
51 |
as an alternative to <a href="nksp.html#polyphonic_variables">polyphonic variables</a>.<br> |
52 |
[required]</td> |
53 |
</tr> |
54 |
</table> |
55 |
|
56 |
<h3>Return Value</h3> |
57 |
<table> |
58 |
<tr> |
59 |
<th>Description</th> <th>Data Type</th> |
60 |
</tr> |
61 |
<tr> |
62 |
<td>Current value of the requested note's parameter.</td> |
63 |
<td>Integer Number</td> |
64 |
</tr> |
65 |
</table> |
66 |
|
67 |
<h3>Examples</h3> |
68 |
<p>None yet.<p> |
69 |
|
70 |
<h3>See also</h3> |
71 |
<p><code>set_event_par()</code><p> |
72 |
|
73 |
<h3>Availability</h3> |
74 |
<p>Since LinuxSampler 2.0.0.svn46.<p> |
75 |
|
76 |
</body> |
77 |
</html> |