/[svn]/web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt
ViewVC logotype

Diff of /web/trunk/www.linuxsampler.org/api/draft-linuxsampler-protocol.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2497 by iliev, Fri Jun 24 19:57:07 2011 UTC revision 2498 by schoenebeck, Thu Jan 9 22:05:21 2014 UTC
# Line 2  Line 2 
2    
3    
4  LinuxSampler Developers                                   C. Schoenebeck  LinuxSampler Developers                                   C. Schoenebeck
5  Internet-Draft                           Interessengemeinschaft Software  Internet-Draft                                          LinuxSampler.org
6  Intended status: Standards Track                       Engineering e. V.  Intended status: Standards Track                         January 9, 2014
7  Expires: December 26, 2011                                 June 24, 2011  Expires: July 13, 2014
8    
9    
10                       LinuxSampler Control Protocol                       LinuxSampler Control Protocol
11                                  LSCP 1.5                                  LSCP 1.6
12    
13  Abstract  Abstract
14    
# Line 26  Status of this Memo Line 26  Status of this Memo
26     aware will be disclosed, in accordance with Section 6 of BCP 79.     aware will be disclosed, in accordance with Section 6 of BCP 79.
27    
28     Internet-Drafts are working documents of the Internet Engineering     Internet-Drafts are working documents of the Internet Engineering
29     Task Force (IETF), its areas, and its working groups.  Note that     Task Force (IETF).  Note that other groups may also distribute
30     other groups may also distribute working documents as Internet-     working documents as Internet-Drafts.  The list of current Internet-
31     Drafts.     Drafts is at http://datatracker.ietf.org/drafts/current/.
32    
33     Internet-Drafts are draft documents valid for a maximum of six months     Internet-Drafts are draft documents valid for a maximum of six months
34     and may be updated, replaced, or obsoleted by other documents at any     and may be updated, replaced, or obsoleted by other documents at any
35     time.  It is inappropriate to use Internet-Drafts as reference     time.  It is inappropriate to use Internet-Drafts as reference
36     material or to cite them other than as "work in progress."     material or to cite them other than as "work in progress."
37    
38     The list of current Internet-Drafts can be accessed at     This Internet-Draft will expire on July 13, 2014.
    http://www.ietf.org/ietf/1id-abstracts.txt.  
39    
    The list of Internet-Draft Shadow Directories can be accessed at  
    http://www.ietf.org/shadow.html.  
40    
    This Internet-Draft will expire on December 26, 2011.  
41    
42    
43    
# Line 52  Status of this Memo Line 48  Status of this Memo
48    
49    
50    
51  Schoenebeck             Expires December 26, 2011               [Page 1]  
52    
53    
54    
55    Schoenebeck               Expires July 13, 2014                 [Page 1]
56    
57  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
58    
59    
60  Table of Contents  Table of Contents
# Line 108  Table of Contents Line 108  Table of Contents
108    
109    
110    
111  Schoenebeck             Expires December 26, 2011               [Page 2]  Schoenebeck               Expires July 13, 2014                 [Page 2]
112    
113  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
114    
115    
116         6.4.2.   Loading a sampler engine . . . . . . . . . . . . . .  45         6.4.2.   Loading a sampler engine . . . . . . . . . . . . . .  45
# Line 121  Internet-Draft        LinuxSampler Contr Line 121  Internet-Draft        LinuxSampler Contr
121         6.4.7.   Getting amount of available engines  . . . . . . . .  49         6.4.7.   Getting amount of available engines  . . . . . . . .  49
122         6.4.8.   Getting all available engines  . . . . . . . . . . .  49         6.4.8.   Getting all available engines  . . . . . . . . . . .  49
123         6.4.9.   Getting information about an engine  . . . . . . . .  49         6.4.9.   Getting information about an engine  . . . . . . . .  49
124         6.4.10.  Getting sampler channel information  . . . . . . . .  50         6.4.10.  Getting sampler channel information  . . . . . . . .  51
125         6.4.11.  Current number of active voices  . . . . . . . . . .  53         6.4.11.  Current number of active voices  . . . . . . . . . .  54
126         6.4.12.  Current number of active disk streams  . . . . . . .  54         6.4.12.  Current number of active disk streams  . . . . . . .  54
127         6.4.13.  Current fill state of disk stream buffers  . . . . .  54         6.4.13.  Current fill state of disk stream buffers  . . . . .  55
128         6.4.14.  Setting audio output device  . . . . . . . . . . . .  55         6.4.14.  Setting audio output device  . . . . . . . . . . . .  56
129         6.4.15.  Setting audio output type  . . . . . . . . . . . . .  56         6.4.15.  Setting audio output type  . . . . . . . . . . . . .  56
130         6.4.16.  Setting audio output channel . . . . . . . . . . . .  57         6.4.16.  Setting audio output channel . . . . . . . . . . . .  57
131         6.4.17.  Setting MIDI input device  . . . . . . . . . . . . .  58         6.4.17.  Add MIDI input to sampler channel  . . . . . . . . .  58
132         6.4.18.  Setting MIDI input type  . . . . . . . . . . . . . .  58         6.4.18.  Remove MIDI input(s) from sampler channel  . . . . .  59
133         6.4.19.  Setting MIDI input port  . . . . . . . . . . . . . .  59         6.4.19.  Getting all MIDI inputs of a sampler channel . . . .  60
134         6.4.20.  Setting MIDI input channel . . . . . . . . . . . . .  60         6.4.20.  Setting MIDI input device  . . . . . . . . . . . . .  61
135         6.4.21.  Setting channel volume . . . . . . . . . . . . . . .  60         6.4.21.  Setting MIDI input type  . . . . . . . . . . . . . .  62
136         6.4.22.  Muting a sampler channel . . . . . . . . . . . . . .  61         6.4.22.  Setting MIDI input port  . . . . . . . . . . . . . .  63
137         6.4.23.  Soloing a sampler channel  . . . . . . . . . . . . .  62         6.4.23.  Setting MIDI input channel . . . . . . . . . . . . .  64
138         6.4.24.  Assigning a MIDI instrument map to a sampler         6.4.24.  Setting channel volume . . . . . . . . . . . . . . .  65
139                  channel  . . . . . . . . . . . . . . . . . . . . . .  62         6.4.25.  Muting a sampler channel . . . . . . . . . . . . . .  66
140         6.4.25.  Adding an effect send to a sampler channel . . . . .  63         6.4.26.  Soloing a sampler channel  . . . . . . . . . . . . .  66
141         6.4.26.  Removing an effect send from a sampler channel . . .  65         6.4.27.  Assigning a MIDI instrument map to a sampler
142         6.4.27.  Getting amount of effect sends on a sampler                  channel  . . . . . . . . . . . . . . . . . . . . . .  67
143                  channel  . . . . . . . . . . . . . . . . . . . . . .  65         6.4.28.  Adding an effect send to a sampler channel . . . . .  68
144         6.4.28.  Listing all effect sends on a sampler channel  . . .  66         6.4.29.  Removing an effect send from a sampler channel . . .  69
145         6.4.29.  Getting effect send information  . . . . . . . . . .  66         6.4.30.  Getting amount of effect sends on a sampler
146         6.4.30.  Changing effect send's name  . . . . . . . . . . . .  68                  channel  . . . . . . . . . . . . . . . . . . . . . .  70
147         6.4.31.  Altering effect send's audio routing . . . . . . . .  69         6.4.31.  Listing all effect sends on a sampler channel  . . .  71
148         6.4.32.  Assigning destination effect to an effect send . . .  70         6.4.32.  Getting effect send information  . . . . . . . . . .  71
149         6.4.33.  Removing destination effect from an effect send  . .  71         6.4.33.  Changing effect send's name  . . . . . . . . . . . .  73
150         6.4.34.  Altering effect send's MIDI controller . . . . . . .  72         6.4.34.  Altering effect send's audio routing . . . . . . . .  74
151         6.4.35.  Altering effect send's send level  . . . . . . . . .  72         6.4.35.  Assigning destination effect to an effect send . . .  75
152         6.4.36.  Sending MIDI messages to sampler channel . . . . . .  73         6.4.36.  Removing destination effect from an effect send  . .  76
153         6.4.37.  Resetting a sampler channel  . . . . . . . . . . . .  74         6.4.37.  Altering effect send's MIDI controller . . . . . . .  76
154       6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  75         6.4.38.  Altering effect send's send level  . . . . . . . . .  77
155         6.5.1.   Register front-end for receiving event messages  . .  75         6.4.39.  Sending MIDI messages to sampler channel . . . . . .  78
156           6.4.40.  Resetting a sampler channel  . . . . . . . . . . . .  79
157         6.5.  Controlling connection  . . . . . . . . . . . . . . . . .  80
158           6.5.1.   Register front-end for receiving event messages  . .  80
159         6.5.2.   Unregister front-end for not receiving event         6.5.2.   Unregister front-end for not receiving event
160                  messages . . . . . . . . . . . . . . . . . . . . . .  76                  messages . . . . . . . . . . . . . . . . . . . . . .  81
161         6.5.3.   Enable or disable echo of commands . . . . . . . . .  76         6.5.3.   Enable or disable echo of commands . . . . . . . . .  81
162         6.5.4.   Close client connection  . . . . . . . . . . . . . .  77         6.5.4.   Close client connection  . . . . . . . . . . . . . .  82
163       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  77       6.6.  Global commands . . . . . . . . . . . . . . . . . . . . .  82
        6.6.1.   Current number of active voices  . . . . . . . . . .  77  
        6.6.2.   Maximum amount of active voices  . . . . . . . . . .  78  
        6.6.3.   Current number of active disk streams  . . . . . . .  78  
164    
165    
166    
167  Schoenebeck             Expires December 26, 2011               [Page 3]  Schoenebeck               Expires July 13, 2014                 [Page 3]
168    
169  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
170    
171    
172         6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  78         6.6.1.   Current number of active voices  . . . . . . . . . .  82
173         6.6.5.   General sampler informations . . . . . . . . . . . .  78         6.6.2.   Maximum amount of active voices  . . . . . . . . . .  82
174         6.6.6.   Getting global volume attenuation  . . . . . . . . .  79         6.6.3.   Current number of active disk streams  . . . . . . .  83
175         6.6.7.   Setting global volume attenuation  . . . . . . . . .  80         6.6.4.   Reset sampler  . . . . . . . . . . . . . . . . . . .  83
176         6.6.8.   Getting global voice limit . . . . . . . . . . . . .  80         6.6.5.   General sampler informations . . . . . . . . . . . .  83
177         6.6.9.   Setting global voice limit . . . . . . . . . . . . .  81         6.6.6.   Getting global volume attenuation  . . . . . . . . .  84
178         6.6.10.  Getting global disk stream limit . . . . . . . . . .  81         6.6.7.   Setting global volume attenuation  . . . . . . . . .  85
179         6.6.11.  Setting global disk stream limit . . . . . . . . . .  82         6.6.8.   Getting global voice limit . . . . . . . . . . . . .  85
180       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  83         6.6.9.   Setting global voice limit . . . . . . . . . . . . .  86
181         6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  83         6.6.10.  Getting global disk stream limit . . . . . . . . . .  87
182         6.7.2.   Delete one particular or all MIDI instrument maps  .  84         6.6.11.  Setting global disk stream limit . . . . . . . . . .  87
183         6.7.3.   Get amount of existing MIDI instrument maps  . . . .  85       6.7.  MIDI Instrument Mapping . . . . . . . . . . . . . . . . .  88
184         6.7.4.   Getting all created MIDI instrument maps . . . . . .  85         6.7.1.   Create a new MIDI instrument map . . . . . . . . . .  88
185         6.7.5.   Getting MIDI instrument map information  . . . . . .  86         6.7.2.   Delete one particular or all MIDI instrument maps  .  89
186         6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  87         6.7.3.   Get amount of existing MIDI instrument maps  . . . .  90
187         6.7.7.   Create or replace a MIDI instrument map entry  . . .  87         6.7.4.   Getting all created MIDI instrument maps . . . . . .  90
188         6.7.8.   Getting ammount of MIDI instrument map entries . . .  90         6.7.5.   Getting MIDI instrument map information  . . . . . .  91
189           6.7.6.   Renaming a MIDI instrument map . . . . . . . . . . .  92
190           6.7.7.   Create or replace a MIDI instrument map entry  . . .  92
191           6.7.8.   Getting amount of MIDI instrument map entries  . . .  95
192         6.7.9.   Getting indeces of all entries of a MIDI         6.7.9.   Getting indeces of all entries of a MIDI
193                  instrument map . . . . . . . . . . . . . . . . . . .  91                  instrument map . . . . . . . . . . . . . . . . . . .  96
194         6.7.10.  Remove an entry from the MIDI instrument map . . . .  91         6.7.10.  Remove an entry from the MIDI instrument map . . . .  96
195         6.7.11.  Get current settings of MIDI instrument map entry  .  92         6.7.11.  Get current settings of MIDI instrument map entry  .  97
196         6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  94         6.7.12.  Clear MIDI instrument map  . . . . . . . . . . . . .  99
197       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  94       6.8.  Managing Instruments Database . . . . . . . . . . . . . .  99
198         6.8.1.   Creating a new instrument directory  . . . . . . . .  95         6.8.1.   Creating a new instrument directory  . . . . . . . . 100
199         6.8.2.   Deleting an instrument directory . . . . . . . . . .  95         6.8.2.   Deleting an instrument directory . . . . . . . . . . 100
200         6.8.3.   Getting amount of instrument directories . . . . . .  96         6.8.3.   Getting amount of instrument directories . . . . . . 101
201         6.8.4.   Listing all directories in specific directory  . . .  96         6.8.4.   Listing all directories in specific directory  . . . 101
202         6.8.5.   Getting instrument directory information . . . . . .  97         6.8.5.   Getting instrument directory information . . . . . . 102
203         6.8.6.   Renaming an instrument directory . . . . . . . . . .  98         6.8.6.   Renaming an instrument directory . . . . . . . . . . 103
204         6.8.7.   Moving an instrument directory . . . . . . . . . . .  99         6.8.7.   Moving an instrument directory . . . . . . . . . . . 104
205         6.8.8.   Copying instrument directories . . . . . . . . . . .  99         6.8.8.   Copying instrument directories . . . . . . . . . . . 104
206         6.8.9.   Changing the description of directory  . . . . . . . 100         6.8.9.   Changing the description of directory  . . . . . . . 105
207         6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 101         6.8.10.  Finding directories  . . . . . . . . . . . . . . . . 106
208         6.8.11.  Adding instruments to the instruments database . . . 102         6.8.11.  Adding instruments to the instruments database . . . 107
209         6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 104         6.8.12.  Removing an instrument . . . . . . . . . . . . . . . 109
210         6.8.13.  Getting amount of instruments  . . . . . . . . . . . 104         6.8.13.  Getting amount of instruments  . . . . . . . . . . . 109
211         6.8.14.  Listing all instruments in specific directory  . . . 105         6.8.14.  Listing all instruments in specific directory  . . . 110
212         6.8.15.  Getting instrument information . . . . . . . . . . . 105         6.8.15.  Getting instrument information . . . . . . . . . . . 110
213         6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 108         6.8.16.  Renaming an instrument . . . . . . . . . . . . . . . 113
214         6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 108         6.8.17.  Moving an instrument . . . . . . . . . . . . . . . . 113
215         6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 109         6.8.18.  Copying instruments  . . . . . . . . . . . . . . . . 114
216         6.8.19.  Changing the description of instrument . . . . . . . 110         6.8.19.  Changing the description of instrument . . . . . . . 115
217         6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 110         6.8.20.  Finding instruments  . . . . . . . . . . . . . . . . 115
218         6.8.21.  Getting job status information . . . . . . . . . . . 113         6.8.21.  Getting job status information . . . . . . . . . . . 118
219         6.8.22.  Formatting the instruments database  . . . . . . . . 114         6.8.22.  Formatting the instruments database  . . . . . . . . 119
        6.8.23.  Checking for lost instrument files . . . . . . . . . 114  
        6.8.24.  Replacing an instrument file . . . . . . . . . . . . 115  
      6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 115  
220    
221    
222    
223  Schoenebeck             Expires December 26, 2011               [Page 4]  Schoenebeck               Expires July 13, 2014                 [Page 4]
224    
225  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
226    
227    
228           6.8.23.  Checking for lost instrument files . . . . . . . . . 119
229           6.8.24.  Replacing an instrument file . . . . . . . . . . . . 120
230         6.9.  Editing Instruments . . . . . . . . . . . . . . . . . . . 120
231         6.9.1.   Opening an appropriate instrument editor         6.9.1.   Opening an appropriate instrument editor
232                  application  . . . . . . . . . . . . . . . . . . . . 116                  application  . . . . . . . . . . . . . . . . . . . . 121
233       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 117       6.10. Managing Files  . . . . . . . . . . . . . . . . . . . . . 122
234         6.10.1.  Retrieving amount of instruments of a file . . . . . 117         6.10.1.  Retrieving amount of instruments of a file . . . . . 122
235         6.10.2.  Retrieving all instruments of a file . . . . . . . . 117         6.10.2.  Retrieving all instruments of a file . . . . . . . . 122
236         6.10.3.  Retrieving informations about one instrument in a         6.10.3.  Retrieving informations about one instrument in a
237                  file . . . . . . . . . . . . . . . . . . . . . . . . 118                  file . . . . . . . . . . . . . . . . . . . . . . . . 123
238       6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 120       6.11. Managing Effects  . . . . . . . . . . . . . . . . . . . . 125
239         6.11.1.  Retrieve amount of available effects . . . . . . . . 120         6.11.1.  Retrieve amount of available effects . . . . . . . . 125
240         6.11.2.  Get list of available effects  . . . . . . . . . . . 121         6.11.2.  Get list of available effects  . . . . . . . . . . . 126
241         6.11.3.  Retrieving general information about an effect . . . 121         6.11.3.  Retrieving general information about an effect . . . 126
242         6.11.4.  Creating an instance of an effect by its portable         6.11.4.  Creating an instance of an effect by its portable
243                  ID . . . . . . . . . . . . . . . . . . . . . . . . . 122                  ID . . . . . . . . . . . . . . . . . . . . . . . . . 127
244         6.11.5.  Creating an instance of an effect by its         6.11.5.  Creating an instance of an effect by its
245                  numerical ID . . . . . . . . . . . . . . . . . . . . 123                  numerical ID . . . . . . . . . . . . . . . . . . . . 128
246         6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 124         6.11.6.  Destroy an effect instance . . . . . . . . . . . . . 129
247         6.11.7.  Retrieve amount of effect instances  . . . . . . . . 125         6.11.7.  Retrieve amount of effect instances  . . . . . . . . 130
248         6.11.8.  Get list of effect instances . . . . . . . . . . . . 126         6.11.8.  Get list of effect instances . . . . . . . . . . . . 131
249         6.11.9.  Retrieving current information about an effect         6.11.9.  Retrieving current information about an effect
250                  instance . . . . . . . . . . . . . . . . . . . . . . 126                  instance . . . . . . . . . . . . . . . . . . . . . . 131
251         6.11.10. Retrieving information about an effect parameter . . 127         6.11.10. Retrieving information about an effect parameter . . 132
252         6.11.11. Altering an effect parameter . . . . . . . . . . . . 129         6.11.11. Altering an effect parameter . . . . . . . . . . . . 134
253         6.11.12. Retrieve amount of send effect chains  . . . . . . . 130         6.11.12. Retrieve amount of send effect chains  . . . . . . . 135
254         6.11.13. Retrieve list of send effect chains  . . . . . . . . 130         6.11.13. Retrieve list of send effect chains  . . . . . . . . 135
255         6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 131         6.11.14. Add send effect chain  . . . . . . . . . . . . . . . 136
256         6.11.15. Remove send effect chain . . . . . . . . . . . . . . 131         6.11.15. Remove send effect chain . . . . . . . . . . . . . . 136
257         6.11.16. Retrieving information about a send effect chain . . 132         6.11.16. Retrieving information about a send effect chain . . 137
258         6.11.17. Append effect instance to a send effect chain  . . . 133         6.11.17. Append effect instance to a send effect chain  . . . 138
259         6.11.18. Insert effect instance to a send effect chain  . . . 134         6.11.18. Insert effect instance to a send effect chain  . . . 139
260         6.11.19. Remove effect instance from send effect chain  . . . 134         6.11.19. Remove effect instance from send effect chain  . . . 139
261     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 136     7.  Command Syntax  . . . . . . . . . . . . . . . . . . . . . . . 141
262       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 152       7.1.  Character Set and Escape Sequences  . . . . . . . . . . . 158
263     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 157     8.  Events  . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
264       8.1.  Number of audio output devices changed  . . . . . . . . . 157       8.1.  Number of audio output devices changed  . . . . . . . . . 162
265       8.2.  Audio output device's settings changed  . . . . . . . . . 157       8.2.  Audio output device's settings changed  . . . . . . . . . 162
266       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 157       8.3.  Number of MIDI input devices changed  . . . . . . . . . . 162
267       8.4.  MIDI input device's settings changed  . . . . . . . . . . 158       8.4.  MIDI input device's settings changed  . . . . . . . . . . 163
268       8.5.  Number of sampler channels changed  . . . . . . . . . . . 158       8.5.  Number of sampler channels changed  . . . . . . . . . . . 163
269       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 158       8.6.  MIDI data on a sampler channel arrived  . . . . . . . . . 163
270       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 159       8.7.  MIDI data on a MIDI input device arrived  . . . . . . . . 164
271       8.8.  Number of active voices changed . . . . . . . . . . . . . 159       8.8.  Number of active voices changed . . . . . . . . . . . . . 164
272       8.9.  Number of active disk streams changed . . . . . . . . . . 160       8.9.  Number of active disk streams changed . . . . . . . . . . 165
273       8.10. Disk stream buffer fill state changed . . . . . . . . . . 160       8.10. Disk stream buffer fill state changed . . . . . . . . . . 165
274       8.11. Channel information changed . . . . . . . . . . . . . . . 160       8.11. Channel information changed . . . . . . . . . . . . . . . 165
275       8.12. Number of effect sends changed  . . . . . . . . . . . . . 161       8.12. Number of effect sends changed  . . . . . . . . . . . . . 166
      8.13. Effect send information changed . . . . . . . . . . . . . 161  
      8.14. Total number of active voices changed . . . . . . . . . . 162  
      8.15. Total number of active disk streams changed . . . . . . . 162  
276    
277    
278    
279  Schoenebeck             Expires December 26, 2011               [Page 5]  Schoenebeck               Expires July 13, 2014                 [Page 5]
280    
281  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
282    
283    
284       8.16. Number of MIDI instrument maps changed  . . . . . . . . . 162       8.13. Effect send information changed . . . . . . . . . . . . . 166
285       8.17. MIDI instrument map information changed . . . . . . . . . 162       8.14. Total number of active voices changed . . . . . . . . . . 167
286       8.18. Number of MIDI instruments changed  . . . . . . . . . . . 163       8.15. Total number of active disk streams changed . . . . . . . 167
287       8.19. MIDI instrument information changed . . . . . . . . . . . 163       8.16. Number of MIDI instrument maps changed  . . . . . . . . . 167
288       8.20. Global settings changed . . . . . . . . . . . . . . . . . 164       8.17. MIDI instrument map information changed . . . . . . . . . 167
289       8.21. Number of database instrument directories changed . . . . 164       8.18. Number of MIDI instruments changed  . . . . . . . . . . . 168
290       8.22. Database instrument directory information changed . . . . 164       8.19. MIDI instrument information changed . . . . . . . . . . . 168
291       8.23. Number of database instruments changed  . . . . . . . . . 165       8.20. Global settings changed . . . . . . . . . . . . . . . . . 169
292       8.24. Database instrument information changed . . . . . . . . . 165       8.21. Number of database instrument directories changed . . . . 169
293       8.25. Database job status information changed . . . . . . . . . 166       8.22. Database instrument directory information changed . . . . 169
294       8.26. Number of effect instances changed  . . . . . . . . . . . 166       8.23. Number of database instruments changed  . . . . . . . . . 170
295       8.27. Effect instance information changed . . . . . . . . . . . 167       8.24. Database instrument information changed . . . . . . . . . 170
296       8.28. Number of send effect chains changed  . . . . . . . . . . 167       8.25. Database job status information changed . . . . . . . . . 171
297       8.29. Send effect chain information changed . . . . . . . . . . 167       8.26. Number of effect instances changed  . . . . . . . . . . . 171
298       8.30. Miscellaneous and debugging events  . . . . . . . . . . . 168       8.27. Effect instance information changed . . . . . . . . . . . 172
299     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 169       8.28. Number of send effect chains changed  . . . . . . . . . . 172
300     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 170       8.29. Send effect chain information changed . . . . . . . . . . 172
301     11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 171       8.30. Miscellaneous and debugging events  . . . . . . . . . . . 173
302     Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 172     9.  Security Considerations . . . . . . . . . . . . . . . . . . . 174
303     Intellectual Property and Copyright Statements  . . . . . . . . . 173     10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 175
304       11. References  . . . . . . . . . . . . . . . . . . . . . . . . . 176
305       Author's Address  . . . . . . . . . . . . . . . . . . . . . . . . 177
306       Intellectual Property and Copyright Statements  . . . . . . . . . 178
307    
308    
309    
# Line 329  Internet-Draft        LinuxSampler Contr Line 332  Internet-Draft        LinuxSampler Contr
332    
333    
334    
335    Schoenebeck               Expires July 13, 2014                 [Page 6]
   
   
 Schoenebeck             Expires December 26, 2011               [Page 6]  
336    
337  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
338    
339    
340  1.  Requirements notation  1.  Requirements notation
# Line 388  Internet-Draft        LinuxSampler Contr Line 388  Internet-Draft        LinuxSampler Contr
388    
389    
390    
391  Schoenebeck             Expires December 26, 2011               [Page 7]  Schoenebeck               Expires July 13, 2014                 [Page 7]
392    
393  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
394    
395    
396  2.  Versioning of this specification  2.  Versioning of this specification
# Line 444  Internet-Draft        LinuxSampler Contr Line 444  Internet-Draft        LinuxSampler Contr
444    
445    
446    
447  Schoenebeck             Expires December 26, 2011               [Page 8]  Schoenebeck               Expires July 13, 2014                 [Page 8]
448    
449  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
450    
451    
452  3.  Introduction  3.  Introduction
# Line 500  Internet-Draft        LinuxSampler Contr Line 500  Internet-Draft        LinuxSampler Contr
500    
501    
502    
503  Schoenebeck             Expires December 26, 2011               [Page 9]  Schoenebeck               Expires July 13, 2014                 [Page 9]
504    
505  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
506    
507    
508  4.  Focus of this protocol  4.  Focus of this protocol
# Line 556  Internet-Draft        LinuxSampler Contr Line 556  Internet-Draft        LinuxSampler Contr
556    
557    
558    
559  Schoenebeck             Expires December 26, 2011              [Page 10]  Schoenebeck               Expires July 13, 2014                [Page 10]
560    
561  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
562    
563    
564  5.  Communication Overview  5.  Communication Overview
# Line 612  Internet-Draft        LinuxSampler Contr Line 612  Internet-Draft        LinuxSampler Contr
612    
613    
614    
615  Schoenebeck             Expires December 26, 2011              [Page 11]  Schoenebeck               Expires July 13, 2014                [Page 11]
616    
617  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
618    
619    
620  5.1.1.  Result format  5.1.1.  Result format
# Line 668  Internet-Draft        LinuxSampler Contr Line 668  Internet-Draft        LinuxSampler Contr
668    
669    
670    
671  Schoenebeck             Expires December 26, 2011              [Page 12]  Schoenebeck               Expires July 13, 2014                [Page 12]
672    
673  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
674    
675    
676     set has the following format:     set has the following format:
# Line 724  Internet-Draft        LinuxSampler Contr Line 724  Internet-Draft        LinuxSampler Contr
724    
725    
726    
727  Schoenebeck             Expires December 26, 2011              [Page 13]  Schoenebeck               Expires July 13, 2014                [Page 13]
728    
729  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
730    
731    
732     Each line of the result set MUST end with <CRLF>.     Each line of the result set MUST end with <CRLF>.
# Line 780  Internet-Draft        LinuxSampler Contr Line 780  Internet-Draft        LinuxSampler Contr
780    
781    
782    
783  Schoenebeck             Expires December 26, 2011              [Page 14]  Schoenebeck               Expires July 13, 2014                [Page 14]
784    
785  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
786    
787    
788         inserted in the middle of the event message as well as any other         inserted in the middle of the event message as well as any other
# Line 836  Internet-Draft        LinuxSampler Contr Line 836  Internet-Draft        LinuxSampler Contr
836    
837    
838    
839  Schoenebeck             Expires December 26, 2011              [Page 15]  Schoenebeck               Expires July 13, 2014                [Page 15]
840    
841  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
842    
843    
844  6.  Description for control commands  6.  Description for control commands
# Line 892  Internet-Draft        LinuxSampler Contr Line 892  Internet-Draft        LinuxSampler Contr
892    
893    
894    
895  Schoenebeck             Expires December 26, 2011              [Page 16]  Schoenebeck               Expires July 13, 2014                [Page 16]
896    
897  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
898    
899    
900  6.2.1.  Getting amount of available audio output drivers  6.2.1.  Getting amount of available audio output drivers
# Line 948  Internet-Draft        LinuxSampler Contr Line 948  Internet-Draft        LinuxSampler Contr
948    
949    
950    
951  Schoenebeck             Expires December 26, 2011              [Page 17]  Schoenebeck               Expires July 13, 2014                [Page 17]
952    
953  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
954    
955    
956        LinuxSampler will answer by sending a <CRLF> separated list.  Each        LinuxSampler will answer by sending a <CRLF> separated list.  Each
# Line 1004  Internet-Draft        LinuxSampler Contr Line 1004  Internet-Draft        LinuxSampler Contr
1004    
1005    
1006    
1007  Schoenebeck             Expires December 26, 2011              [Page 18]  Schoenebeck               Expires July 13, 2014                [Page 18]
1008    
1009  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1010    
1011    
1012     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"     obtained (as returned by the "GET AUDIO_OUTPUT_DRIVER INFO"
# Line 1060  Internet-Draft        LinuxSampler Contr Line 1060  Internet-Draft        LinuxSampler Contr
1060    
1061    
1062    
1063  Schoenebeck             Expires December 26, 2011              [Page 19]  Schoenebeck               Expires July 13, 2014                [Page 19]
1064    
1065  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1066    
1067    
1068        MULTIPLICITY -        MULTIPLICITY -
# Line 1116  Internet-Draft        LinuxSampler Contr Line 1116  Internet-Draft        LinuxSampler Contr
1116    
1117    
1118    
1119  Schoenebeck             Expires December 26, 2011              [Page 20]  Schoenebeck               Expires July 13, 2014                [Page 20]
1120    
1121  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1122    
1123    
1124           returned, dependent to driver parameter)           returned, dependent to driver parameter)
# Line 1172  Internet-Draft        LinuxSampler Contr Line 1172  Internet-Draft        LinuxSampler Contr
1172    
1173    
1174    
1175  Schoenebeck             Expires December 26, 2011              [Page 21]  Schoenebeck               Expires July 13, 2014                [Page 21]
1176    
1177  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1178    
1179    
1180           "TYPE: INT"           "TYPE: INT"
# Line 1228  Internet-Draft        LinuxSampler Contr Line 1228  Internet-Draft        LinuxSampler Contr
1228    
1229    
1230    
1231  Schoenebeck             Expires December 26, 2011              [Page 22]  Schoenebeck               Expires July 13, 2014                [Page 22]
1232    
1233  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1234    
1235    
1236           providing an appropriate warning code and warning message           providing an appropriate warning code and warning message
# Line 1284  Internet-Draft        LinuxSampler Contr Line 1284  Internet-Draft        LinuxSampler Contr
1284    
1285    
1286    
1287  Schoenebeck             Expires December 26, 2011              [Page 23]  Schoenebeck               Expires July 13, 2014                [Page 23]
1288    
1289  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1290    
1291    
1292        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"        C: "DESTROY AUDIO_OUTPUT_DEVICE 0"
# Line 1340  Internet-Draft        LinuxSampler Contr Line 1340  Internet-Draft        LinuxSampler Contr
1340    
1341    
1342    
1343  Schoenebeck             Expires December 26, 2011              [Page 24]  Schoenebeck               Expires July 13, 2014                [Page 24]
1344    
1345  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1346    
1347    
1348     Possible Answers:     Possible Answers:
# Line 1396  Internet-Draft        LinuxSampler Contr Line 1396  Internet-Draft        LinuxSampler Contr
1396    
1397    
1398    
1399  Schoenebeck             Expires December 26, 2011              [Page 25]  Schoenebeck               Expires July 13, 2014                [Page 25]
1400    
1401  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1402    
1403    
1404           "FRAGMENTS: 2"           "FRAGMENTS: 2"
# Line 1452  Internet-Draft        LinuxSampler Contr Line 1452  Internet-Draft        LinuxSampler Contr
1452    
1453    
1454    
1455  Schoenebeck             Expires December 26, 2011              [Page 26]  Schoenebeck               Expires July 13, 2014                [Page 26]
1456    
1457  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1458    
1459    
1460  6.2.11.  Getting information about an audio channel  6.2.11.  Getting information about an audio channel
# Line 1508  Internet-Draft        LinuxSampler Contr Line 1508  Internet-Draft        LinuxSampler Contr
1508    
1509    
1510    
1511  Schoenebeck             Expires December 26, 2011              [Page 27]  Schoenebeck               Expires July 13, 2014                [Page 27]
1512    
1513  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1514    
1515    
1516     Examples:     Examples:
# Line 1564  Internet-Draft        LinuxSampler Contr Line 1564  Internet-Draft        LinuxSampler Contr
1564    
1565    
1566    
1567  Schoenebeck             Expires December 26, 2011              [Page 28]  Schoenebeck               Expires July 13, 2014                [Page 28]
1568    
1569  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1570    
1571    
1572     channel number and <param> a specific channel parameter name for     channel number and <param> a specific channel parameter name for
# Line 1620  Internet-Draft        LinuxSampler Contr Line 1620  Internet-Draft        LinuxSampler Contr
1620    
1621    
1622    
1623  Schoenebeck             Expires December 26, 2011              [Page 29]  Schoenebeck               Expires July 13, 2014                [Page 29]
1624    
1625  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1626    
1627    
1628           RANGE_MAX -           RANGE_MAX -
# Line 1676  Internet-Draft        LinuxSampler Contr Line 1676  Internet-Draft        LinuxSampler Contr
1676    
1677    
1678    
1679  Schoenebeck             Expires December 26, 2011              [Page 30]  Schoenebeck               Expires July 13, 2014                [Page 30]
1680    
1681  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1682    
1683    
1684        "OK" -        "OK" -
# Line 1732  Internet-Draft        LinuxSampler Contr Line 1732  Internet-Draft        LinuxSampler Contr
1732    
1733    
1734    
1735  Schoenebeck             Expires December 26, 2011              [Page 31]  Schoenebeck               Expires July 13, 2014                [Page 31]
1736    
1737  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1738    
1739    
1740     Note: examples in this chapter showing particular parameters of     Note: examples in this chapter showing particular parameters of
# Line 1788  Internet-Draft        LinuxSampler Contr Line 1788  Internet-Draft        LinuxSampler Contr
1788    
1789    
1790    
1791  Schoenebeck             Expires December 26, 2011              [Page 32]  Schoenebeck               Expires July 13, 2014                [Page 32]
1792    
1793  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1794    
1795    
1796  6.3.3.  Getting information about a specific MIDI input driver  6.3.3.  Getting information about a specific MIDI input driver
# Line 1844  Internet-Draft        LinuxSampler Contr Line 1844  Internet-Draft        LinuxSampler Contr
1844    
1845    
1846    
1847  Schoenebeck             Expires December 26, 2011              [Page 33]  Schoenebeck               Expires July 13, 2014                [Page 33]
1848    
1849  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1850    
1851    
1852  6.3.4.  Getting information about specific MIDI input driver parameter  6.3.4.  Getting information about specific MIDI input driver parameter
# Line 1900  Internet-Draft        LinuxSampler Contr Line 1900  Internet-Draft        LinuxSampler Contr
1900    
1901    
1902    
1903  Schoenebeck             Expires December 26, 2011              [Page 34]  Schoenebeck               Expires July 13, 2014                [Page 34]
1904    
1905  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1906    
1907    
1908        FIX -        FIX -
# Line 1956  Internet-Draft        LinuxSampler Contr Line 1956  Internet-Draft        LinuxSampler Contr
1956    
1957    
1958    
1959  Schoenebeck             Expires December 26, 2011              [Page 35]  Schoenebeck               Expires July 13, 2014                [Page 35]
1960    
1961  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
1962    
1963    
1964           may also appear without (optionally returned, dependent to           may also appear without (optionally returned, dependent to
# Line 2012  Internet-Draft        LinuxSampler Contr Line 2012  Internet-Draft        LinuxSampler Contr
2012    
2013    
2014    
2015  Schoenebeck             Expires December 26, 2011              [Page 36]  Schoenebeck               Expires July 13, 2014                [Page 36]
2016    
2017  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2018    
2019    
2020        "OK[<device-id>]" -        "OK[<device-id>]" -
# Line 2068  Internet-Draft        LinuxSampler Contr Line 2068  Internet-Draft        LinuxSampler Contr
2068    
2069    
2070    
2071  Schoenebeck             Expires December 26, 2011              [Page 37]  Schoenebeck               Expires July 13, 2014                [Page 37]
2072    
2073  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2074    
2075    
2076           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 2124  Internet-Draft        LinuxSampler Contr Line 2124  Internet-Draft        LinuxSampler Contr
2124    
2125    
2126    
2127  Schoenebeck             Expires December 26, 2011              [Page 38]  Schoenebeck               Expires July 13, 2014                [Page 38]
2128    
2129  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2130    
2131    
2132  6.3.9.  Getting current settings of a MIDI input device  6.3.9.  Getting current settings of a MIDI input device
# Line 2180  Internet-Draft        LinuxSampler Contr Line 2180  Internet-Draft        LinuxSampler Contr
2180    
2181    
2182    
2183  Schoenebeck             Expires December 26, 2011              [Page 39]  Schoenebeck               Expires July 13, 2014                [Page 39]
2184    
2185  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2186    
2187    
2188           "ACTIVE: true"           "ACTIVE: true"
# Line 2236  Internet-Draft        LinuxSampler Contr Line 2236  Internet-Draft        LinuxSampler Contr
2236    
2237    
2238    
2239  Schoenebeck             Expires December 26, 2011              [Page 40]  Schoenebeck               Expires July 13, 2014                [Page 40]
2240    
2241  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2242    
2243    
2244     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI     MIDI_INPUT_DEVICES" (Section 6.3.8) command and <midi-port> the MIDI
# Line 2292  Internet-Draft        LinuxSampler Contr Line 2292  Internet-Draft        LinuxSampler Contr
2292    
2293    
2294    
2295  Schoenebeck             Expires December 26, 2011              [Page 41]  Schoenebeck               Expires July 13, 2014                [Page 41]
2296    
2297  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2298    
2299    
2300        character string to that info category.  There is information        character string to that info category.  There is information
# Line 2348  Internet-Draft        LinuxSampler Contr Line 2348  Internet-Draft        LinuxSampler Contr
2348    
2349    
2350    
2351  Schoenebeck             Expires December 26, 2011              [Page 42]  Schoenebeck               Expires July 13, 2014                [Page 42]
2352    
2353  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2354    
2355    
2356           returned, dependent to device and port parameter)           returned, dependent to device and port parameter)
# Line 2404  Internet-Draft        LinuxSampler Contr Line 2404  Internet-Draft        LinuxSampler Contr
2404    
2405    
2406    
2407  Schoenebeck             Expires December 26, 2011              [Page 43]  Schoenebeck               Expires July 13, 2014                [Page 43]
2408    
2409  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2410    
2411    
2412        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 2460  Internet-Draft        LinuxSampler Contr Line 2460  Internet-Draft        LinuxSampler Contr
2460    
2461    
2462    
2463  Schoenebeck             Expires December 26, 2011              [Page 44]  Schoenebeck               Expires July 13, 2014                [Page 44]
2464    
2465  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2466    
2467    
2468     format and SHOULD return ERR and SHOULD not launch the background     format and SHOULD return ERR and SHOULD not launch the background
# Line 2516  Internet-Draft        LinuxSampler Contr Line 2516  Internet-Draft        LinuxSampler Contr
2516    
2517    
2518    
2519  Schoenebeck             Expires December 26, 2011              [Page 45]  Schoenebeck               Expires July 13, 2014                [Page 45]
2520    
2521  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2522    
2523    
2524     sampler channel.  This command has (currently) no way to define or     sampler channel.  This command has (currently) no way to define or
# Line 2572  Internet-Draft        LinuxSampler Contr Line 2572  Internet-Draft        LinuxSampler Contr
2572    
2573    
2574    
2575  Schoenebeck             Expires December 26, 2011              [Page 46]  Schoenebeck               Expires July 13, 2014                [Page 46]
2576    
2577  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2578    
2579    
2580  6.4.4.  Getting all created sampler channel list  6.4.4.  Getting all created sampler channel list
# Line 2628  Internet-Draft        LinuxSampler Contr Line 2628  Internet-Draft        LinuxSampler Contr
2628    
2629    
2630    
2631  Schoenebeck             Expires December 26, 2011              [Page 47]  Schoenebeck               Expires July 13, 2014                [Page 47]
2632    
2633  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2634    
2635    
2636           in case a new channel was added successfully, but there are           in case a new channel was added successfully, but there are
# Line 2684  Internet-Draft        LinuxSampler Contr Line 2684  Internet-Draft        LinuxSampler Contr
2684    
2685    
2686    
2687  Schoenebeck             Expires December 26, 2011              [Page 48]  Schoenebeck               Expires July 13, 2014                [Page 48]
2688    
2689  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2690    
2691    
2692  6.4.7.  Getting amount of available engines  6.4.7.  Getting amount of available engines
# Line 2725  Internet-Draft        LinuxSampler Contr Line 2725  Internet-Draft        LinuxSampler Contr
2725    
2726        C: "LIST AVAILABLE_ENGINES"        C: "LIST AVAILABLE_ENGINES"
2727    
2728        S: "'GigEngine','AkaiEngine','DLSEngine','JoesCustomEngine'"        S: "'gig','sfz','sf2'"
2729    
2730  6.4.9.  Getting information about an engine  6.4.9.  Getting information about an engine
2731    
# Line 2740  Internet-Draft        LinuxSampler Contr Line 2740  Internet-Draft        LinuxSampler Contr
2740    
2741    
2742    
2743  Schoenebeck             Expires December 26, 2011              [Page 49]  Schoenebeck               Expires July 13, 2014                [Page 49]
2744    
2745  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
2746    
2747    
2748     Possible Answers:     Possible Answers:
# Line 2766  Internet-Draft        LinuxSampler Contr Line 2766  Internet-Draft        LinuxSampler Contr
2766    
2767     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
2768    
2769     Example:     Examples:
2770    
2771          C: "GET ENGINE INFO gig"
2772    
2773        C: "GET ENGINE INFO JoesCustomEngine"        S: "DESCRIPTION: GigaSampler Format Engine"
2774    
2775        S: "DESCRIPTION: this is Joe's custom sampler engine"           "VERSION: 1.110"
2776    
2777           "VERSION: testing-1.0"           "."
2778    
2779          C: "GET ENGINE INFO sf2"
2780    
2781          S: "DESCRIPTION: SoundFont Format Engine"
2782    
2783             "VERSION: 1.4"
2784    
2785           "."           "."
2786    
2787          C: "GET ENGINE INFO sfz"
2788    
2789          S: "DESCRIPTION: SFZ Format Engine"
2790    
2791             "VERSION: 1.11"
2792    
2793             "."
2794    
2795    
2796    
2797    
2798    
2799    Schoenebeck               Expires July 13, 2014                [Page 50]
2800    
2801    Internet-Draft        LinuxSampler Control Protocol         January 2014
2802    
2803    
2804  6.4.10.  Getting sampler channel information  6.4.10.  Getting sampler channel information
2805    
2806     The front-end can ask for the current settings of a sampler channel     The front-end can ask for the current settings of a sampler channel
# Line 2793  Internet-Draft        LinuxSampler Contr Line 2818  Internet-Draft        LinuxSampler Contr
2818        answer line begins with the settings category name followed by a        answer line begins with the settings category name followed by a
2819        colon and then a space character <SP> and finally the info        colon and then a space character <SP> and finally the info
2820        character string to that setting category.  At the moment the        character string to that setting category.  At the moment the
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 50]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
2821        following categories are defined:        following categories are defined:
2822    
2823    
# Line 2832  Internet-Draft        LinuxSampler Contr Line 2849  Internet-Draft        LinuxSampler Contr
2849              device and the engine's output channel 1 is routed to the              device and the engine's output channel 1 is routed to the
2850              channel 3 of the audio output device              channel 3 of the audio output device
2851    
2852    
2853    
2854    
2855    Schoenebeck               Expires July 13, 2014                [Page 51]
2856    
2857    Internet-Draft        LinuxSampler Control Protocol         January 2014
2858    
2859    
2860           INSTRUMENT_FILE -           INSTRUMENT_FILE -
2861    
2862              the file name of the loaded instrument, "NONE" if there's no              the file name of the loaded instrument, "NONE" if there's no
# Line 2850  Internet-Draft        LinuxSampler Contr Line 2875  Internet-Draft        LinuxSampler Contr
2875              LSCP 1.2 this character string may contain escape sequences              LSCP 1.2 this character string may contain escape sequences
2876              (Section 7.1))              (Section 7.1))
2877    
   
   
 Schoenebeck             Expires December 26, 2011              [Page 51]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
2878           INSTRUMENT_STATUS -           INSTRUMENT_STATUS -
2879    
2880              Integer values 0 to 100 indicating loading progress              Integer values 0 to 100 indicating loading progress
# Line 2888  Internet-Draft        LinuxSampler Contr Line 2906  Internet-Draft        LinuxSampler Contr
2906              (where a value < 1.0 means attenuation and a value > 1.0              (where a value < 1.0 means attenuation and a value > 1.0
2907              means amplification)              means amplification)
2908    
2909    
2910    
2911    Schoenebeck               Expires July 13, 2014                [Page 52]
2912    
2913    Internet-Draft        LinuxSampler Control Protocol         January 2014
2914    
2915    
2916           MUTE -           MUTE -
2917    
2918              Determines whether the channel is muted, "true" if the              Determines whether the channel is muted, "true" if the
# Line 2905  Internet-Draft        LinuxSampler Contr Line 2930  Internet-Draft        LinuxSampler Contr
2930    
2931              Determines to which MIDI instrument map this sampler channel              Determines to which MIDI instrument map this sampler channel
2932              is assigned to.  Read chapter "SET CHANNEL              is assigned to.  Read chapter "SET CHANNEL
2933                MIDI_INSTRUMENT_MAP" (Section 6.4.27) for a list of possible
   
   
 Schoenebeck             Expires December 26, 2011              [Page 52]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
             MIDI_INSTRUMENT_MAP" (Section 6.4.24) for a list of possible  
2934              values.              values.
2935    
2936     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 2922  Internet-Draft        LinuxSampler Contr Line 2939  Internet-Draft        LinuxSampler Contr
2939    
2940        C: "GET CHANNEL INFO 34"        C: "GET CHANNEL INFO 34"
2941    
2942        S: "ENGINE_NAME: GigEngine"        S: "ENGINE_NAME: gig"
2943    
2944           "VOLUME: 1.0"           "VOLUME: 1.0"
2945    
# Line 2944  Internet-Draft        LinuxSampler Contr Line 2961  Internet-Draft        LinuxSampler Contr
2961    
2962           "MIDI_INPUT_PORT: 0"           "MIDI_INPUT_PORT: 0"
2963    
2964    
2965    
2966    
2967    Schoenebeck               Expires July 13, 2014                [Page 53]
2968    
2969    Internet-Draft        LinuxSampler Control Protocol         January 2014
2970    
2971    
2972           "MIDI_INPUT_CHANNEL: 5"           "MIDI_INPUT_CHANNEL: 5"
2973    
2974           "VOLUME: 1.0"           "VOLUME: 1.0"
# Line 2961  Internet-Draft        LinuxSampler Contr Line 2986  Internet-Draft        LinuxSampler Contr
2986     The front-end can ask for the current number of active voices on a     The front-end can ask for the current number of active voices on a
2987     sampler channel by sending the following command:     sampler channel by sending the following command:
2988    
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 53]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
2989        GET CHANNEL VOICE_COUNT <sampler-channel>        GET CHANNEL VOICE_COUNT <sampler-channel>
2990    
2991     Where <sampler-channel> is the sampler channel number the front-end     Where <sampler-channel> is the sampler channel number the front-end
# Line 3000  Internet-Draft        LinuxSampler Contr Line 3017  Internet-Draft        LinuxSampler Contr
3017        LinuxSampler will answer by returning the number of active disk        LinuxSampler will answer by returning the number of active disk
3018        streams on that channel in case the engine supports disk        streams on that channel in case the engine supports disk
3019        streaming, if the engine doesn't support disk streaming it will        streaming, if the engine doesn't support disk streaming it will
3020    
3021    
3022    
3023    Schoenebeck               Expires July 13, 2014                [Page 54]
3024    
3025    Internet-Draft        LinuxSampler Control Protocol         January 2014
3026    
3027    
3028        return "NA" for not available.        return "NA" for not available.
3029    
3030     Example:     Example:
# Line 3015  Internet-Draft        LinuxSampler Contr Line 3040  Internet-Draft        LinuxSampler Contr
3040    
3041     to get the fill state in bytes or     to get the fill state in bytes or
3042    
   
   
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 54]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3043        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>        GET CHANNEL BUFFER_FILL PERCENTAGE <sampler-channel>
3044    
3045     to get the fill state in percent, where <sampler-channel> is the     to get the fill state in percent, where <sampler-channel> is the
# Line 3057  Internet-Draft        LinuxSampler Contr Line 3072  Internet-Draft        LinuxSampler Contr
3072    
3073        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"        C: "GET CHANNEL BUFFER_FILL PERCENTAGE 4"
3074    
3075    
3076    
3077    
3078    
3079    Schoenebeck               Expires July 13, 2014                [Page 55]
3080    
3081    Internet-Draft        LinuxSampler Control Protocol         January 2014
3082    
3083    
3084        S: ""        S: ""
3085    
3086  6.4.14.  Setting audio output device  6.4.14.  Setting audio output device
# Line 3074  Internet-Draft        LinuxSampler Contr Line 3098  Internet-Draft        LinuxSampler Contr
3098     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)     (Section 6.2.5) or "LIST AUDIO_OUTPUT_DEVICES" (Section 6.2.8)
3099     command.     command.
3100    
   
   
 Schoenebeck             Expires December 26, 2011              [Page 55]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3101     Possible Answers:     Possible Answers:
3102    
3103        "OK" -        "OK" -
# Line 3104  Internet-Draft        LinuxSampler Contr Line 3121  Internet-Draft        LinuxSampler Contr
3121    
3122  6.4.15.  Setting audio output type  6.4.15.  Setting audio output type
3123    
3124     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!     DEPRECATED: THIS COMMAND WILL DISAPPEAR!
3125    
3126     The front-end can alter the audio output type on a specific sampler     The front-end can alter the audio output type on a specific sampler
3127     channel by sending the following command:     channel by sending the following command:
# Line 3112  Internet-Draft        LinuxSampler Contr Line 3129  Internet-Draft        LinuxSampler Contr
3129        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-        SET CHANNEL AUDIO_OUTPUT_TYPE <sampler-channel> <audio-output-
3130        type>        type>
3131    
3132    
3133    
3134    
3135    Schoenebeck               Expires July 13, 2014                [Page 56]
3136    
3137    Internet-Draft        LinuxSampler Control Protocol         January 2014
3138    
3139    
3140     Where <audio-output-type> is currently either "ALSA" or "JACK" and     Where <audio-output-type> is currently either "ALSA" or "JACK" and
3141     <sampler-channel> is the respective sampler channel number.     <sampler-channel> is the respective sampler channel number.
3142    
# Line 3127  Internet-Draft        LinuxSampler Contr Line 3152  Internet-Draft        LinuxSampler Contr
3152           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3153           message           message
3154    
   
   
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 56]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3155        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3156    
3157           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3146  Internet-Draft        LinuxSampler Contr Line 3161  Internet-Draft        LinuxSampler Contr
3161    
3162    
3163    
3164       Deprecated:
3165    
3166          Should not be used anymore.  This command is currently only
3167          preserved for backward compatibility.
3168    
3169          This command is a relict from times where there was no
3170          sophisticated driver management yet.  Use "CREATE
3171          AUDIO_OUTPUT_DEVICE" (Section 6.2.5) and "SET CHANNEL
3172          AUDIO_OUTPUT_DEVICE" (Section 6.4.14) instead.
3173    
3174  6.4.16.  Setting audio output channel  6.4.16.  Setting audio output channel
3175    
3176     The front-end can alter the audio output channel on a specific     The front-end can alter the audio output channel on a specific
# Line 3161  Internet-Draft        LinuxSampler Contr Line 3186  Internet-Draft        LinuxSampler Contr
3186     numerical ID of the audio channel of the selected audio output device     numerical ID of the audio channel of the selected audio output device
3187     where <audio-out> should be routed to.     where <audio-out> should be routed to.
3188    
3189    
3190    
3191    Schoenebeck               Expires July 13, 2014                [Page 57]
3192    
3193    Internet-Draft        LinuxSampler Control Protocol         January 2014
3194    
3195    
3196     Possible Answers:     Possible Answers:
3197    
3198        "OK" -        "OK" -
# Line 3182  Internet-Draft        LinuxSampler Contr Line 3214  Internet-Draft        LinuxSampler Contr
3214    
3215    
3216    
3217    6.4.17.  Add MIDI input to sampler channel
3218    
3219       The front-end can add a MIDI input on a specific sampler channel by
3220       sending the following command:
3221    
3222          ADD CHANNEL MIDI_INPUT <sampler-channel> <midi-device-id> [<midi-
3223          input-port>]
3224    
3225       Where <sampler-channel> is the sampler channel number as returned by
3226       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3227       command and <midi-device-id> is the numerical ID of the MIDI input
3228       device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3229       or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command, and <midi-
3230       input-port> is an optional MIDI input port number of that MIDI input
3231       device.  If <midi-input-port> is omitted, then the MIDI input
3232       device's first port (port number 0) is used.
3233    
3234       Possible Answers:
3235    
3236          "OK" -
3237    
3238             on success
3239    
3240          "WRN:<warning-code>:<warning-message>" -
3241    
3242             if MIDI input port was connected, but there are noteworthy
3243             issue(s) related, providing an appropriate warning code and
3244    
3245    
3246    
3247    Schoenebeck               Expires July 13, 2014                [Page 58]
3248    
3249    Internet-Draft        LinuxSampler Control Protocol         January 2014
3250    
3251    
3252             warning message
3253    
3254          "ERR:<error-code>:<error-message>" -
3255    
3256             in case it failed, providing an appropriate error code and
3257             error message
3258    
3259       Examples:
3260    
3261          C: "ADD CHANNEL MIDI_INPUT 0 0"
3262    
3263          S: "OK"
3264    
3265          C: "ADD CHANNEL MIDI_INPUT 1 0"
3266    
3267          S: "OK"
3268    
3269          C: "ADD CHANNEL MIDI_INPUT 1 1 1"
3270    
3271          S: "OK"
3272    
3273          C: "ADD CHANNEL MIDI_INPUT 1 2 0"
3274    
3275          S: "OK"
3276    
3277       Since:
3278    
3279          Introduced with LSCP v1.6
3280    
3281    6.4.18.  Remove MIDI input(s) from sampler channel
3282    
3283       The front-end can remove one ore more MIDI input(s) on a specific
3284       sampler channel by sending the following command:
3285    
3286          REMOVE CHANNEL MIDI_INPUT <sampler-channel> [<midi-device-id>
3287          [<midi-input-port>]]
3288    
3289       Where <sampler-channel> is the sampler channel number as returned by
3290       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3291       command and <midi-device-id> and <midi-input-port> are optional
3292       numerical IDs defining the MIDI input device and one of its MIDI
3293       ports as returned by the "LIST CHANNEL MIDI_INPUTS" (Section 6.4.19)
3294       command.
3295    
3296       If <midi-input-port> is omitted, then all MIDI input ports of <midi-
3297       device-id> are disconnected from this sampler channel.
3298    
3299       If both, <midi-device-id> and <midi-input-port> are omitted, then all
3300    
3301    
3302    
3303    Schoenebeck               Expires July 13, 2014                [Page 59]
3304    
3305    Internet-Draft        LinuxSampler Control Protocol         January 2014
3306    
3307    
3308       MIDI input ports currently connected to this sampler channel are
3309       disconnected from this sampler channel.
3310    
3311       Possible Answers:
3312    
3313          "OK" -
3314    
3315             on success
3316    
3317          "WRN:<warning-code>:<warning-message>" -
3318    
3319             if MIDI input porst were disconnected, but there are noteworthy
3320             issue(s) related, providing an appropriate warning code and
3321             warning message
3322    
3323          "ERR:<error-code>:<error-message>" -
3324    
3325             in case it failed, providing an appropriate error code and
3326             error message
3327    
3328       Examples:
3329    
3330          C: "REMOVE CHANNEL MIDI_INPUT 0"
3331    
3332          S: "OK"
3333    
3334          C: "REMOVE CHANNEL MIDI_INPUT 1"
3335    
3336          S: "OK"
3337    
3338          C: "REMOVE CHANNEL MIDI_INPUT 1 2 0"
3339    
3340          S: "OK"
3341    
3342       Since:
3343    
3344          Introduced with LSCP v1.6
3345    
3346    6.4.19.  Getting all MIDI inputs of a sampler channel
3347    
3348       The front-end can query a list of all currently connected MIDI inputs
3349       of a certain sampler channel by sending the following command:
3350    
3351          LIST CHANNEL MIDI_INPUTS <sampler-channel>
3352    
3353  Schoenebeck             Expires December 26, 2011              [Page 57]     Where <sampler-channel> is the sampler channel number as returned by
3354       the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3355       command.
3356    
3357    
3358    
3359    Schoenebeck               Expires July 13, 2014                [Page 60]
3360    
3361  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
3362    
3363    
3364       Possible Answers:
3365    
3366          The sampler will answer by sending a comma separated list of MIDI
3367          input device ID - MIDI input port number pairs, where each pair is
3368          encapsulated into curly braces.  The list is returned in one
3369          single line.  The MIDI input device ID corresponds to the number
3370          returned by "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) and the port
3371          number is the index of the respective MIDI port of that MIDI input
3372          device.
3373    
3374       Example:
3375    
3376          C: "LIST CHANNEL MIDI_INPUTS 0"
3377    
3378          S: "{0,0},{1,3},{2,0}"
3379    
3380       Since:
3381    
3382  6.4.17.  Setting MIDI input device        Introduced with LSCP v1.6
3383    
3384    6.4.20.  Setting MIDI input device
3385    
3386       DEPRECATED: THIS COMMAND WILL DISAPPEAR!
3387    
3388     The front-end can set the MIDI input device on a specific sampler     The front-end can set the MIDI input device on a specific sampler
3389     channel by sending the following command:     channel by sending the following command:
# Line 3206  Internet-Draft        LinuxSampler Contr Line 3396  Internet-Draft        LinuxSampler Contr
3396     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)     device as returned by the "CREATE MIDI_INPUT_DEVICE" (Section 6.3.5)
3397     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.     or "LIST MIDI_INPUT_DEVICES" (Section 6.3.8) command.
3398    
3399       If more than 1 MIDI inputs are currently connected to this sampler
3400       channel: Sending this command will disconnect ALL currently connected
3401       MIDI input ports connected to this sampler channel before
3402       establishing the new MIDI input connection.  So this command does NOT
3403       add the connection, it replaces all existing ones instead.  This
3404       behavior is due to preserving full behavior backward compatibility.
3405    
3406     Possible Answers:     Possible Answers:
3407    
3408        "OK" -        "OK" -
3409    
3410           on success           on success
3411    
3412    
3413    
3414    
3415    Schoenebeck               Expires July 13, 2014                [Page 61]
3416    
3417    Internet-Draft        LinuxSampler Control Protocol         January 2014
3418    
3419    
3420        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
3421    
3422           if MIDI input device was set, but there are noteworthy issue(s)           if MIDI input device was set, but there are noteworthy issue(s)
# Line 3227  Internet-Draft        LinuxSampler Contr Line 3432  Internet-Draft        LinuxSampler Contr
3432    
3433    
3434    
3435  6.4.18.  Setting MIDI input type     Deprecated:
3436    
3437          Should not be used anymore as of LSCP v1.6 and younger.  This
3438          command is currently only preserved for backward compatibility.
3439    
3440     DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!        This command is a relict from times where only one MIDI input per
3441          sampler channel was allowed.  Use "ADD CHANNEL MIDI_INPUT"
3442          (Section 6.4.17) and "REMOVE CHANNEL MIDI_INPUT" (Section 6.4.18)
3443          instead.
3444    
3445    6.4.21.  Setting MIDI input type
3446    
3447       DEPRECATED: THIS COMMAND WILL DISAPPEAR!
3448    
3449     The front-end can alter the MIDI input type on a specific sampler     The front-end can alter the MIDI input type on a specific sampler
3450     channel by sending the following command:     channel by sending the following command:
# Line 3239  Internet-Draft        LinuxSampler Contr Line 3454  Internet-Draft        LinuxSampler Contr
3454     Where <midi-input-type> is currently only "ALSA" and <sampler-     Where <midi-input-type> is currently only "ALSA" and <sampler-
3455     channel> is the respective sampler channel number.     channel> is the respective sampler channel number.
3456    
3457       If more than 1 MIDI inputs are currently connected to this sampler
3458       channel: Sending this command will disconnect ALL currently connected
3459       MIDI input ports connected to this sampler channel before
3460       establishing the new MIDI input connection.  So this command does NOT
3461       add the connection, it replaces all existing ones instead.  This
3462       behavior is due to preserving full behavior backward compatibility.
3463    
3464     Possible Answers:     Possible Answers:
3465    
3466    
3467    
3468    
3469  Schoenebeck             Expires December 26, 2011              [Page 58]  
3470    
3471    Schoenebeck               Expires July 13, 2014                [Page 62]
3472    
3473  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
3474    
3475    
3476        "OK" -        "OK" -
# Line 3268  Internet-Draft        LinuxSampler Contr Line 3492  Internet-Draft        LinuxSampler Contr
3492    
3493    
3494    
3495  6.4.19.  Setting MIDI input port     Deprecated:
3496    
3497          Should not be used anymore.  This command is currently only
3498          preserved for backward compatibility.
3499    
3500          This command is a relict from times where only 1 MIDI input per
3501          sampler channels was allowed and where no sophisticated driver
3502          management existed yet.  Use "ADD CHANNEL MIDI_INPUT"
3503          (Section 6.4.17) and "REMOVE CHANNEL MIDI_INPUT" (Section 6.4.18)
3504          instead.
3505    
3506    6.4.22.  Setting MIDI input port
3507    
3508       DEPRECATED: THIS COMMAND WILL DISAPPEAR!
3509    
3510     The front-end can alter the MIDI input port on a specific sampler     The front-end can alter the MIDI input port on a specific sampler
3511     channel by sending the following command:     channel by sending the following command:
# Line 3278  Internet-Draft        LinuxSampler Contr Line 3515  Internet-Draft        LinuxSampler Contr
3515     Where <midi-input-port> is a MIDI input port number of the MIDI input     Where <midi-input-port> is a MIDI input port number of the MIDI input
3516     device connected to the sampler channel given by <sampler-channel>.     device connected to the sampler channel given by <sampler-channel>.
3517    
3518       If more than 1 MIDI inputs are currently connected to this sampler
3519       channel: Sending this command will switch the connection of the first
3520       (and only the first) MIDI input port currently being connected to
3521       this sampler channel, to another port of the same MIDI input device.
3522       Or in other words: the first MIDI input port currently connected to
3523       this sampler channel will be disconnected, and the requested other
3524    
3525    
3526    
3527    Schoenebeck               Expires July 13, 2014                [Page 63]
3528    
3529    Internet-Draft        LinuxSampler Control Protocol         January 2014
3530    
3531    
3532       port of its MIDI input device will be connected to this sampler
3533       channel instead.  This behavior is due to preserving full behavior
3534       backward compatibility.
3535    
3536     Possible Answers:     Possible Answers:
3537    
3538        "OK" -        "OK" -
# Line 3299  Internet-Draft        LinuxSampler Contr Line 3554  Internet-Draft        LinuxSampler Contr
3554    
3555    
3556    
3557       Deprecated:
3558    
3559  Schoenebeck             Expires December 26, 2011              [Page 59]        Should not be used anymore.  This command is currently only
3560          preserved for backward compatibility.
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3561    
3562          This command is a relict from times where only one MIDI input per
3563          sampler channel was allowed.  Use "ADD CHANNEL MIDI_INPUT"
3564          (Section 6.4.17) and "REMOVE CHANNEL MIDI_INPUT" (Section 6.4.18)
3565          instead.
3566    
3567  6.4.20.  Setting MIDI input channel  6.4.23.  Setting MIDI input channel
3568    
3569     The front-end can alter the MIDI channel a sampler channel should     The front-end can alter the MIDI channel a sampler channel should
3570     listen to by sending the following command:     listen to by sending the following command:
# Line 3315  Internet-Draft        LinuxSampler Contr Line 3572  Internet-Draft        LinuxSampler Contr
3572        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>        SET CHANNEL MIDI_INPUT_CHANNEL <sampler-channel> <midi-input-chan>
3573    
3574     Where <midi-input-chan> is the number of the new MIDI input channel     Where <midi-input-chan> is the number of the new MIDI input channel
3575     where <sampler-channel> should listen to or "ALL" to listen on all 16     (zero indexed!) where <sampler-channel> should listen to, or "ALL" to
3576     MIDI channels.     listen on all 16 MIDI channels.
3577    
3578     Possible Answers:     Possible Answers:
3579    
3580    
3581    
3582    
3583    Schoenebeck               Expires July 13, 2014                [Page 64]
3584    
3585    Internet-Draft        LinuxSampler Control Protocol         January 2014
3586    
3587    
3588        "OK" -        "OK" -
3589    
3590           on success           on success
# Line 3337  Internet-Draft        LinuxSampler Contr Line 3602  Internet-Draft        LinuxSampler Contr
3602    
3603     Examples:     Examples:
3604    
3605          C: "SET CHANNEL MIDI_INPUT_CHANNEL 0 0"
3606    
3607          S: "OK"
3608    
3609          C: "SET CHANNEL MIDI_INPUT_CHANNEL 1 ALL"
3610    
3611  6.4.21.  Setting channel volume        S: "OK"
3612    
3613    6.4.24.  Setting channel volume
3614    
3615     The front-end can alter the volume of a sampler channel by sending     The front-end can alter the volume of a sampler channel by sending
3616     the following command:     the following command:
# Line 3353  Internet-Draft        LinuxSampler Contr Line 3624  Internet-Draft        LinuxSampler Contr
3624    
3625     Possible Answers:     Possible Answers:
3626    
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 60]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3627        "OK" -        "OK" -
3628    
3629           on success           on success
# Line 3371  Internet-Draft        LinuxSampler Contr Line 3634  Internet-Draft        LinuxSampler Contr
3634           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
3635           message           message
3636    
3637    
3638    
3639    Schoenebeck               Expires July 13, 2014                [Page 65]
3640    
3641    Internet-Draft        LinuxSampler Control Protocol         January 2014
3642    
3643    
3644        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
3645    
3646           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3380  Internet-Draft        LinuxSampler Contr Line 3650  Internet-Draft        LinuxSampler Contr
3650    
3651    
3652    
3653  6.4.22.  Muting a sampler channel  6.4.25.  Muting a sampler channel
3654    
3655     The front-end can mute/unmute a specific sampler channel by sending     The front-end can mute/unmute a specific sampler channel by sending
3656     the following command:     the following command:
# Line 3409  Internet-Draft        LinuxSampler Contr Line 3679  Internet-Draft        LinuxSampler Contr
3679           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
3680           error message           error message
3681    
3682       Examples:
3683    
3684    
3685    
3686  Schoenebeck             Expires December 26, 2011              [Page 61]  6.4.26.  Soloing a sampler channel
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
3687    
3688       The front-end can solo/unsolo a specific sampler channel by sending
3689       the following command:
3690    
    Examples:  
3691    
3692    
3693    
 6.4.23.  Soloing a sampler channel  
3694    
3695     The front-end can solo/unsolo a specific sampler channel by sending  Schoenebeck               Expires July 13, 2014                [Page 66]
3696     the following command:  
3697    Internet-Draft        LinuxSampler Control Protocol         January 2014
3698    
3699    
3700        SET CHANNEL SOLO <sampler-channel> <solo>        SET CHANNEL SOLO <sampler-channel> <solo>
3701    
# Line 3454  Internet-Draft        LinuxSampler Contr Line 3725  Internet-Draft        LinuxSampler Contr
3725    
3726    
3727    
3728  6.4.24.  Assigning a MIDI instrument map to a sampler channel  6.4.27.  Assigning a MIDI instrument map to a sampler channel
3729    
3730     The front-end can assign a MIDI instrument map to a specific sampler     The front-end can assign a MIDI instrument map to a specific sampler
3731     channel by sending the following command:     channel by sending the following command:
# Line 3466  Internet-Draft        LinuxSampler Contr Line 3737  Internet-Draft        LinuxSampler Contr
3737     (Section 6.4.4) command and <map> can have the following     (Section 6.4.4) command and <map> can have the following
3738     possibilites:     possibilites:
3739    
   
   
 Schoenebeck             Expires December 26, 2011              [Page 62]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3740        "NONE" -        "NONE" -
3741    
3742           This is the default setting.  In this case the sampler channel           This is the default setting.  In this case the sampler channel
3743           is not assigned any MIDI instrument map and thus will ignore           is not assigned any MIDI instrument map and thus will ignore
3744           all MIDI program change messages.           all MIDI program change messages.
3745    
3746    
3747    
3748    
3749    
3750    
3751    Schoenebeck               Expires July 13, 2014                [Page 67]
3752    
3753    Internet-Draft        LinuxSampler Control Protocol         January 2014
3754    
3755    
3756        "DEFAULT" -        "DEFAULT" -
3757    
3758           The sampler channel will always use the default MIDI instrument           The sampler channel will always use the default MIDI instrument
# Line 3510  Internet-Draft        LinuxSampler Contr Line 3784  Internet-Draft        LinuxSampler Contr
3784    
3785    
3786    
3787  6.4.25.  Adding an effect send to a sampler channel  6.4.28.  Adding an effect send to a sampler channel
3788    
3789     The front-end can create an additional effect send on a specific     The front-end can create an additional effect send on a specific
3790     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 3521  Internet-Draft        LinuxSampler Contr Line 3795  Internet-Draft        LinuxSampler Contr
3795     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"     returned by the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS"
3796     (Section 6.4.4) command, that is the sampler channel on which the     (Section 6.4.4) command, that is the sampler channel on which the
3797     effect send should be created on, <midi-ctrl> is a number between     effect send should be created on, <midi-ctrl> is a number between
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 63]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3798     0..127 defining the MIDI controller which can alter the effect send     0..127 defining the MIDI controller which can alter the effect send
3799     level and <name> is an optional argument defining a name for the     level and <name> is an optional argument defining a name for the
3800     effect send entity.  The name does not have to be unique, but MUST be     effect send entity.  The name does not have to be unique, but MUST be
# Line 3536  Internet-Draft        LinuxSampler Contr Line 3802  Internet-Draft        LinuxSampler Contr
3802     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
3803     (Section 7.1)".     (Section 7.1)".
3804    
3805    
3806    
3807    Schoenebeck               Expires July 13, 2014                [Page 68]
3808    
3809    Internet-Draft        LinuxSampler Control Protocol         January 2014
3810    
3811    
3812     By default, that is as initial routing, the effect send's audio     By default, that is as initial routing, the effect send's audio
3813     channels are automatically routed to the last audio channels of the     channels are automatically routed to the last audio channels of the
3814     sampler channel's audio output device, that way you can i.e. first     sampler channel's audio output device, that way you can i.e. first
# Line 3543  Internet-Draft        LinuxSampler Contr Line 3816  Internet-Draft        LinuxSampler Contr
3816     having dedicated effect send output channels and when "CREATE     having dedicated effect send output channels and when "CREATE
3817     FX_SEND" is called, those channels will automatically be picked.  You     FX_SEND" is called, those channels will automatically be picked.  You
3818     can alter the destination channels however with "SET FX_SEND     can alter the destination channels however with "SET FX_SEND
3819     AUDIO_OUTPUT_CHANNEL" (Section 6.4.31).     AUDIO_OUTPUT_CHANNEL" (Section 6.4.34).
3820    
3821     Note: Create effect sends on a sampler channel only when needed,     Note: Create effect sends on a sampler channel only when needed,
3822     because having effect sends on a sampler channel will decrease     because having effect sends on a sampler channel will decrease
# Line 3576  Internet-Draft        LinuxSampler Contr Line 3849  Internet-Draft        LinuxSampler Contr
3849    
3850        C: "CREATE FX_SEND 0 93"        C: "CREATE FX_SEND 0 93"
3851    
3852          S: "OK[1]"
3853    
3854    6.4.29.  Removing an effect send from a sampler channel
3855    
3856       The front-end can remove an existing effect send on a specific
3857       sampler channel by sending the following command:
3858    
3859    
 Schoenebeck             Expires December 26, 2011              [Page 64]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
3860    
3861    
       S: "OK[1]"  
3862    
3863  6.4.26.  Removing an effect send from a sampler channel  Schoenebeck               Expires July 13, 2014                [Page 69]
3864    
3865    Internet-Draft        LinuxSampler Control Protocol         January 2014
3866    
    The front-end can remove an existing effect send on a specific  
    sampler channel by sending the following command:  
3867    
3868        DESTROY FX_SEND <sampler-channel> <fx-send-id>        DESTROY FX_SEND <sampler-channel> <fx-send-id>
3869    
# Line 3599  Internet-Draft        LinuxSampler Contr Line 3872  Internet-Draft        LinuxSampler Contr
3872     (Section 6.4.4) command, that is the sampler channel from which the     (Section 6.4.4) command, that is the sampler channel from which the
3873     effect send should be removed from and <fx-send-id> is the respective     effect send should be removed from and <fx-send-id> is the respective
3874     effect send number as returned by the "CREATE FX_SEND"     effect send number as returned by the "CREATE FX_SEND"
3875     (Section 6.4.25) or "LIST FX_SENDS" (Section 6.4.28) command.     (Section 6.4.28) or "LIST FX_SENDS" (Section 6.4.31) command.
3876    
3877     Possible Answers:     Possible Answers:
3878    
# Line 3618  Internet-Draft        LinuxSampler Contr Line 3891  Internet-Draft        LinuxSampler Contr
3891    
3892        S: "OK"        S: "OK"
3893    
3894  6.4.27.  Getting amount of effect sends on a sampler channel  6.4.30.  Getting amount of effect sends on a sampler channel
3895    
3896     The front-end can ask for the amount of effect sends on a specific     The front-end can ask for the amount of effect sends on a specific
3897     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 3631  Internet-Draft        LinuxSampler Contr Line 3904  Internet-Draft        LinuxSampler Contr
3904    
3905     Possible Answers:     Possible Answers:
3906    
   
   
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 65]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
3907        The sampler will answer by returning the number of effect sends on        The sampler will answer by returning the number of effect sends on
3908        the given sampler channel.        the given sampler channel.
3909    
# Line 3650  Internet-Draft        LinuxSampler Contr Line 3913  Internet-Draft        LinuxSampler Contr
3913    
3914        S: "2"        S: "2"
3915    
3916  6.4.28.  Listing all effect sends on a sampler channel  
3917    
3918    
3919    Schoenebeck               Expires July 13, 2014                [Page 70]
3920    
3921    Internet-Draft        LinuxSampler Control Protocol         January 2014
3922    
3923    
3924    6.4.31.  Listing all effect sends on a sampler channel
3925    
3926     The front-end can ask for a list of effect sends on a specific     The front-end can ask for a list of effect sends on a specific
3927     sampler channel by sending the following command:     sampler channel by sending the following command:
# Line 3676  Internet-Draft        LinuxSampler Contr Line 3947  Internet-Draft        LinuxSampler Contr
3947    
3948        S: ""        S: ""
3949    
3950  6.4.29.  Getting effect send information  6.4.32.  Getting effect send information
3951    
3952     The front-end can ask for the current settings of an effect send     The front-end can ask for the current settings of an effect send
3953     entity by sending the following command:     entity by sending the following command:
# Line 3686  Internet-Draft        LinuxSampler Contr Line 3957  Internet-Draft        LinuxSampler Contr
3957     Where <sampler-channel> is the sampler channel number as returned by     Where <sampler-channel> is the sampler channel number as returned by
3958     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     the "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
3959     command and <fx-send-id> reflects the numerical ID of the effect send     command and <fx-send-id> reflects the numerical ID of the effect send
3960     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
3961     FX_SENDS" (Section 6.4.28) command.     FX_SENDS" (Section 6.4.31) command.
   
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 66]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
3962    
3963     Possible Answers:     Possible Answers:
3964    
# Line 3707  Internet-Draft        LinuxSampler Contr Line 3970  Internet-Draft        LinuxSampler Contr
3970    
3971    
3972    
3973    
3974    
3975    Schoenebeck               Expires July 13, 2014                [Page 71]
3976    
3977    Internet-Draft        LinuxSampler Control Protocol         January 2014
3978    
3979    
3980    
3981    
3982           NAME -           NAME -
3983    
3984              name of the effect send entity (note that this character              name of the effect send entity (note that this character
# Line 3731  Internet-Draft        LinuxSampler Contr Line 4003  Internet-Draft        LinuxSampler Contr
4003              send's output channel 0 is routed to channel 0 of the audio              send's output channel 0 is routed to channel 0 of the audio
4004              output device and the effect send's output channel 1 is              output device and the effect send's output channel 1 is
4005              routed to the channel 3 of the audio output device (see "SET              routed to the channel 3 of the audio output device (see "SET
4006              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.31) for details),              FX_SEND AUDIO_OUTPUT_CHANNEL" (Section 6.4.34) for details),
4007              if an internal send effect is assigned to the effect send,              if an internal send effect is assigned to the effect send,
4008              then this setting defines the audio channel routing to that              then this setting defines the audio channel routing to that
4009              effect instance respectively              effect instance respectively
# Line 3745  Internet-Draft        LinuxSampler Contr Line 4017  Internet-Draft        LinuxSampler Contr
4017    
4018     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4019    
4020       Example:
4021    
4022          C: "GET FX_SEND INFO 0 0"
4023    
4024          S: "NAME: Reverb Send"
4025    
4026  Schoenebeck             Expires December 26, 2011              [Page 67]           "MIDI_CONTROLLER: 91"
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
4027    
4028    
    Example:  
4029    
       C: "GET FX_SEND INFO 0 0"  
4030    
4031        S: "NAME: Reverb Send"  Schoenebeck               Expires July 13, 2014                [Page 72]
4032    
4033    Internet-Draft        LinuxSampler Control Protocol         January 2014
4034    
          "MIDI_CONTROLLER: 91"  
4035    
4036           "LEVEL: 0.3"           "LEVEL: 0.3"
4037    
# Line 3783  Internet-Draft        LinuxSampler Contr Line 4055  Internet-Draft        LinuxSampler Contr
4055    
4056           "."           "."
4057    
4058  6.4.30.  Changing effect send's name  6.4.33.  Changing effect send's name
4059    
4060     The front-end can alter the current name of an effect send entity by     The front-end can alter the current name of an effect send entity by
4061     sending the following command:     sending the following command:
# Line 3793  Internet-Draft        LinuxSampler Contr Line 4065  Internet-Draft        LinuxSampler Contr
4065     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4066     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4067     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4068     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4069     FX_SENDS" (Section 6.4.28) command and <name> is the new name of the     FX_SENDS" (Section 6.4.31) command and <name> is the new name of the
4070     effect send entity, which does not have to be unique (name MUST be     effect send entity, which does not have to be unique (name MUST be
4071     encapsulated into apostrophes and supports escape sequences as     encapsulated into apostrophes and supports escape sequences as
4072     described in chapter "Character Set and Escape Sequences     described in chapter "Character Set and Escape Sequences
# Line 3802  Internet-Draft        LinuxSampler Contr Line 4074  Internet-Draft        LinuxSampler Contr
4074    
4075     Possible Answers:     Possible Answers:
4076    
4077          "OK" -
4078    
4079             on success
4080    
4081  Schoenebeck             Expires December 26, 2011              [Page 68]        "ERR:<error-code>:<error-message>" -
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
4082    
4083    
       "OK" -  
4084    
          on success  
4085    
4086        "ERR:<error-code>:<error-message>" -  
4087    Schoenebeck               Expires July 13, 2014                [Page 73]
4088    
4089    Internet-Draft        LinuxSampler Control Protocol         January 2014
4090    
4091    
4092           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
4093           error message           error message
# Line 3824  Internet-Draft        LinuxSampler Contr Line 4098  Internet-Draft        LinuxSampler Contr
4098    
4099        S: "OK"        S: "OK"
4100    
4101  6.4.31.  Altering effect send's audio routing  6.4.34.  Altering effect send's audio routing
4102    
4103     The front-end can alter the destination of an effect send's audio     The front-end can alter the destination of an effect send's audio
4104     channel on a specific sampler channel by sending the following     channel on a specific sampler channel by sending the following
# Line 3836  Internet-Draft        LinuxSampler Contr Line 4110  Internet-Draft        LinuxSampler Contr
4110     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4111     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4112     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4113     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4114     FX_SENDS" (Section 6.4.28) command, <audio-src> is the numerical ID     FX_SENDS" (Section 6.4.31) command, <audio-src> is the numerical ID
4115     of the effect send's audio channel which should be rerouted and     of the effect send's audio channel which should be rerouted and
4116     <audio-dst> is the numerical ID of the audio channel of the selected     <audio-dst> is the numerical ID of the audio channel of the selected
4117     audio output device where <audio-src> should be routed to.  If an     audio output device where <audio-src> should be routed to.  If an
# Line 3857  Internet-Draft        LinuxSampler Contr Line 4131  Internet-Draft        LinuxSampler Contr
4131     send into a mono one by simply altering its audio routing     send into a mono one by simply altering its audio routing
4132     appropriately.     appropriately.
4133    
4134       Possible Answers:
4135    
4136          "OK" -
4137    
4138             on success
4139    
 Schoenebeck             Expires December 26, 2011              [Page 69]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
4140    
4141    
    Possible Answers:  
4142    
4143        "OK" -  Schoenebeck               Expires July 13, 2014                [Page 74]
4144    
4145    Internet-Draft        LinuxSampler Control Protocol         January 2014
4146    
          on success  
4147    
4148        "WRN:<warning-code>:<warning-message>" -        "WRN:<warning-code>:<warning-message>" -
4149    
# Line 3888  Internet-Draft        LinuxSampler Contr Line 4162  Internet-Draft        LinuxSampler Contr
4162    
4163        S: "OK"        S: "OK"
4164    
4165  6.4.32.  Assigning destination effect to an effect send  6.4.35.  Assigning destination effect to an effect send
4166    
4167     The front-end can (re-)assign a destination effect to an effect send     The front-end can (re-)assign a destination effect to an effect send
4168     by sending the following command:     by sending the following command:
# Line 3899  Internet-Draft        LinuxSampler Contr Line 4173  Internet-Draft        LinuxSampler Contr
4173     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4174     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4175     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4176     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4177     FX_SENDS" (Section 6.4.28) command, <effect-chain> by the numerical     FX_SENDS" (Section 6.4.31) command, <effect-chain> by the numerical
4178     ID of the destination effect chain as returned by the "ADD     ID of the destination effect chain as returned by the "ADD
4179     SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"     SEND_EFFECT_CHAIN" (Section 6.11.14) or "LIST SEND_EFFECT_CHAINS"
4180     (Section 6.11.13) command and <chain-pos> reflects the exact effect     (Section 6.11.13) command and <chain-pos> reflects the exact effect
# Line 3913  Internet-Draft        LinuxSampler Contr Line 4187  Internet-Draft        LinuxSampler Contr
4187    
4188           on success           on success
4189    
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 70]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
4190        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
4191    
4192           in case it failed, providing an appropriate error code and           in case it failed, providing an appropriate error code and
# Line 3928  Internet-Draft        LinuxSampler Contr Line 4194  Internet-Draft        LinuxSampler Contr
4194    
4195     Example:     Example:
4196    
4197    
4198    
4199    Schoenebeck               Expires July 13, 2014                [Page 75]
4200    
4201    Internet-Draft        LinuxSampler Control Protocol         January 2014
4202    
4203    
4204        C: "SET FX_SEND EFFECT 0 0 2 5"        C: "SET FX_SEND EFFECT 0 0 2 5"
4205    
4206        S: "OK"        S: "OK"
4207    
4208  6.4.33.  Removing destination effect from an effect send  6.4.36.  Removing destination effect from an effect send
4209    
4210     The front-end can (re-)assign a destination effect to an effect send     The front-end can (re-)assign a destination effect to an effect send
4211     by sending the following command:     by sending the following command:
# Line 3942  Internet-Draft        LinuxSampler Contr Line 4215  Internet-Draft        LinuxSampler Contr
4215     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4216     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4217     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4218     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4219     FX_SENDS" (Section 6.4.28) command.     FX_SENDS" (Section 6.4.31) command.
4220    
4221     After the destination effect has been removed from the effect send,     After the destination effect has been removed from the effect send,
4222     the audio signal of the effect send will be routed directly to the     the audio signal of the effect send will be routed directly to the
# Line 3967  Internet-Draft        LinuxSampler Contr Line 4240  Internet-Draft        LinuxSampler Contr
4240    
4241        S: "OK"        S: "OK"
4242    
4243    6.4.37.  Altering effect send's MIDI controller
   
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 71]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
 6.4.34.  Altering effect send's MIDI controller  
4244    
4245     The front-end can alter the MIDI controller of an effect send entity     The front-end can alter the MIDI controller of an effect send entity
4246     by sending the following command:     by sending the following command:
# Line 3986  Internet-Draft        LinuxSampler Contr Line 4249  Internet-Draft        LinuxSampler Contr
4249        ctrl>        ctrl>
4250    
4251     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4252    
4253    
4254    
4255    Schoenebeck               Expires July 13, 2014                [Page 76]
4256    
4257    Internet-Draft        LinuxSampler Control Protocol         January 2014
4258    
4259    
4260     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
4261     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4262     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4263     FX_SENDS" (Section 6.4.28) command and <midi-ctrl> reflects the MIDI     FX_SENDS" (Section 6.4.31) command and <midi-ctrl> reflects the MIDI
4264     controller which shall be able to modify the effect send's send     controller which shall be able to modify the effect send's send
4265     level.     level.
4266    
# Line 4016  Internet-Draft        LinuxSampler Contr Line 4287  Internet-Draft        LinuxSampler Contr
4287    
4288        S: "OK"        S: "OK"
4289    
4290  6.4.35.  Altering effect send's send level  6.4.38.  Altering effect send's send level
4291    
4292     The front-end can alter the current send level of an effect send     The front-end can alter the current send level of an effect send
4293     entity by sending the following command:     entity by sending the following command:
# Line 4025  Internet-Draft        LinuxSampler Contr Line 4296  Internet-Draft        LinuxSampler Contr
4296    
4297     Where <sampler-chan> is the sampler channel number as returned by the     Where <sampler-chan> is the sampler channel number as returned by the
4298     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)     "ADD CHANNEL" (Section 6.4.5) or "LIST CHANNELS" (Section 6.4.4)
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 72]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
4299     command, <fx-send-id> reflects the numerical ID of the effect send     command, <fx-send-id> reflects the numerical ID of the effect send
4300     entity as returned by the "CREATE FX_SEND" (Section 6.4.25) or "LIST     entity as returned by the "CREATE FX_SEND" (Section 6.4.28) or "LIST
4301     FX_SENDS" (Section 6.4.28) command and <volume> is an optionally     FX_SENDS" (Section 6.4.31) command and <volume> is an optionally
4302     dotted positive number (a value smaller than 1.0 means attenuation,     dotted positive number (a value smaller than 1.0 means attenuation,
4303     whereas a value greater than 1.0 means amplification) reflecting the     whereas a value greater than 1.0 means amplification) reflecting the
4304     new send level.     new send level.
4305    
4306     Possible Answers:     Possible Answers:
4307    
4308    
4309    
4310    
4311    Schoenebeck               Expires July 13, 2014                [Page 77]
4312    
4313    Internet-Draft        LinuxSampler Control Protocol         January 2014
4314    
4315    
4316        "OK" -        "OK" -
4317    
4318           on success           on success
# Line 4063  Internet-Draft        LinuxSampler Contr Line 4334  Internet-Draft        LinuxSampler Contr
4334    
4335        S: "OK"        S: "OK"
4336    
4337  6.4.36.  Sending MIDI messages to sampler channel  6.4.39.  Sending MIDI messages to sampler channel
4338    
4339     The front-end can send MIDI events to a specific sampler channel by     The front-end can send MIDI events to a specific sampler channel by
4340     sending the following command:     sending the following command:
# Line 4082  Internet-Draft        LinuxSampler Contr Line 4353  Internet-Draft        LinuxSampler Contr
4353           number and <arg2> the velocity as described in the MIDI           number and <arg2> the velocity as described in the MIDI
4354           specification.           specification.
4355    
   
   
 Schoenebeck             Expires December 26, 2011              [Page 73]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
4356        "NOTE_OFF" -        "NOTE_OFF" -
4357    
4358           For turning a currently playing MIDI note off, where <arg1>           For turning a currently playing MIDI note off, where <arg1>
4359           specifies the key number and <arg2> the velocity as described           specifies the key number and <arg2> the velocity as described
4360           in the MIDI specification.           in the MIDI specification.
4361    
4362    
4363    
4364    
4365    
4366    
4367    Schoenebeck               Expires July 13, 2014                [Page 78]
4368    
4369    Internet-Draft        LinuxSampler Control Protocol         January 2014
4370    
4371    
4372        "CC" -        "CC" -
4373    
4374           For changing a MIDI controller, where <arg1> specifies the           For changing a MIDI controller, where <arg1> specifies the
# Line 4122  Internet-Draft        LinuxSampler Contr Line 4396  Internet-Draft        LinuxSampler Contr
4396    
4397        S: "OK"        S: "OK"
4398    
4399  6.4.37.  Resetting a sampler channel  6.4.40.  Resetting a sampler channel
4400    
4401     The front-end can reset a particular sampler channel by sending the     The front-end can reset a particular sampler channel by sending the
4402     following command:     following command:
# Line 4136  Internet-Draft        LinuxSampler Contr Line 4410  Internet-Draft        LinuxSampler Contr
4410    
4411     Possible Answers:     Possible Answers:
4412    
4413          "OK" -
4414    
4415             on success
4416    
4417          "WRN:<warning-code>:<warning-message>" -
4418    
4419    
 Schoenebeck             Expires December 26, 2011              [Page 74]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
4420    
4421    
       "OK" -  
4422    
4423           on success  Schoenebeck               Expires July 13, 2014                [Page 79]
4424    
4425    Internet-Draft        LinuxSampler Control Protocol         January 2014
4426    
       "WRN:<warning-code>:<warning-message>" -  
4427    
4428           if channel was reset, but there are noteworthy issue(s)           if channel was reset, but there are noteworthy issue(s)
4429           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
# Line 4191  Internet-Draft        LinuxSampler Contr Line 4465  Internet-Draft        LinuxSampler Contr
4465           related, providing an appropriate warning code and warning           related, providing an appropriate warning code and warning
4466           message           message
4467    
4468          "ERR:<error-code>:<error-message>" -
4469    
4470             in case it failed, providing an appropriate error code and
4471             error message
4472    
4473       Examples:
4474    
4475    
4476    
 Schoenebeck             Expires December 26, 2011              [Page 75]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
4477    
       "ERR:<error-code>:<error-message>" -  
4478    
4479           in case it failed, providing an appropriate error code and  Schoenebeck               Expires July 13, 2014                [Page 80]
4480           error message  
4481    Internet-Draft        LinuxSampler Control Protocol         January 2014
4482    
    Examples:  
4483    
4484    
4485    
# Line 4249  Internet-Draft        LinuxSampler Contr Line 4522  Internet-Draft        LinuxSampler Contr
4522        SET ECHO <value>        SET ECHO <value>
4523    
4524     Where <value> should be replaced either by "1" to enable echo mode or     Where <value> should be replaced either by "1" to enable echo mode or
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 76]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
4525     "0" to disable echo mode.  When echo mode is enabled, all commands     "0" to disable echo mode.  When echo mode is enabled, all commands
4526     send to LinuxSampler will be immediately send back and after this     send to LinuxSampler will be immediately send back and after this
4527     echo the actual response to the command will be returned.  Echo mode     echo the actual response to the command will be returned.  Echo mode
# Line 4265  Internet-Draft        LinuxSampler Contr Line 4530  Internet-Draft        LinuxSampler Contr
4530    
4531     Possible Answers:     Possible Answers:
4532    
4533    
4534    
4535    Schoenebeck               Expires July 13, 2014                [Page 81]
4536    
4537    Internet-Draft        LinuxSampler Control Protocol         January 2014
4538    
4539    
4540        "OK" -        "OK" -
4541    
4542           usually           usually
# Line 4303  Internet-Draft        LinuxSampler Contr Line 4575  Internet-Draft        LinuxSampler Contr
4575        LinuxSampler will answer by returning the number of all active        LinuxSampler will answer by returning the number of all active
4576        voices on the sampler.        voices on the sampler.
4577    
4578    6.6.2.  Maximum amount of active voices
4579    
4580       The front-end can ask for the maximum number of active voices by
4581       sending the following command:
4582    
4583          GET TOTAL_VOICE_COUNT_MAX
4584    
4585       Possible Answers:
4586    
4587    
 Schoenebeck             Expires December 26, 2011              [Page 77]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
4588    
4589    
 6.6.2.  Maximum amount of active voices  
4590    
4591     The front-end can ask for the maximum number of active voices by  Schoenebeck               Expires July 13, 2014                [Page 82]
4592     sending the following command:  
4593    Internet-Draft        LinuxSampler Control Protocol         January 2014
       GET TOTAL_VOICE_COUNT_MAX  
4594    
    Possible Answers:  
4595    
4596        LinuxSampler will answer by returning the maximum number of active        LinuxSampler will answer by returning the maximum number of active
4597        voices.        voices.
# Line 4359  Internet-Draft        LinuxSampler Contr Line 4630  Internet-Draft        LinuxSampler Contr
4630     The client can ask for general informations about the LinuxSampler     The client can ask for general informations about the LinuxSampler
4631     instance by sending the following command:     instance by sending the following command:
4632    
   
   
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 78]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
4633        GET SERVER INFO        GET SERVER INFO
4634    
4635     Possible Answers:     Possible Answers:
# Line 4381  Internet-Draft        LinuxSampler Contr Line 4642  Internet-Draft        LinuxSampler Contr
4642    
4643    
4644    
4645    
4646    
4647    Schoenebeck               Expires July 13, 2014                [Page 83]
4648    
4649    Internet-Draft        LinuxSampler Control Protocol         January 2014
4650    
4651    
4652    
4653    
4654           DESCRIPTION -           DESCRIPTION -
4655    
4656              arbitrary textual description about the sampler (note that              arbitrary textual description about the sampler (note that
# Line 4404  Internet-Draft        LinuxSampler Contr Line 4674  Internet-Draft        LinuxSampler Contr
4674     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
4675     Other fields might be added in future.     Other fields might be added in future.
4676    
4677       Example:
4678    
4679          C: "GET SERVER INFO"
4680    
4681          S: "DESCRIPTION: LinuxSampler - modular, streaming capable
4682          sampler"
4683    
4684             "VERSION: 1.0.0.svn23"
4685    
4686             "PROTOCOL_VERSION: 1.5"
4687    
4688             "INSTRUMENTS_DB_SUPPORT: no"
4689    
4690             "."
4691    
4692  6.6.6.  Getting global volume attenuation  6.6.6.  Getting global volume attenuation
4693    
4694     The client can ask for the current global sampler-wide volume     The client can ask for the current global sampler-wide volume
# Line 4413  Internet-Draft        LinuxSampler Contr Line 4698  Internet-Draft        LinuxSampler Contr
4698    
4699     Possible Answers:     Possible Answers:
4700    
       The sampler will always answer by returning the optional dotted  
       floating point coefficient, reflecting the current global volume  
       attenuation.  
   
   
4701    
4702    
4703  Schoenebeck             Expires December 26, 2011              [Page 79]  Schoenebeck               Expires July 13, 2014                [Page 84]
4704    
4705  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
4706    
4707    
4708          The sampler will always answer by returning the optional dotted
4709          floating point coefficient, reflecting the current global volume
4710          attenuation.
4711    
4712     Note: it is up to the respective sampler engine whether to obey that     Note: it is up to the respective sampler engine whether to obey that
4713     global volume parameter or not, but in general all engines SHOULD use     global volume parameter or not, but in general all engines SHOULD use
4714     this parameter.     this parameter.
# Line 4467  Internet-Draft        LinuxSampler Contr Line 4751  Internet-Draft        LinuxSampler Contr
4751    
4752     Possible Answers:     Possible Answers:
4753    
       LinuxSampler will answer by returning the number for the current  
       limit of maximum voices.  
4754    
    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  
4755    
4756    
4757    
4758  Schoenebeck             Expires December 26, 2011              [Page 80]  
4759    Schoenebeck               Expires July 13, 2014                [Page 85]
4760    
4761  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
4762    
4763    
4764          LinuxSampler will answer by returning the number for the current
4765          limit of maximum voices.
4766    
4767       The voice limit setting defines how many voices should maximum be
4768       processed by the sampler at the same time.  If the user triggers new
4769       notes which would exceed that voice limit, the sampler engine will
4770     react by stealing old voices for those newly triggered notes.  Note     react by stealing old voices for those newly triggered notes.  Note
4771     that the amount of voices triggered by a new note can be larger than     that the amount of voices triggered by a new note can be larger than
4772     one and is dependent to the respective instrument and probably     one and is dependent to the respective instrument and probably
# Line 4522  Internet-Draft        LinuxSampler Contr Line 4808  Internet-Draft        LinuxSampler Contr
4808     Caution: when adjusting the voice limit, you SHOULD also adjust the     Caution: when adjusting the voice limit, you SHOULD also adjust the
4809     disk stream limit respectively and vice versa.     disk stream limit respectively and vice versa.
4810    
 6.6.10.  Getting global disk stream limit  
   
    The client can ask for the current global sampler-wide limit for  
    maximum disk streams by sending the following command:  
4811    
4812    
4813    
4814    
4815    Schoenebeck               Expires July 13, 2014                [Page 86]
4816    
4817    Internet-Draft        LinuxSampler Control Protocol         January 2014
4818    
4819    
4820  Schoenebeck             Expires December 26, 2011              [Page 81]  6.6.10.  Getting global disk stream limit
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
4821    
4822       The client can ask for the current global sampler-wide limit for
4823       maximum disk streams by sending the following command:
4824    
4825        GET STREAMS        GET STREAMS
4826    
# Line 4580  Internet-Draft        LinuxSampler Contr Line 4865  Internet-Draft        LinuxSampler Contr
4865    
4866     Note: the given value will be passed to all sampler engine instances.     Note: the given value will be passed to all sampler engine instances.
4867     The total amount of maximum disk streams on the running system might     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.  
4868    
4869    
4870    
4871  Schoenebeck             Expires December 26, 2011              [Page 82]  Schoenebeck               Expires July 13, 2014                [Page 87]
4872    
4873  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
4874    
4875    
4876       thus be as big as the given value multiplied by the current amount of
4877       engine instances.
4878    
4879       Caution: when adjusting the disk stream limit, you SHOULD also adjust
4880       the voice limit respectively and vice versa.
4881    
4882  6.7.  MIDI Instrument Mapping  6.7.  MIDI Instrument Mapping
4883    
4884     The MIDI protocol provides a way to switch between instruments by     The MIDI protocol provides a way to switch between instruments by
# Line 4613  Internet-Draft        LinuxSampler Contr Line 4899  Internet-Draft        LinuxSampler Contr
4899     program change message on the respective sampler channel, that is by     program change message on the respective sampler channel, that is by
4900     switching to the respectively defined engine type and loading the     switching to the respectively defined engine type and loading the
4901     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"     respective instrument.  See command "SET CHANNEL MIDI_INSTRUMENT_MAP"
4902     (Section 6.4.24) for how to assign a MIDI instrument map to a sampler     (Section 6.4.27) for how to assign a MIDI instrument map to a sampler
4903     channel.     channel.
4904    
4905     Also note per MIDI specification a bank select message does not cause     Also note per MIDI specification a bank select message does not cause
# Line 4636  Internet-Draft        LinuxSampler Contr Line 4922  Internet-Draft        LinuxSampler Contr
4922     sequences as described in chapter "Character Set and Escape Sequences     sequences as described in chapter "Character Set and Escape Sequences
4923     (Section 7.1)".     (Section 7.1)".
4924    
    Possible Answers:  
   
       "OK[<map>]" -  
   
4925    
4926    
4927    Schoenebeck               Expires July 13, 2014                [Page 88]
4928    
4929    Internet-Draft        LinuxSampler Control Protocol         January 2014
4930    
4931    
4932  Schoenebeck             Expires December 26, 2011              [Page 83]     Possible Answers:
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
4933    
4934          "OK[<map>]" -
4935    
4936           in case a new MIDI instrument map could be added, where <map>           in case a new MIDI instrument map could be added, where <map>
4937           reflects the unique ID of the newly created MIDI instrument map           reflects the unique ID of the newly created MIDI instrument map
# Line 4692  Internet-Draft        LinuxSampler Contr Line 4976  Internet-Draft        LinuxSampler Contr
4976    
4977           in case the map(s) could be deleted           in case the map(s) could be deleted
4978    
       "ERR:<error-code>:<error-message>" -  
4979    
          when the given map does not exist  
   
    Examples:  
4980    
4981    
4982    
4983  Schoenebeck             Expires December 26, 2011              [Page 84]  Schoenebeck               Expires July 13, 2014                [Page 89]
4984    
4985  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
4986    
4987    
4988          "ERR:<error-code>:<error-message>" -
4989    
4990             when the given map does not exist
4991    
4992       Examples:
4993    
4994        C: "REMOVE MIDI_INSTRUMENT_MAP 0"        C: "REMOVE MIDI_INSTRUMENT_MAP 0"
4995    
4996        S: "OK"        S: "OK"
# Line 4746  Internet-Draft        LinuxSampler Contr Line 5032  Internet-Draft        LinuxSampler Contr
5032    
5033     Example:     Example:
5034    
       C: "LIST MIDI_INSTRUMENT_MAPS"  
   
       S: "0,1,5,12"  
   
5035    
5036    
5037    
5038    
5039    Schoenebeck               Expires July 13, 2014                [Page 90]
5040    
5041    Internet-Draft        LinuxSampler Control Protocol         January 2014
5042    
5043    
5044  Schoenebeck             Expires December 26, 2011              [Page 85]        C: "LIST MIDI_INSTRUMENT_MAPS"
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
5045    
5046          S: "0,1,5,12"
5047    
5048  6.7.5.  Getting MIDI instrument map information  6.7.5.  Getting MIDI instrument map information
5049    
# Line 4808  Internet-Draft        LinuxSampler Contr Line 5092  Internet-Draft        LinuxSampler Contr
5092    
5093    
5094    
5095    Schoenebeck               Expires July 13, 2014                [Page 91]
   
   
   
 Schoenebeck             Expires December 26, 2011              [Page 86]  
5096    
5097  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5098    
5099    
5100  6.7.6.  Renaming a MIDI instrument map  6.7.6.  Renaming a MIDI instrument map
# Line 4868  Internet-Draft        LinuxSampler Contr Line 5148  Internet-Draft        LinuxSampler Contr
5148    
5149    
5150    
5151  Schoenebeck             Expires December 26, 2011              [Page 87]  Schoenebeck               Expires July 13, 2014                [Page 92]
5152    
5153  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5154    
5155    
5156     <volume_value> reflects the master volume of the instrument as     <volume_value> reflects the master volume of the instrument as
# Line 4924  Internet-Draft        LinuxSampler Contr Line 5204  Internet-Draft        LinuxSampler Contr
5204    
5205    
5206    
5207  Schoenebeck             Expires December 26, 2011              [Page 88]  Schoenebeck               Expires July 13, 2014                [Page 93]
5208    
5209  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5210    
5211    
5212     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be     to this argument: "ON_DEMAND_HOLD" and "PERSISTENT" have to be
# Line 4980  Internet-Draft        LinuxSampler Contr Line 5260  Internet-Draft        LinuxSampler Contr
5260    
5261    
5262    
5263  Schoenebeck             Expires December 26, 2011              [Page 89]  Schoenebeck               Expires July 13, 2014                [Page 94]
5264    
5265  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5266    
5267    
5268        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0        C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0
# Line 5010  Internet-Draft        LinuxSampler Contr Line 5290  Internet-Draft        LinuxSampler Contr
5290    
5291        S: "OK"        S: "OK"
5292    
5293  6.7.8.  Getting ammount of MIDI instrument map entries  6.7.8.  Getting amount of MIDI instrument map entries
5294    
5295     The front-end can query the amount of currently existing entries in a     The front-end can query the amount of currently existing entries in a
5296     MIDI instrument map by sending the following command:     MIDI instrument map by sending the following command:
# Line 5036  Internet-Draft        LinuxSampler Contr Line 5316  Internet-Draft        LinuxSampler Contr
5316    
5317    
5318    
5319  Schoenebeck             Expires December 26, 2011              [Page 90]  Schoenebeck               Expires July 13, 2014                [Page 95]
5320    
5321  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5322    
5323    
5324        C: "GET MIDI_INSTRUMENTS ALL"        C: "GET MIDI_INSTRUMENTS ALL"
# Line 5092  Internet-Draft        LinuxSampler Contr Line 5372  Internet-Draft        LinuxSampler Contr
5372    
5373    
5374    
5375  Schoenebeck             Expires December 26, 2011              [Page 91]  Schoenebeck               Expires July 13, 2014                [Page 96]
5376    
5377  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5378    
5379    
5380        "OK" -        "OK" -
# Line 5148  Internet-Draft        LinuxSampler Contr Line 5428  Internet-Draft        LinuxSampler Contr
5428    
5429    
5430    
5431  Schoenebeck             Expires December 26, 2011              [Page 92]  Schoenebeck               Expires July 13, 2014                [Page 97]
5432    
5433  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5434    
5435    
5436        "INSTRUMENT_FILE" -        "INSTRUMENT_FILE" -
# Line 5204  Internet-Draft        LinuxSampler Contr Line 5484  Internet-Draft        LinuxSampler Contr
5484    
5485    
5486    
5487  Schoenebeck             Expires December 26, 2011              [Page 93]  Schoenebeck               Expires July 13, 2014                [Page 98]
5488    
5489  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5490    
5491    
5492           "."           "."
# Line 5260  Internet-Draft        LinuxSampler Contr Line 5540  Internet-Draft        LinuxSampler Contr
5540    
5541    
5542    
5543  Schoenebeck             Expires December 26, 2011              [Page 94]  Schoenebeck               Expires July 13, 2014                [Page 99]
5544    
5545  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5546    
5547    
5548        All occurrences of a forward slash in instrument and directory        All occurrences of a forward slash in instrument and directory
# Line 5316  Internet-Draft        LinuxSampler Contr Line 5596  Internet-Draft        LinuxSampler Contr
5596    
5597    
5598    
5599  Schoenebeck             Expires December 26, 2011              [Page 95]  Schoenebeck               Expires July 13, 2014               [Page 100]
5600    
5601  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5602    
5603    
5604           if the directory is deleted successfully           if the directory is deleted successfully
# Line 5372  Internet-Draft        LinuxSampler Contr Line 5652  Internet-Draft        LinuxSampler Contr
5652    
5653    
5654    
5655  Schoenebeck             Expires December 26, 2011              [Page 96]  Schoenebeck               Expires July 13, 2014               [Page 101]
5656    
5657  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5658    
5659    
5660     directory.  If RECURSIVE is specified, the absolute path names of all     directory.  If RECURSIVE is specified, the absolute path names of all
# Line 5428  Internet-Draft        LinuxSampler Contr Line 5708  Internet-Draft        LinuxSampler Contr
5708    
5709    
5710    
5711  Schoenebeck             Expires December 26, 2011              [Page 97]  Schoenebeck               Expires July 13, 2014               [Page 102]
5712    
5713  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5714    
5715    
5716           CREATED -           CREATED -
# Line 5484  Internet-Draft        LinuxSampler Contr Line 5764  Internet-Draft        LinuxSampler Contr
5764    
5765    
5766    
5767  Schoenebeck             Expires December 26, 2011              [Page 98]  Schoenebeck               Expires July 13, 2014               [Page 103]
5768    
5769  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5770    
5771    
5772        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'        C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic'
# Line 5540  Internet-Draft        LinuxSampler Contr Line 5820  Internet-Draft        LinuxSampler Contr
5820    
5821    
5822    
5823  Schoenebeck             Expires December 26, 2011              [Page 99]  Schoenebeck               Expires July 13, 2014               [Page 104]
5824    
5825  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5826    
5827    
5828        "OK" -        "OK" -
# Line 5596  Internet-Draft        LinuxSampler Contr Line 5876  Internet-Draft        LinuxSampler Contr
5876    
5877    
5878    
5879  Schoenebeck             Expires December 26, 2011             [Page 100]  Schoenebeck               Expires July 13, 2014               [Page 105]
5880    
5881  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5882    
5883    
5884  6.8.10.  Finding directories  6.8.10.  Finding directories
# Line 5652  Internet-Draft        LinuxSampler Contr Line 5932  Internet-Draft        LinuxSampler Contr
5932    
5933    
5934    
5935  Schoenebeck             Expires December 26, 2011             [Page 101]  Schoenebeck               Expires July 13, 2014               [Page 106]
5936    
5937  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5938    
5939    
5940     Where <search-string> is either a regular expression, or a word list     Where <search-string> is either a regular expression, or a word list
# Line 5708  Internet-Draft        LinuxSampler Contr Line 5988  Internet-Draft        LinuxSampler Contr
5988    
5989    
5990    
5991  Schoenebeck             Expires December 26, 2011             [Page 102]  Schoenebeck               Expires July 13, 2014               [Page 107]
5992    
5993  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
5994    
5995    
5996        "RECURSIVE" -        "RECURSIVE" -
# Line 5764  Internet-Draft        LinuxSampler Contr Line 6044  Internet-Draft        LinuxSampler Contr
6044    
6045    
6046    
6047  Schoenebeck             Expires December 26, 2011             [Page 103]  Schoenebeck               Expires July 13, 2014               [Page 108]
6048    
6049  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6050    
6051    
6052        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI        C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI
# Line 5820  Internet-Draft        LinuxSampler Contr Line 6100  Internet-Draft        LinuxSampler Contr
6100    
6101    
6102    
6103  Schoenebeck             Expires December 26, 2011             [Page 104]  Schoenebeck               Expires July 13, 2014               [Page 109]
6104    
6105  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6106    
6107    
6108        "ERR:<error-code>:<error-message>" -        "ERR:<error-code>:<error-message>" -
# Line 5876  Internet-Draft        LinuxSampler Contr Line 6156  Internet-Draft        LinuxSampler Contr
6156    
6157    
6158    
6159  Schoenebeck             Expires December 26, 2011             [Page 105]  Schoenebeck               Expires July 13, 2014               [Page 110]
6160    
6161  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6162    
6163    
6164        GET DB_INSTRUMENT INFO <instr_path>        GET DB_INSTRUMENT INFO <instr_path>
# Line 5932  Internet-Draft        LinuxSampler Contr Line 6212  Internet-Draft        LinuxSampler Contr
6212    
6213    
6214    
6215  Schoenebeck             Expires December 26, 2011             [Page 106]  Schoenebeck               Expires July 13, 2014               [Page 111]
6216    
6217  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6218    
6219    
6220           DESCRIPTION -           DESCRIPTION -
# Line 5988  Internet-Draft        LinuxSampler Contr Line 6268  Internet-Draft        LinuxSampler Contr
6268    
6269    
6270    
6271  Schoenebeck             Expires December 26, 2011             [Page 107]  Schoenebeck               Expires July 13, 2014               [Page 112]
6272    
6273  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6274    
6275    
6276           "DESCRIPTION: "           "DESCRIPTION: "
# Line 6044  Internet-Draft        LinuxSampler Contr Line 6324  Internet-Draft        LinuxSampler Contr
6324    
6325    
6326    
6327  Schoenebeck             Expires December 26, 2011             [Page 108]  Schoenebeck               Expires July 13, 2014               [Page 113]
6328    
6329  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6330    
6331    
6332     <dst> is the directory where the instrument will be moved to.     <dst> is the directory where the instrument will be moved to.
# Line 6100  Internet-Draft        LinuxSampler Contr Line 6380  Internet-Draft        LinuxSampler Contr
6380    
6381    
6382    
6383  Schoenebeck             Expires December 26, 2011             [Page 109]  Schoenebeck               Expires July 13, 2014               [Page 114]
6384    
6385  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6386    
6387    
6388        S: "OK"        S: "OK"
# Line 6156  Internet-Draft        LinuxSampler Contr Line 6436  Internet-Draft        LinuxSampler Contr
6436    
6437    
6438    
6439  Schoenebeck             Expires December 26, 2011             [Page 110]  Schoenebeck               Expires July 13, 2014               [Page 115]
6440    
6441  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6442    
6443    
6444        Restricts the search to instruments, which names satisfy the        Restricts the search to instruments, which names satisfy the
# Line 6212  Internet-Draft        LinuxSampler Contr Line 6492  Internet-Draft        LinuxSampler Contr
6492    
6493    
6494    
6495  Schoenebeck             Expires December 26, 2011             [Page 111]  Schoenebeck               Expires July 13, 2014               [Page 116]
6496    
6497  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6498    
6499    
6500        Restricts the search to instruments with artists info that        Restricts the search to instruments with artists info that
# Line 6268  Internet-Draft        LinuxSampler Contr Line 6548  Internet-Draft        LinuxSampler Contr
6548    
6549    
6550    
6551  Schoenebeck             Expires December 26, 2011             [Page 112]  Schoenebeck               Expires July 13, 2014               [Page 117]
6552    
6553  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6554    
6555    
6556  6.8.21.  Getting job status information  6.8.21.  Getting job status information
# Line 6324  Internet-Draft        LinuxSampler Contr Line 6604  Internet-Draft        LinuxSampler Contr
6604    
6605    
6606    
6607  Schoenebeck             Expires December 26, 2011             [Page 113]  Schoenebeck               Expires July 13, 2014               [Page 118]
6608    
6609  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6610    
6611    
6612           "FILES_SCANNED: 7"           "FILES_SCANNED: 7"
# Line 6380  Internet-Draft        LinuxSampler Contr Line 6660  Internet-Draft        LinuxSampler Contr
6660    
6661    
6662    
6663  Schoenebeck             Expires December 26, 2011             [Page 114]  Schoenebeck               Expires July 13, 2014               [Page 119]
6664    
6665  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6666    
6667    
6668        C: "FIND LOST DB_INSTRUMENT_FILES"        C: "FIND LOST DB_INSTRUMENT_FILES"
# Line 6436  Internet-Draft        LinuxSampler Contr Line 6716  Internet-Draft        LinuxSampler Contr
6716    
6717    
6718    
6719  Schoenebeck             Expires December 26, 2011             [Page 115]  Schoenebeck               Expires July 13, 2014               [Page 120]
6720    
6721  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6722    
6723    
6724  6.9.1.  Opening an appropriate instrument editor application  6.9.1.  Opening an appropriate instrument editor application
# Line 6492  Internet-Draft        LinuxSampler Contr Line 6772  Internet-Draft        LinuxSampler Contr
6772    
6773    
6774    
6775  Schoenebeck             Expires December 26, 2011             [Page 116]  Schoenebeck               Expires July 13, 2014               [Page 121]
6776    
6777  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6778    
6779    
6780  6.10.  Managing Files  6.10.  Managing Files
# Line 6548  Internet-Draft        LinuxSampler Contr Line 6828  Internet-Draft        LinuxSampler Contr
6828    
6829    
6830    
6831  Schoenebeck             Expires December 26, 2011             [Page 117]  Schoenebeck               Expires July 13, 2014               [Page 122]
6832    
6833  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6834    
6835    
6836     The sampler will try to ask all sampler engines, whether they support     The sampler will try to ask all sampler engines, whether they support
# Line 6604  Internet-Draft        LinuxSampler Contr Line 6884  Internet-Draft        LinuxSampler Contr
6884    
6885    
6886    
6887  Schoenebeck             Expires December 26, 2011             [Page 118]  Schoenebeck               Expires July 13, 2014               [Page 123]
6888    
6889  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6890    
6891    
6892           NAME -           NAME -
# Line 6660  Internet-Draft        LinuxSampler Contr Line 6940  Internet-Draft        LinuxSampler Contr
6940    
6941    
6942    
6943  Schoenebeck             Expires December 26, 2011             [Page 119]  Schoenebeck               Expires July 13, 2014               [Page 124]
6944    
6945  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
6946    
6947    
6948           "ARTISTS: Jimmy the Fish"           "ARTISTS: Jimmy the Fish"
# Line 6696  Internet-Draft        LinuxSampler Contr Line 6976  Internet-Draft        LinuxSampler Contr
6976     effect chains.  Audio signals of sampler channels are fed to send     effect chains.  Audio signals of sampler channels are fed to send
6977     effects by creating FX sends to the respective sampler channel and     effects by creating FX sends to the respective sampler channel and
6978     assigning a destination send effect to that FX by using the "SET     assigning a destination send effect to that FX by using the "SET
6979     FX_SEND EFFECT" (Section 6.4.32) command.  The latter allows to route     FX_SEND EFFECT" (Section 6.4.35) command.  The latter allows to route
6980     the FX send to the beginning of a send effect chain, as well as     the FX send to the beginning of a send effect chain, as well as
6981     directly to any other position of the send effect chain.     directly to any other position of the send effect chain.
6982    
# Line 6716  Internet-Draft        LinuxSampler Contr Line 6996  Internet-Draft        LinuxSampler Contr
6996    
6997    
6998    
6999  Schoenebeck             Expires December 26, 2011             [Page 120]  Schoenebeck               Expires July 13, 2014               [Page 125]
7000    
7001  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7002    
7003    
7004        C: "GET AVAILABLE_EFFECTS"        C: "GET AVAILABLE_EFFECTS"
# Line 6772  Internet-Draft        LinuxSampler Contr Line 7052  Internet-Draft        LinuxSampler Contr
7052    
7053    
7054    
7055  Schoenebeck             Expires December 26, 2011             [Page 121]  Schoenebeck               Expires July 13, 2014               [Page 126]
7056    
7057  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7058    
7059    
7060              name of the effect plugin system the effect is based on              name of the effect plugin system the effect is based on
# Line 6828  Internet-Draft        LinuxSampler Contr Line 7108  Internet-Draft        LinuxSampler Contr
7108    
7109    
7110    
7111  Schoenebeck             Expires December 26, 2011             [Page 122]  Schoenebeck               Expires July 13, 2014               [Page 127]
7112    
7113  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7114    
7115    
7116     EFFECT INFO" (Section 6.11.3) command.  The filename of argument     EFFECT INFO" (Section 6.11.3) command.  The filename of argument
# Line 6884  Internet-Draft        LinuxSampler Contr Line 7164  Internet-Draft        LinuxSampler Contr
7164    
7165    
7166    
7167  Schoenebeck             Expires December 26, 2011             [Page 123]  Schoenebeck               Expires July 13, 2014               [Page 128]
7168    
7169  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7170    
7171    
7172        CREATE EFFECT_INSTANCE <effect-index>        CREATE EFFECT_INSTANCE <effect-index>
# Line 6940  Internet-Draft        LinuxSampler Contr Line 7220  Internet-Draft        LinuxSampler Contr
7220    
7221    
7222    
7223  Schoenebeck             Expires December 26, 2011             [Page 124]  Schoenebeck               Expires July 13, 2014               [Page 129]
7224    
7225  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7226    
7227    
7228        DESTROY EFFECT_INSTANCE <effect-instance>        DESTROY EFFECT_INSTANCE <effect-instance>
# Line 6996  Internet-Draft        LinuxSampler Contr Line 7276  Internet-Draft        LinuxSampler Contr
7276    
7277    
7278    
7279  Schoenebeck             Expires December 26, 2011             [Page 125]  Schoenebeck               Expires July 13, 2014               [Page 130]
7280    
7281  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7282    
7283    
7284  6.11.8.  Get list of effect instances  6.11.8.  Get list of effect instances
# Line 7052  Internet-Draft        LinuxSampler Contr Line 7332  Internet-Draft        LinuxSampler Contr
7332    
7333    
7334    
7335  Schoenebeck             Expires December 26, 2011             [Page 126]  Schoenebeck               Expires July 13, 2014               [Page 131]
7336    
7337  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7338    
7339    
7340              (DLL) filename of the effect plugin, including full path              (DLL) filename of the effect plugin, including full path
# Line 7108  Internet-Draft        LinuxSampler Contr Line 7388  Internet-Draft        LinuxSampler Contr
7388    
7389    
7390    
7391  Schoenebeck             Expires December 26, 2011             [Page 127]  Schoenebeck               Expires July 13, 2014               [Page 132]
7392    
7393  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7394    
7395    
7396        GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-        GET EFFECT_INSTANCE_INPUT_CONTROL INFO <effect-instance> <input-
# Line 7164  Internet-Draft        LinuxSampler Contr Line 7444  Internet-Draft        LinuxSampler Contr
7444    
7445    
7446    
7447  Schoenebeck             Expires December 26, 2011             [Page 128]  Schoenebeck               Expires July 13, 2014               [Page 133]
7448    
7449  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7450    
7451    
7452              (optionally returned) comma separated list of (optional              (optionally returned) comma separated list of (optional
# Line 7220  Internet-Draft        LinuxSampler Contr Line 7500  Internet-Draft        LinuxSampler Contr
7500    
7501    
7502    
7503  Schoenebeck             Expires December 26, 2011             [Page 129]  Schoenebeck               Expires July 13, 2014               [Page 134]
7504    
7505  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7506    
7507    
7508     Examples:     Examples:
# Line 7276  Internet-Draft        LinuxSampler Contr Line 7556  Internet-Draft        LinuxSampler Contr
7556    
7557    
7558    
7559  Schoenebeck             Expires December 26, 2011             [Page 130]  Schoenebeck               Expires July 13, 2014               [Page 135]
7560    
7561  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7562    
7563    
7564        C: "LIST SEND_EFFECT_CHAINS 0"        C: "LIST SEND_EFFECT_CHAINS 0"
# Line 7332  Internet-Draft        LinuxSampler Contr Line 7612  Internet-Draft        LinuxSampler Contr
7612    
7613    
7614    
7615  Schoenebeck             Expires December 26, 2011             [Page 131]  Schoenebeck               Expires July 13, 2014               [Page 136]
7616    
7617  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7618    
7619    
7620        "OK" -        "OK" -
# Line 7388  Internet-Draft        LinuxSampler Contr Line 7668  Internet-Draft        LinuxSampler Contr
7668    
7669    
7670    
7671  Schoenebeck             Expires December 26, 2011             [Page 132]  Schoenebeck               Expires July 13, 2014               [Page 137]
7672    
7673  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7674    
7675    
7676     The mentioned fields above don't have to be in particular order.     The mentioned fields above don't have to be in particular order.
# Line 7444  Internet-Draft        LinuxSampler Contr Line 7724  Internet-Draft        LinuxSampler Contr
7724    
7725    
7726    
7727  Schoenebeck             Expires December 26, 2011             [Page 133]  Schoenebeck               Expires July 13, 2014               [Page 138]
7728    
7729  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7730    
7731    
7732        S: "OK"        S: "OK"
# Line 7500  Internet-Draft        LinuxSampler Contr Line 7780  Internet-Draft        LinuxSampler Contr
7780    
7781    
7782    
7783  Schoenebeck             Expires December 26, 2011             [Page 134]  Schoenebeck               Expires July 13, 2014               [Page 139]
7784    
7785  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7786    
7787    
7788     Where <audio-device> should be replaced by the numerical ID of the     Where <audio-device> should be replaced by the numerical ID of the
# Line 7556  Internet-Draft        LinuxSampler Contr Line 7836  Internet-Draft        LinuxSampler Contr
7836    
7837    
7838    
7839  Schoenebeck             Expires December 26, 2011             [Page 135]  Schoenebeck               Expires July 13, 2014               [Page 140]
7840    
7841  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7842    
7843    
7844  7.  Command Syntax  7.  Command Syntax
# Line 7612  Internet-Draft        LinuxSampler Contr Line 7892  Internet-Draft        LinuxSampler Contr
7892    
7893    
7894    
7895  Schoenebeck             Expires December 26, 2011             [Page 136]  Schoenebeck               Expires July 13, 2014               [Page 141]
7896    
7897  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7898    
7899    
7900        / LIST SP list_instruction        / LIST SP list_instruction
# Line 7657  Internet-Draft        LinuxSampler Contr Line 7937  Internet-Draft        LinuxSampler Contr
7937    
7938        CHANNEL        CHANNEL
7939    
7940        / DB_INSTRUMENT_DIRECTORY SP db_path        / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
7941    
7942        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename        / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP
7943          midi_input_port_index
7944    
7945        / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP        / DB_INSTRUMENT_DIRECTORY SP db_path
       db_path SP filename  
7946    
7947    
7948    
7949    
7950    
7951  Schoenebeck             Expires December 26, 2011             [Page 137]  Schoenebeck               Expires July 13, 2014               [Page 142]
7952    
7953  Internet-Draft        LinuxSampler Control Protocol            June 2011  Internet-Draft        LinuxSampler Control Protocol         January 2014
7954    
7955    
7956          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP db_path SP filename
7957    
7958          / DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP FILE_AS_DIR SP
7959          db_path SP filename
7960    
7961        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename        / DB_INSTRUMENTS SP scan_mode SP db_path SP filename
7962    
# Line 7715  Internet-Draft        LinuxSampler Contr Line 8000  Internet-Draft        LinuxSampler Contr
8000    
8001        / BUFFER_FILL        / BUFFER_FILL
8002    
       / CHANNEL_INFO  
8003    
       / FX_SEND_COUNT  
8004    
       / FX_SEND_INFO  
8005    
8006    
8007    Schoenebeck               Expires July 13, 2014               [Page 143]
8008    
8009    Internet-Draft        LinuxSampler Control Protocol         January 2014
8010    
8011    
8012  Schoenebeck             Expires December 26, 2011             [Page 138]        / CHANNEL_INFO
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
8013    
8014          / FX_SEND_COUNT
8015    
8016          / FX_SEND_INFO
8017    
8018        / MIDI_INSTRUMENT_MAP_COUNT        / MIDI_INSTRUMENT_MAP_COUNT
8019    
# Line 7771  Internet-Draft        LinuxSampler Contr Line 8057  Internet-Draft        LinuxSampler Contr
8057    
8058        / MIDI_INPUT_DEVICE_COUNT        / MIDI_INPUT_DEVICE_COUNT
8059    
       / MIDI_INPUT_DEVICE_INFO  
8060    
       / CHANNEL_COUNT  
8061    
       / CHANNEL_MIDI  
8062    
8063    Schoenebeck               Expires July 13, 2014               [Page 144]
8064    
8065    Internet-Draft        LinuxSampler Control Protocol         January 2014
8066    
8067    
8068          / MIDI_INPUT_DEVICE_INFO
8069    
8070  Schoenebeck             Expires December 26, 2011             [Page 139]        / CHANNEL_COUNT
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
8071    
8072          / CHANNEL_MIDI
8073    
8074        / DEVICE_MIDI        / DEVICE_MIDI
8075    
# Line 7827  Internet-Draft        LinuxSampler Contr Line 8113  Internet-Draft        LinuxSampler Contr
8113    
8114        / EFFECT_INSTANCE_COUNT        / EFFECT_INSTANCE_COUNT
8115    
       / EFFECT_INSTANCE_INFO  
8116    
       / SEND_EFFECT_CHAIN_COUNT  
8117    
       / SEND_EFFECT_CHAIN_INFO  
8118    
8119    Schoenebeck               Expires July 13, 2014               [Page 145]
8120    
8121    Internet-Draft        LinuxSampler Control Protocol         January 2014
8122    
8123    
8124          / EFFECT_INSTANCE_INFO
8125    
8126  Schoenebeck             Expires December 26, 2011             [Page 140]        / SEND_EFFECT_CHAIN_COUNT
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
8127    
8128          / SEND_EFFECT_CHAIN_INFO
8129    
8130     map_instruction =     map_instruction =
8131    
# Line 7866  Internet-Draft        LinuxSampler Contr Line 8152  Internet-Draft        LinuxSampler Contr
8152    
8153        CHANNEL SP sampler_channel        CHANNEL SP sampler_channel
8154    
8155          / CHANNEL SP MIDI_INPUT SP sampler_channel
8156    
8157          / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index
8158    
8159          / CHANNEL SP MIDI_INPUT SP sampler_channel SP device_index SP
8160          midi_input_port_index
8161    
8162        / MIDI_INSTRUMENT_MAP SP midi_map        / MIDI_INSTRUMENT_MAP SP midi_map
8163    
8164        / MIDI_INSTRUMENT_MAP SP ALL        / MIDI_INSTRUMENT_MAP SP ALL
# Line 7875  Internet-Draft        LinuxSampler Contr Line 8168  Internet-Draft        LinuxSampler Contr
8168        / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP        / SEND_EFFECT_CHAIN SP EFFECT SP device_index SP effect_chain SP
8169        chain_pos        chain_pos
8170    
8171    
8172    
8173    
8174    
8175    Schoenebeck               Expires July 13, 2014               [Page 146]
8176    
8177    Internet-Draft        LinuxSampler Control Protocol         January 2014
8178    
8179    
8180        / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id        / FX_SEND SP EFFECT SP sampler_channel SP fx_send_id
8181    
8182        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path        / DB_INSTRUMENT_DIRECTORY SP FORCE SP db_path
# Line 7889  Internet-Draft        LinuxSampler Contr Line 8191  Internet-Draft        LinuxSampler Contr
8191    
8192        / AVAILABLE_EFFECTS        / AVAILABLE_EFFECTS
8193    
   
   
   
 Schoenebeck             Expires December 26, 2011             [Page 141]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
8194        / EFFECT_INSTANCES        / EFFECT_INSTANCES
8195    
8196        / EFFECT SP INFO SP effect_index        / EFFECT SP INFO SP effect_index
# Line 7930  Internet-Draft        LinuxSampler Contr Line 8224  Internet-Draft        LinuxSampler Contr
8224    
8225        / AUDIO_OUTPUT_DEVICES        / AUDIO_OUTPUT_DEVICES
8226    
8227    
8228    
8229    
8230    
8231    Schoenebeck               Expires July 13, 2014               [Page 147]
8232    
8233    Internet-Draft        LinuxSampler Control Protocol         January 2014
8234    
8235    
8236        / MIDI_INPUT_DEVICES        / MIDI_INPUT_DEVICES
8237    
8238        / AUDIO_OUTPUT_DEVICE SP INFO SP number        / AUDIO_OUTPUT_DEVICE SP INFO SP number
# Line 7945  Internet-Draft        LinuxSampler Contr Line 8248  Internet-Draft        LinuxSampler Contr
8248        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP        / AUDIO_OUTPUT_CHANNEL_PARAMETER SP INFO SP number SP number SP
8249        string        string
8250    
   
   
   
 Schoenebeck             Expires December 26, 2011             [Page 142]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
8251        / CHANNELS        / CHANNELS
8252    
8253        / CHANNEL SP INFO SP sampler_channel        / CHANNEL SP INFO SP sampler_channel
# Line 7985  Internet-Draft        LinuxSampler Contr Line 8280  Internet-Draft        LinuxSampler Contr
8280    
8281        / FX_SENDS SP sampler_channel        / FX_SENDS SP sampler_channel
8282    
8283    
8284    
8285    
8286    
8287    Schoenebeck               Expires July 13, 2014               [Page 148]
8288    
8289    Internet-Draft        LinuxSampler Control Protocol         January 2014
8290    
8291    
8292        / FX_SEND SP INFO SP sampler_channel SP fx_send_id        / FX_SEND SP INFO SP sampler_channel SP fx_send_id
8293    
8294        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path        / DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP db_path
# Line 8001  Internet-Draft        LinuxSampler Contr Line 8305  Internet-Draft        LinuxSampler Contr
8305    
8306        / DB_INSTRUMENTS_JOB SP INFO SP number        / DB_INSTRUMENTS_JOB SP INFO SP number
8307    
   
   
   
 Schoenebeck             Expires December 26, 2011             [Page 143]  
   
 Internet-Draft        LinuxSampler Control Protocol            June 2011  
   
   
8308        / VOLUME        / VOLUME
8309