--- linuxsampler/trunk/Documentation/lscp.xml 2008/09/30 02:16:41 1782
+++ linuxsampler/trunk/Documentation/lscp.xml 2008/12/07 01:26:46 1800
@@ -34,7 +34,7 @@
schoenebeck at software minus engineering dot org
-
+
LinuxSampler Developers
LSCP
@@ -4142,6 +4142,143 @@
+
+
+ The client can ask for the current global sampler-wide limit
+ for maximum voices by sending the following command:
+
+
+ GET VOICES
+
+
+ Possible Answers:
+
+
+ LinuxSampler will answer by returning the number for
+ the current limit of maximum voices.
+
+
+
+ The voice limit setting defines how many voices should maximum
+ be processed by the sampler at the same time. If the user
+ triggers new notes which would exceed that voice limit, the
+ sampler engine will react by stealing old voices for those
+ newly triggered notes. Note that the amount of voices triggered
+ by a new note can be larger than one and is dependent to the
+ respective instrument and probably further criterias.
+
+
+
+ The client can alter the current global sampler-wide limit
+ for maximum voices by sending the following command:
+
+
+ SET VOICES <max-voices>
+
+
+ Where <max-voices> should be replaced by the integer
+ value, reflecting the new global amount limit of maximum voices.
+ This value has to be larger than 0.
+
+ Possible Answers:
+
+
+ "OK" -
+
+ on success
+
+
+ "WRN:<warning-code>:<warning-message>" -
+
+ if the voice limit was set, but there are noteworthy
+ issue(s) related, providing an appropriate warning code and
+ warning message
+
+
+ "ERR:<error-code>:<error-message>" -
+
+ in case it failed, providing an appropriate error code and error message
+
+
+
+
+
+ Note: the given value will be passed to all sampler engine instances.
+ The total amount of maximum voices on the running system might thus
+ be as big as the given value multiplied by the current amount of engine
+ instances.
+
+ Caution: when adjusting the voice limit, you SHOULD also
+ adjust the disk stream limit respectively and vice versa.
+
+
+
+ The client can ask for the current global sampler-wide limit
+ for maximum disk streams by sending the following command:
+
+
+ GET STREAMS
+
+
+ Possible Answers:
+
+
+ LinuxSampler will answer by returning the number for
+ the current limit of maximum disk streams.
+
+
+
+ The disk stream limit setting defines how many disk streams should
+ maximum be processed by a sampler engine at the same time. The
+ higher this value, the more memory (RAM) will be occupied, since
+ every disk streams allocates a certain buffer size for being able
+ to perform its streaming operations.
+
+
+
+ The client can alter the current global sampler-wide limit
+ for maximum disk streams by sending the following command:
+
+
+ SET STREAMS <max-streams>
+
+
+ Where <max-streams> should be replaced by the integer
+ value, reflecting the new global amount limit of maximum disk streams.
+ This value has to be positive.
+
+ Possible Answers:
+
+
+ "OK" -
+
+ on success
+
+
+ "WRN:<warning-code>:<warning-message>" -
+
+ if the disk stream limit was set, but there are noteworthy
+ issue(s) related, providing an appropriate warning code and
+ warning message
+
+
+ "ERR:<error-code>:<error-message>" -
+
+ in case it failed, providing an appropriate error code and error message
+
+
+
+
+
+ Note: the given value will be passed to all sampler engine instances.
+ The total amount of maximum disk streams on the running system might
+ thus be as big as the given value multiplied by the current amount of
+ engine instances.
+
+ Caution: when adjusting the disk stream limit, you SHOULD also
+ adjust the voice limit respectively and vice versa.
+
+
@@ -6758,6 +6895,10 @@
/ VOLUME
+ / VOICES
+
+ / STREAMS
+
/ FILE SP INSTRUMENTS SP filename
/ FILE SP INSTRUMENT SP INFO SP filename SP instrument_index
@@ -6802,6 +6943,10 @@
/ VOLUME SP volume_value
+ / VOICES SP number
+
+ / STREAMS SP number
+
create_instruction =
@@ -7708,6 +7853,18 @@
replaced by the optional dotted floating point value, reflecting the
new global volume parameter.
+
+ "NOTIFY:GLOBAL_INFO:VOICES <max-voices>" - Notifies that the
+ golbal limit of the sampler for maximum voices is changed, where
+ <max-voices> will be an integer value, reflecting the
+ new global voice limit parameter.
+
+
+ "NOTIFY:GLOBAL_INFO:STREAMS <max-streams>" - Notifies that the
+ golbal limit of the sampler for maximum disk streams is changed, where
+ <max-streams> will be an integer value, reflecting the
+ new global disk streams limit parameter.
+