1 |
<html> |
2 |
<head> |
3 |
<meta name="author" content="Christian Schoenebeck"> |
4 |
<title>sample opcode</title> |
5 |
<meta name="description" content="Loads and assigns an audio sample file."> |
6 |
</head> |
7 |
<body> |
8 |
<h1>sample Opcode</h1> |
9 |
<p> |
10 |
This is the most fundamental opcode of the SFZ file format. It allows you |
11 |
to load and assign a certain audio sample file. A variety of audio file |
12 |
formats are supported. |
13 |
</p> |
14 |
|
15 |
<h3>Opcode Prototype</h3> |
16 |
<p/> |
17 |
<code lang="sfz"> |
18 |
sample=??path?? |
19 |
</code> |
20 |
|
21 |
<h3>Parameter</h3> |
22 |
<p>The mandatory <code>??path??</code> parameter usually defines the file system |
23 |
path of the sample file that shall be loaded and assigned, which may |
24 |
either be an absolute path or a relative path. A relative path is |
25 |
always interpreted relative to the sfz file's location.</p> |
26 |
|
27 |
<p>Alternatively built-in samples may be used, which can be distinguished |
28 |
from regular samples by a star character as first character. |
29 |
Built-in samples are not covered by the standard, but are common among |
30 |
several sfz players.</p> |
31 |
|
32 |
<table> |
33 |
<tr> |
34 |
<th>Built-in Sample Name</th> <th>Description</th> <th>Availability</th> |
35 |
</tr> |
36 |
<tr> |
37 |
<td><code>*silence</code></td> |
38 |
<td>Don't play any sound.</td> |
39 |
<td>Since LinuxSampler 2.1.0.svn7</td> |
40 |
</tr> |
41 |
</table> |
42 |
|
43 |
<h3>Allowed Sections</h3> |
44 |
<p>May be used in sections <code><global></code>, <code><region></code>, ... TODO. |
45 |
|
46 |
<h3>Examples</h3> |
47 |
<p> |
48 |
Loads the WAV file "organ_c3.wav" from the subdirectory "mysamples" |
49 |
and assigns it to the entire key range of the instrument. |
50 |
<p/> |
51 |
<code lang="sfz"> |
52 |
<global> |
53 |
sample=mysamples/organ_c3.wav |
54 |
</code> |
55 |
|
56 |
<h3>Availability</h3> |
57 |
<p>Since LinuxSampler 2.0.0<p> |
58 |
<p>Conforms to SFZ v1 Standard.<p> |
59 |
|
60 |
</body> |
61 |
</html> |