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

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

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

revision 1110 by iliev, Thu Mar 22 21:12:10 2007 UTC revision 1137 by iliev, Thu Mar 29 10:06:37 2007 UTC
# Line 145  Line 145 
145  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>  <tr><td class="header">LinuxSampler Developers</td><td class="header">C. Schoenebeck</td></tr>
146  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>  <tr><td class="header">Internet-Draft</td><td class="header">Interessengemeinschaft Software</td></tr>
147  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>  <tr><td class="header">Intended status: Standards Track</td><td class="header">Engineering e. V.</td></tr>
148  <tr><td class="header">Expires: September 23, 2007</td><td class="header">March 22, 2007</td></tr>  <tr><td class="header">Expires: September 30, 2007</td><td class="header">March 29, 2007</td></tr>
149  </table></td></tr></table>  </table></td></tr></table>
150  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>  <h1><br />LinuxSampler Control Protocol<br />LSCP 1.2</h1>
151    
# Line 173  The list of current Internet-Drafts can Line 173  The list of current Internet-Drafts can
173  The list of Internet-Draft Shadow Directories can be accessed at  The list of Internet-Draft Shadow Directories can be accessed at
174  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>  <a href='http://www.ietf.org/shadow.html'>http://www.ietf.org/shadow.html</a>.</p>
175  <p>  <p>
176  This Internet-Draft will expire on September 23, 2007.</p>  This Internet-Draft will expire on September 30, 2007.</p>
177    
178  <h3>Copyright Notice</h3>  <h3>Copyright Notice</h3>
179  <p>  <p>
# Line 328  Getting amount of effect sends on a samp Line 328  Getting amount of effect sends on a samp
328  Listing all effect sends on a sampler channel<br />  Listing all effect sends on a sampler channel<br />
329  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#GET FX_SEND INFO">6.4.29.</a>&nbsp;
330  Getting effect send information<br />  Getting effect send information<br />
331  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.30.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND NAME">6.4.30.</a>&nbsp;
332    Changing effect send's name<br />
333    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND AUDIO_OUTPUT_CHANNEL">6.4.31.</a>&nbsp;
334  Altering effect send's audio routing<br />  Altering effect send's audio routing<br />
335  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.31.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND MIDI_CONTROLLER">6.4.32.</a>&nbsp;
336  Altering effect send's MIDI controller<br />  Altering effect send's MIDI controller<br />
337  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.32.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#SET FX_SEND LEVEL">6.4.33.</a>&nbsp;
338  Altering effect send's send level<br />  Altering effect send's send level<br />
339  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.33.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<a href="#RESET CHANNEL">6.4.34.</a>&nbsp;
340  Resetting a sampler channel<br />  Resetting a sampler channel<br />
341  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;  &nbsp;&nbsp;&nbsp;&nbsp;<a href="#anchor12">6.5.</a>&nbsp;
342  Controlling connection<br />  Controlling connection<br />
# Line 5333  Getting effect send information</h3> Line 5335  Getting effect send information</h3>
5335  </blockquote><p>  </blockquote><p>
5336                                            
5337  </p>  </p>
5338  <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />  <a name="SET FX_SEND NAME"></a><br /><hr />
5339  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5340  <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;  <a name="rfc.section.6.4.30"></a><h3>6.4.30.&nbsp;
5341    Changing effect send's name</h3>
5342    
5343    <p>The front-end can alter the current name of an effect
5344                        send entity by sending the following command:
5345    </p>
5346    <p>
5347                            </p>
5348    <blockquote class="text">
5349    <p>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;
5350    </p>
5351    </blockquote><p>
5352                        
5353    </p>
5354    <p>Where &lt;sampler-chan&gt; is the sampler channel number
5355                        as returned by the <a class='info' href='#ADD CHANNEL'>"ADD CHANNEL"<span> (</span><span class='info'>Adding a new sampler channel</span><span>)</span></a>
5356                        or <a class='info' href='#LIST CHANNELS'>"LIST CHANNELS"<span> (</span><span class='info'>Getting all created sampler channel list</span><span>)</span></a> command,
5357                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
5358                        as returned by the <a class='info' href='#CREATE FX_SEND'>"CREATE FX_SEND"<span> (</span><span class='info'>Adding an effect send to a sampler channel</span><span>)</span></a>
5359                        or <a class='info' href='#LIST FX_SENDS'>"LIST FX_SENDS"<span> (</span><span class='info'>Listing all effect sends on a sampler channel</span><span>)</span></a> command and
5360                        &lt;name&gt; is the new name of the effect send entity, which
5361                        does not have to be unique.
5362    </p>
5363    <p>Possible Answers:
5364    </p>
5365    <p>
5366                            </p>
5367    <blockquote class="text">
5368    <p>"OK" -
5369                                    </p>
5370    <blockquote class="text">
5371    <p>on success
5372    </p>
5373    </blockquote>
5374                                
5375    
5376    <p>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5377                                    </p>
5378    <blockquote class="text">
5379    <p>in case it failed, providing an appropriate error code and error message
5380    </p>
5381    </blockquote>
5382                                
5383    
5384    </blockquote><p>
5385                        
5386    </p>
5387    <p>Example:
5388    </p>
5389    <p>
5390                            </p>
5391    <blockquote class="text">
5392    <p>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"
5393    </p>
5394    <p>S: "OK"
5395    </p>
5396    </blockquote><p>
5397                        
5398    </p>
5399    <a name="SET FX_SEND AUDIO_OUTPUT_CHANNEL"></a><br /><hr />
5400    <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5401    <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;
5402  Altering effect send's audio routing</h3>  Altering effect send's audio routing</h3>
5403    
5404  <p>The front-end can alter the destination of an effect send's audio channel on a specific  <p>The front-end can alter the destination of an effect send's audio channel on a specific
# Line 5418  Altering effect send's audio routing</h3 Line 5481  Altering effect send's audio routing</h3
5481  </p>  </p>
5482  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />  <a name="SET FX_SEND MIDI_CONTROLLER"></a><br /><hr />
5483  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5484  <a name="rfc.section.6.4.31"></a><h3>6.4.31.&nbsp;  <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;
5485  Altering effect send's MIDI controller</h3>  Altering effect send's MIDI controller</h3>
5486    
5487  <p>The front-end can alter the MIDI controller of an effect  <p>The front-end can alter the MIDI controller of an effect
# Line 5489  Altering effect send's MIDI controller</ Line 5552  Altering effect send's MIDI controller</
5552  </p>  </p>
5553  <a name="SET FX_SEND LEVEL"></a><br /><hr />  <a name="SET FX_SEND LEVEL"></a><br /><hr />
5554  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5555  <a name="rfc.section.6.4.32"></a><h3>6.4.32.&nbsp;  <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;
5556  Altering effect send's send level</h3>  Altering effect send's send level</h3>
5557    
5558  <p>The front-end can alter the current send level of an effect  <p>The front-end can alter the current send level of an effect
# Line 5561  Altering effect send's send level</h3> Line 5624  Altering effect send's send level</h3>
5624  </p>  </p>
5625  <a name="RESET CHANNEL"></a><br /><hr />  <a name="RESET CHANNEL"></a><br /><hr />
5626  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>  <table summary="layout" cellpadding="0" cellspacing="2" class="TOCbug" align="right"><tr><td class="TOCbug"><a href="#toc">&nbsp;TOC&nbsp;</a></td></tr></table>
5627  <a name="rfc.section.6.4.33"></a><h3>6.4.33.&nbsp;  <a name="rfc.section.6.4.34"></a><h3>6.4.34.&nbsp;
5628  Resetting a sampler channel</h3>  Resetting a sampler channel</h3>
5629    
5630  <p>The front-end can reset a particular sampler channel by sending the following command:  <p>The front-end can reset a particular sampler channel by sending the following command:
# Line 6404  Getting MIDI instrument map information< Line 6467  Getting MIDI instrument map information<
6467  </blockquote>  </blockquote>
6468                                                                            
6469    
6470    <p>DEFAULT -
6471                                            </p>
6472    <blockquote class="text">
6473    <p>either true or false,
6474                                                defines whether this map is the default map
6475    </p>
6476    </blockquote>
6477                                        
6478    
6479  </blockquote>  </blockquote>
6480                                                            
6481    
# Line 6421  Getting MIDI instrument map information< Line 6493  Getting MIDI instrument map information<
6493  </p>  </p>
6494  <p>S: "NAME: Standard Map"  <p>S: "NAME: Standard Map"
6495  </p>  </p>
6496    <p>&nbsp;&nbsp;&nbsp;"DEFAULT: true"
6497    </p>
6498  <p>&nbsp;&nbsp;&nbsp;"."  <p>&nbsp;&nbsp;&nbsp;"."
6499  </p>  </p>
6500  </blockquote><p>  </blockquote><p>
# Line 7516  Command Syntax</h3> Line 7590  Command Syntax</h3>
7590  <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name  <p>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
7591                                    
7592  </p>  </p>
7593    <p>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
7594                    
7595    </p>
7596  <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index  <p>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
7597                                    
7598  </p>  </p>

Legend:
Removed from v.1110  
changed lines
  Added in v.1137

  ViewVC Help
Powered by ViewVC