34 |
<email>schoenebeck at software minus engineering dot org</email> |
<email>schoenebeck at software minus engineering dot org</email> |
35 |
</address> |
</address> |
36 |
</author> |
</author> |
37 |
<date month="September" year="2008"/> |
<date month="December" year="2008"/> |
38 |
<workgroup>LinuxSampler Developers</workgroup> |
<workgroup>LinuxSampler Developers</workgroup> |
39 |
<keyword>LSCP</keyword> |
<keyword>LSCP</keyword> |
40 |
<abstract> |
<abstract> |
2512 |
<list> |
<list> |
2513 |
<t>numerical ID of the audio output device which is |
<t>numerical ID of the audio output device which is |
2514 |
currently connected to this sampler channel to output |
currently connected to this sampler channel to output |
2515 |
the audio signal, "NONE" if there's no device |
the audio signal, "-1" if there's no device |
2516 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2517 |
</list> |
</list> |
2518 |
</t> |
</t> |
2543 |
</t> |
</t> |
2544 |
<t>INSTRUMENT_NR - |
<t>INSTRUMENT_NR - |
2545 |
<list> |
<list> |
2546 |
<t>the instrument index number of the loaded instrument</t> |
<t>the instrument index number of the loaded instrument, |
2547 |
|
"-1" if there's no instrument loaded for this sampler |
2548 |
|
channel</t> |
2549 |
</list> |
</list> |
2550 |
</t> |
</t> |
2551 |
<t>INSTRUMENT_NAME - |
<t>INSTRUMENT_NAME - |
2557 |
</t> |
</t> |
2558 |
<t>INSTRUMENT_STATUS - |
<t>INSTRUMENT_STATUS - |
2559 |
<list> |
<list> |
2560 |
<t>integer values 0 to 100 indicating loading progress percentage for the instrument. Negative |
<t>Integer values 0 to 100 indicating loading progress |
2561 |
value indicates a loading exception. Value of 100 indicates that the instrument is fully |
percentage for the instrument. Negative |
2562 |
|
value indicates a loading exception (also returns "-1" in case no |
2563 |
|
instrument was yet to be loaded on the sampler channel). |
2564 |
|
Value of 100 indicates that the instrument is fully |
2565 |
loaded.</t> |
loaded.</t> |
2566 |
</list> |
</list> |
2567 |
</t> |
</t> |
2569 |
<list> |
<list> |
2570 |
<t>numerical ID of the MIDI input device which is |
<t>numerical ID of the MIDI input device which is |
2571 |
currently connected to this sampler channel to deliver |
currently connected to this sampler channel to deliver |
2572 |
MIDI input commands, "NONE" if there's no device |
MIDI input commands, "-1" if there's no device |
2573 |
connected to this sampler channel</t> |
connected to this sampler channel</t> |
2574 |
</list> |
</list> |
2575 |
</t> |
</t> |
2576 |
<t>MIDI_INPUT_PORT - |
<t>MIDI_INPUT_PORT - |
2577 |
<list> |
<list> |
2578 |
<t>port number of the MIDI input device</t> |
<t>port number of the MIDI input device (in case a |
2579 |
|
MIDI device was already assigned to the sampler |
2580 |
|
channel)</t> |
2581 |
</list> |
</list> |
2582 |
</t> |
</t> |
2583 |
<t>MIDI_INPUT_CHANNEL - |
<t>MIDI_INPUT_CHANNEL - |
4149 |
</list> |
</list> |
4150 |
</t> |
</t> |
4151 |
</section> |
</section> |
4152 |
|
|
4153 |
|
<section title="Getting global voice limit" anchor="GET VOICES"> |
4154 |
|
<t>The client can ask for the current global sampler-wide limit |
4155 |
|
for maximum voices by sending the following command:</t> |
4156 |
|
<t> |
4157 |
|
<list> |
4158 |
|
<t>GET VOICES</t> |
4159 |
|
</list> |
4160 |
|
</t> |
4161 |
|
<t>Possible Answers:</t> |
4162 |
|
<t> |
4163 |
|
<list> |
4164 |
|
<t>LinuxSampler will answer by returning the number for |
4165 |
|
the current limit of maximum voices.</t> |
4166 |
|
</list> |
4167 |
|
</t> |
4168 |
|
|
4169 |
|
<t>The voice limit setting defines how many voices should maximum |
4170 |
|
be processed by the sampler at the same time. If the user |
4171 |
|
triggers new notes which would exceed that voice limit, the |
4172 |
|
sampler engine will react by stealing old voices for those |
4173 |
|
newly triggered notes. Note that the amount of voices triggered |
4174 |
|
by a new note can be larger than one and is dependent to the |
4175 |
|
respective instrument and probably further criterias.</t> |
4176 |
|
</section> |
4177 |
|
|
4178 |
|
<section title="Setting global voice limit" anchor="SET VOICES"> |
4179 |
|
<t>The client can alter the current global sampler-wide limit |
4180 |
|
for maximum voices by sending the following command:</t> |
4181 |
|
<t> |
4182 |
|
<list> |
4183 |
|
<t>SET VOICES <max-voices></t> |
4184 |
|
</list> |
4185 |
|
</t> |
4186 |
|
<t>Where <max-voices> should be replaced by the integer |
4187 |
|
value, reflecting the new global amount limit of maximum voices. |
4188 |
|
This value has to be larger than 0.</t> |
4189 |
|
|
4190 |
|
<t>Possible Answers:</t> |
4191 |
|
<t> |
4192 |
|
<list> |
4193 |
|
<t>"OK" - |
4194 |
|
<list> |
4195 |
|
<t>on success</t> |
4196 |
|
</list> |
4197 |
|
</t> |
4198 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4199 |
|
<list> |
4200 |
|
<t>if the voice limit was set, but there are noteworthy |
4201 |
|
issue(s) related, providing an appropriate warning code and |
4202 |
|
warning message</t> |
4203 |
|
</list> |
4204 |
|
</t> |
4205 |
|
<t>"ERR:<error-code>:<error-message>" - |
4206 |
|
<list> |
4207 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4208 |
|
</list> |
4209 |
|
</t> |
4210 |
|
</list> |
4211 |
|
</t> |
4212 |
|
|
4213 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4214 |
|
The total amount of maximum voices on the running system might thus |
4215 |
|
be as big as the given value multiplied by the current amount of engine |
4216 |
|
instances.</t> |
4217 |
|
|
4218 |
|
<t>Caution: when adjusting the voice limit, you SHOULD also |
4219 |
|
adjust the disk stream limit respectively and vice versa.</t> |
4220 |
|
</section> |
4221 |
|
|
4222 |
|
<section title="Getting global disk stream limit" anchor="GET STREAMS"> |
4223 |
|
<t>The client can ask for the current global sampler-wide limit |
4224 |
|
for maximum disk streams by sending the following command:</t> |
4225 |
|
<t> |
4226 |
|
<list> |
4227 |
|
<t>GET STREAMS</t> |
4228 |
|
</list> |
4229 |
|
</t> |
4230 |
|
<t>Possible Answers:</t> |
4231 |
|
<t> |
4232 |
|
<list> |
4233 |
|
<t>LinuxSampler will answer by returning the number for |
4234 |
|
the current limit of maximum disk streams.</t> |
4235 |
|
</list> |
4236 |
|
</t> |
4237 |
|
|
4238 |
|
<t>The disk stream limit setting defines how many disk streams should |
4239 |
|
maximum be processed by a sampler engine at the same time. The |
4240 |
|
higher this value, the more memory (RAM) will be occupied, since |
4241 |
|
every disk streams allocates a certain buffer size for being able |
4242 |
|
to perform its streaming operations.</t> |
4243 |
|
</section> |
4244 |
|
|
4245 |
|
<section title="Setting global disk stream limit" anchor="SET STREAMS"> |
4246 |
|
<t>The client can alter the current global sampler-wide limit |
4247 |
|
for maximum disk streams by sending the following command:</t> |
4248 |
|
<t> |
4249 |
|
<list> |
4250 |
|
<t>SET STREAMS <max-streams></t> |
4251 |
|
</list> |
4252 |
|
</t> |
4253 |
|
<t>Where <max-streams> should be replaced by the integer |
4254 |
|
value, reflecting the new global amount limit of maximum disk streams. |
4255 |
|
This value has to be positive.</t> |
4256 |
|
|
4257 |
|
<t>Possible Answers:</t> |
4258 |
|
<t> |
4259 |
|
<list> |
4260 |
|
<t>"OK" - |
4261 |
|
<list> |
4262 |
|
<t>on success</t> |
4263 |
|
</list> |
4264 |
|
</t> |
4265 |
|
<t>"WRN:<warning-code>:<warning-message>" - |
4266 |
|
<list> |
4267 |
|
<t>if the disk stream limit was set, but there are noteworthy |
4268 |
|
issue(s) related, providing an appropriate warning code and |
4269 |
|
warning message</t> |
4270 |
|
</list> |
4271 |
|
</t> |
4272 |
|
<t>"ERR:<error-code>:<error-message>" - |
4273 |
|
<list> |
4274 |
|
<t>in case it failed, providing an appropriate error code and error message</t> |
4275 |
|
</list> |
4276 |
|
</t> |
4277 |
|
</list> |
4278 |
|
</t> |
4279 |
|
|
4280 |
|
<t>Note: the given value will be passed to all sampler engine instances. |
4281 |
|
The total amount of maximum disk streams on the running system might |
4282 |
|
thus be as big as the given value multiplied by the current amount of |
4283 |
|
engine instances.</t> |
4284 |
|
|
4285 |
|
<t>Caution: when adjusting the disk stream limit, you SHOULD also |
4286 |
|
adjust the voice limit respectively and vice versa.</t> |
4287 |
|
</section> |
4288 |
|
|
4289 |
</section> |
</section> |
4290 |
|
|
4291 |
|
|
6902 |
</t> |
</t> |
6903 |
<t>/ VOLUME |
<t>/ VOLUME |
6904 |
</t> |
</t> |
6905 |
|
<t>/ VOICES |
6906 |
|
</t> |
6907 |
|
<t>/ STREAMS |
6908 |
|
</t> |
6909 |
<t>/ FILE SP INSTRUMENTS SP filename |
<t>/ FILE SP INSTRUMENTS SP filename |
6910 |
</t> |
</t> |
6911 |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
<t>/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index |
6950 |
</t> |
</t> |
6951 |
<t>/ VOLUME SP volume_value |
<t>/ VOLUME SP volume_value |
6952 |
</t> |
</t> |
6953 |
|
<t>/ VOICES SP number |
6954 |
|
</t> |
6955 |
|
<t>/ STREAMS SP number |
6956 |
|
</t> |
6957 |
</list> |
</list> |
6958 |
</t> |
</t> |
6959 |
<t>create_instruction = |
<t>create_instruction = |
7860 |
replaced by the optional dotted floating point value, reflecting the |
replaced by the optional dotted floating point value, reflecting the |
7861 |
new global volume parameter.</t> |
new global volume parameter.</t> |
7862 |
</list> |
</list> |
7863 |
|
<list> |
7864 |
|
<t>"NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the |
7865 |
|
golbal limit of the sampler for maximum voices is changed, where |
7866 |
|
<max-voices> will be an integer value, reflecting the |
7867 |
|
new global voice limit parameter.</t> |
7868 |
|
</list> |
7869 |
|
<list> |
7870 |
|
<t>"NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the |
7871 |
|
golbal limit of the sampler for maximum disk streams is changed, where |
7872 |
|
<max-streams> will be an integer value, reflecting the |
7873 |
|
new global disk streams limit parameter.</t> |
7874 |
|
</list> |
7875 |
</t> |
</t> |
7876 |
</section> |
</section> |
7877 |
|
|