--- web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html 2007/01/14 17:31:48 1027 +++ web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.html 2007/01/14 17:33:03 1028 @@ -145,7 +145,7 @@ LinuxSampler DevelopersC. Schoenebeck Internet-DraftInteressengemeinschaft Software Intended status: Standards TrackEngineering e. V. -Expires: July 2, 2007December 29, 2006 +Expires: July 18, 2007January 14, 2007


LinuxSampler Control Protocol
LSCP 1.2

@@ -173,11 +173,11 @@ The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html.

-This Internet-Draft will expire on July 2, 2007.

+This Internet-Draft will expire on July 18, 2007.

Copyright Notice

-Copyright © The Internet Society (2006).

+Copyright © The Internet Society (2007).

Abstract

@@ -330,7 +330,11 @@ Getting effect send information
        6.4.30.  Altering effect send's audio routing
-        6.4.31.  +        6.4.31.  +Altering effect send's MIDI controller
+        6.4.32.  +Altering effect send's send level
+        6.4.33.  Resetting a sampler channel
    6.5.  Controlling connection
@@ -3958,7 +3962,7 @@

optionally dotted number for the channel volume factor - (where a value < 1.0 means attenuation and a value > + (where a value < 1.0 means attenuation and a value > 1.0 means amplification)

@@ -5260,6 +5264,25 @@ +

MIDI_CONTROLLER - +

+
+

a value between 0 and 127 reflecting the MIDI controller + which is able to modify the effect send's send level +

+
+ + +

LEVEL - +

+
+

optionally dotted number reflecting the effect send's + current send level (where a value < 1.0 means attenuation + and a value > 1.0 means amplification) +

+
+ +

AUDIO_OUTPUT_ROUTING -

@@ -5293,6 +5316,10 @@

S: "NAME: Reverb Send"

+

   "MIDI_CONTROLLER: 91" +

+

   "LEVEL: 0.3" +

   "AUDIO_OUTPUT_ROUTING: 2,3"

   "." @@ -5383,9 +5410,152 @@

-
+
 TOC 

6.4.31.  +Altering effect send's MIDI controller

+ +

The front-end can alter the MIDI controller of an effect + send entity by sending the following command: +

+

+

+
+

SET FX_SEND MIDI_CONTROLLER <sampler-chan> <fx-send-id> <midi-ctrl> +

+

+ +

+

Where <sampler-chan> is the sampler channel number + as returned by the "ADD CHANNEL" (Adding a new sampler channel) + or "LIST CHANNELS" (Getting all created sampler channel list) command, + <fx-send-id> reflects the numerical ID of the effect send entity + as returned by the "CREATE FX_SEND" (Adding an effect send to a sampler channel) + or "LIST FX_SENDS" (Listing all effect sends on a sampler channel) command and + <midi-ctrl> reflects the MIDI controller which shall be + able to modify the effect send's send level. +

+

Possible Answers: +

+

+

+
+

"OK" - +

+
+

on success +

+
+ + +

"WRN:<warning-code>:<warning-message>" - +

+
+

if MIDI controller 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 +

+
+ + +

+ +

+

Example: +

+

+

+
+

C: "SET FX_SEND MIDI_CONTROLLER 0 0 91" +

+

S: "OK" +

+

+ +

+
+
 TOC 
+

6.4.32.  +Altering effect send's send level

+ +

The front-end can alter the current send level of an effect + send entity by sending the following command: +

+

+

+
+

SET FX_SEND LEVEL <sampler-chan> <fx-send-id> <volume> +

+

+ +

+

Where <sampler-chan> is the sampler channel number + as returned by the "ADD CHANNEL" (Adding a new sampler channel) + or "LIST CHANNELS" (Getting all created sampler channel list) command, + <fx-send-id> reflects the numerical ID of the effect send entity + as returned by the "CREATE FX_SEND" (Adding an effect send to a sampler channel) + or "LIST FX_SENDS" (Listing all effect sends on a sampler channel) command and + <volume> is an optionally dotted positive number (a value + smaller than 1.0 means attenuation, whereas a value greater than + 1.0 means amplification) reflecting the new send level. +

+

Possible Answers: +

+

+

+
+

"OK" - +

+
+

on success +

+
+ + +

"WRN:<warning-code>:<warning-message>" - +

+
+

if new send level 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 +

+
+ + +

+ +

+

Example: +

+

+

+
+

C: "SET FX_SEND LEVEL 0 0 0.15" +

+

S: "OK" +

+

+ +

+
+
 TOC 
+

6.4.33.  Resetting a sampler channel

The front-end can reset a particular sampler channel by sending the following command: @@ -6338,7 +6508,7 @@ <instrument_index> the index (integer value) of the instrument within the given file, <volume_value> reflects the master volume of the instrument as optionally dotted number (where a - value < 1.0 means attenuation and a value > 1.0 means + value < 1.0 means attenuation and a value > 1.0 means amplification). This parameter easily allows to adjust the volume of all intruments within a custom instrument map without having to adjust their instrument files. The @@ -6801,7 +6971,7 @@

master volume of the instrument as optionally - dotted number (where a value < 1.0 means attenuation + dotted number (where a value < 1.0 means attenuation and a value > 1.0 means amplification)

@@ -7319,6 +7489,12 @@

/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index

+

/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl + +

+

/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value + +

/ ECHO SP boolean

@@ -8287,7 +8463,7 @@
 TOC 

Full Copyright Statement

-Copyright © The Internet Society (2006).

+Copyright © The Internet Society (2007).

This document is subject to the rights, licenses and restrictions contained in BCP 78,