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>Parameter</h3>
    <p>The mandatory <code>??path??</code> parameter defines the file system
       path to the real-time instrument script file that shall be loaded and
       executed, which may either be an absolute path or a relative path. A
       relative path is always interpreted relative to the sfz file's
       location.</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	schoenebeck	3083	<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	schoenebeck	3103	<h3>Parameter</h3>
22			<p>The mandatory <code>??path??</code> parameter defines the file system
23			path to the real-time instrument script file that shall be loaded and
24			executed, which may either be an absolute path or a relative path. A
25			relative path is always interpreted relative to the sfz file's
26			location.</p>
27	schoenebeck	3083
28			<h3>Allowed Sections</h3>
29			<p>May only be used in <code><global></code> section.
30
31			<h3>Examples</h3>
32			<p>
33			Loads the WAV file "some_sound.wav" and assigns it to the entire key range of the instrument,
34			and loads the real-time instrument script file "my_nksp_script.txt" from the subdirectory
35			"myscripts". The script will be executed on the respective events the script file provides
36			event handlers for.
37			<p/>
38			<code lang="sfz">
39			<global>
40			script=myscripts/my_nksp_script.txt
41
42			<group>
43			sample=some_sound.wav
44			</code>
45
46			<h3>Availabilty</h3>
47			<p>Since LinuxSampler 2.0.0.svn37<p>
48			<p>Extension, not available with any SFZ standard.<p>
49
50			</body>
51			</html>