sfz/opcodes/sfz_script_opcode.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>script opcode</title>
    <meta name="description" content="Loads a real-time instrument script for the instrument.">
  </head>
  <body>
    <h1>script Opcode</h1>
    <p>
      This is an extension to the SFZ file format which is currently only
      available with LinuxSampler. It allows to load real-time instrument scripts
      for SFZ instruments. Find out more about <a href="01_instrument_scripts.html">Instrument Scripts ...</a>
    </p>
    
    <h3>Opcode Prototype</h3>
    <p/>
    <code lang="sfz">
script=??path??
    </code>

    <h3>Attribute</h3>
    <p>The mandatory <code>??path??</code> value defines the relative path to the real-time instrument script file that shall be loaded and executed.</p>

    <h3>Allowed Sections</h3>
    <p>May only be used in <code>&lt;global&gt;</code> section.
    
    <h3>Examples</h3>
    <p>
      Loads the WAV file "some_sound.wav" and assigns it to the entire key range of the instrument,
      and loads the real-time instrument script file "my_nksp_script.txt" from the subdirectory
      "myscripts". The script will be executed on the respective events the script file provides
      event handlers for.
    <p/>
    <code lang="sfz">
&lt;global&gt;
script=myscripts/my_nksp_script.txt

&lt;group&gt;
sample=some_sound.wav
    </code>

    <h3>Availabilty</h3>
    <p>Since LinuxSampler 2.0.0.svn37<p>
    <p>Extension, not available with any SFZ standard.<p>

  </body>
</html>
1	<html>
2	<head>
3	<meta name="author" content="Christian Schoenebeck">
4	<title>script opcode</title>
5	<meta name="description" content="Loads a real-time instrument script for the instrument.">
6	</head>
7	<body>
8	<h1>script Opcode</h1>
9	<p>
10	This is an extension to the SFZ file format which is currently only
11	available with LinuxSampler. It allows to load real-time instrument scripts
12	for SFZ instruments. Find out more about <a href="01_instrument_scripts.html">Instrument Scripts ...</a>
13	</p>
14
15	<h3>Opcode Prototype</h3>
16	<p/>
17	<code lang="sfz">
18	script=??path??
19	</code>
20
21	<h3>Attribute</h3>
22	<p>The mandatory <code>??path??</code> value defines the relative path to the real-time instrument script file that shall be loaded and executed.</p>
23
24	<h3>Allowed Sections</h3>
25	<p>May only be used in <code><global></code> section.
26
27	<h3>Examples</h3>
28	<p>
29	Loads the WAV file "some_sound.wav" and assigns it to the entire key range of the instrument,
30	and loads the real-time instrument script file "my_nksp_script.txt" from the subdirectory
31	"myscripts". The script will be executed on the respective events the script file provides
32	event handlers for.
33	<p/>
34	<code lang="sfz">
35	<global>
36	script=myscripts/my_nksp_script.txt
37
38	<group>
39	sample=some_sound.wav
40	</code>
41
42	<h3>Availabilty</h3>
43	<p>Since LinuxSampler 2.0.0.svn37<p>
44	<p>Extension, not available with any SFZ standard.<p>
45
46	</body>
47	</html>