reference/functions/nksp_set_event_par_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>set_event_par() function</title>
    <meta name="description" content="Change the current value of a specific note parameter.">
  </head>
  <body>
    <h1>set_event_par()</h1>
    <p>
      This function can be used to change the current value of a certain
      parameter of the requested note. If the passed note ID is invalid
      or if the requested note is no longer alive, then this function does
      nothing.
    </p>
    <p>
      You might use function <code>get_event_par()</code> to retrieve the
      current value of those parameters.
    </p>

    <h3>Function Prototype</h3>
    <p/>
    <code lang="nksp">
set_event_par(??note??, ??parameter??, ??value??)
    </code>

    <h3>Arguments</h3>
    <table>
      <tr>
        <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
      </tr>
      <tr>
        <td><code>??note??</code></td>
        <td>Note ID Number or Note ID Array</td>
        <td>The note whose current parameter shall be changed.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??parameter??</code></td>
        <td>Integer Number</td>
        <td>The actual parameter whose value should be modified. This must be one of the following built-in constants:<br>
            <code>$EVENT_PAR_NOTE</code>: Change the note's MIDI note number (only possible when note is new).<br>
            <code>$EVENT_PAR_TUNE</code>: Change the note's tuning in milli cents (currently ignored, use <code>change_tune()</code> instead).<br>
            <code>$EVENT_PAR_VELOCITY</code>: Change the note's MIDI note velocity (only possible when note is new).<br>
            <code>$EVENT_PAR_VOLUME</code>: Change the note's volume (currently ignored, use <code>change_vol()</code> instead).<br>
            <code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code>: To change the current value of one of the 4
            available user specific parameters. Those user parameters are not used by the sampler itself, they can be
            used by the script author to pass data from one script (slot) to another script (slot) for example, or
            as an alternative to <a href="nksp.html#polyphonic_variables">polyphonic variables</a>.<br>
            [required]</td>
      </tr>
    </table>

    <h3>Return Value</h3>
    <p>None.</p>

    <h3>Examples</h3>
    <p>None yet.<p>

    <h3>See also</h3>
    <p><code>get_event_par()</code>, <code>change_vol()</code>, <code>change_tune()</code><p>

    <h3>Availabilty</h3>
    <p>Since LinuxSampler 2.0.0.svn46.<p>

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