/[svn]/linuxsampler/trunk/Documentation/lscp.xml
ViewVC logotype

Diff of /linuxsampler/trunk/Documentation/lscp.xml

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

revision 1047 by schoenebeck, Mon Feb 19 19:38:04 2007 UTC revision 1135 by iliev, Thu Mar 29 09:40:45 2007 UTC
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="February" year="2007"/>          <date month="March" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 3479  Schoenebeck'> Line 3479  Schoenebeck'>
3479                      </t>                      </t>
3480                  </section>                  </section>
3481    
3482                    <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3483                        <t>The front-end can alter the current name of an effect
3484                        send entity by sending the following command:</t>
3485                        <t>
3486                            <list>
3487                                <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3488                            </list>
3489                        </t>
3490                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3491                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3492                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3493                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3494                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3495                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3496                        &lt;name&gt; is the new name of the effect send entity, which
3497                        does not have to be unique.</t>
3498    
3499                        <t>Possible Answers:</t>
3500                        <t>
3501                            <list>
3502                                <t>"OK" -
3503                                    <list>
3504                                        <t>on success</t>
3505                                    </list>
3506                                </t>
3507                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3508                                    <list>
3509                                        <t>in case it failed, providing an appropriate error code and error message</t>
3510                                    </list>
3511                                </t>
3512                            </list>
3513                        </t>
3514                        <t>Example:</t>
3515                        <t>
3516                            <list>
3517                                <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3518                                <t>S: "OK"</t>
3519                            </list>
3520                        </t>
3521                    </section>
3522    
3523                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3524                      <t>The front-end can alter the destination of an effect send's audio channel on a specific                      <t>The front-end can alter the destination of an effect send's audio channel on a specific
3525                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
# Line 4198  Schoenebeck'> Line 4239  Schoenebeck'>
4239                                              which does not have to be unique</t>                                              which does not have to be unique</t>
4240                                          </list>                                          </list>
4241                                      </t>                                      </t>
4242                                        <t>DEFAULT -
4243                                            <list>
4244                                                <t>either true or false,
4245                                                defines whether this map is the default map</t>
4246                                            </list>
4247                                        </t>
4248                                  </list>                                  </list>
4249                              </t>                              </t>
4250                          </list>                          </list>
# Line 4803  Schoenebeck'> Line 4850  Schoenebeck'>
4850                  </t>                  </t>
4851                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4852                  </t>                  </t>
4853                    <t>/ FX_SEND_COUNT
4854                    </t>
4855                    <t>/ FX_SEND_INFO
4856                    </t>
4857                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
4858                  </t>                  </t>
4859                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4815  Schoenebeck'> Line 4866  Schoenebeck'>
4866                  </t>                  </t>
4867                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4868                  </t>                  </t>
4869                    <t>/ GLOBAL_INFO
4870                    </t>
4871          </list>          </list>
4872  </t>  </t>
4873  <t>unsubscribe_event =  <t>unsubscribe_event =
# Line 4837  Schoenebeck'> Line 4890  Schoenebeck'>
4890                  </t>                  </t>
4891                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4892                  </t>                  </t>
4893                    <t>/ FX_SEND_COUNT
4894                    </t>
4895                    <t>/ FX_SEND_INFO
4896                    </t>
4897                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
4898                  </t>                  </t>
4899                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4849  Schoenebeck'> Line 4906  Schoenebeck'>
4906                  </t>                  </t>
4907                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4908                  </t>                  </t>
4909                    <t>/ GLOBAL_INFO
4910                    </t>
4911          </list>          </list>
4912  </t>  </t>
4913  <t>map_instruction =  <t>map_instruction =
# Line 4965  Schoenebeck'> Line 5024  Schoenebeck'>
5024                  </t>                  </t>
5025                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5026                  </t>                  </t>
5027                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5028                    </t>
5029                  <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index                  <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
5030                  </t>                  </t>
5031                  <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl                  <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
# Line 5383  Schoenebeck'> Line 5444  Schoenebeck'>
5444                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5445                  <t>                  <t>
5446                      <list>                      <list>
5447                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
5448                      </list>                      </list>
5449                  </t>                  </t>
5450                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
# Line 5453  Schoenebeck'> Line 5514  Schoenebeck'>
5514                  message is sufficient here.</t>                  message is sufficient here.</t>
5515              </section>              </section>
5516    
5517                <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
5518                    <t>Client may want to be notified when the number of effect sends on
5519                    a particular sampler channel is changed by issuing the following command:</t>
5520                    <t>
5521                        <list>
5522                            <t>SUBSCRIBE FX_SEND_COUNT</t>
5523                        </list>
5524                    </t>
5525                    <t>Server will start sending the following notification messages:</t>
5526                    <t>
5527                        <list>
5528                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
5529                        </list>
5530                    </t>
5531                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5532                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
5533                    be replaced by the new number of effect sends on that channel.</t>
5534                </section>
5535    
5536                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
5537                    <t>Client may want to be notified when changes were made to effect sends on a
5538                    a particular sampler channel by issuing the following command:</t>
5539                    <t>
5540                        <list>
5541                            <t>SUBSCRIBE FX_SEND_INFO</t>
5542                        </list>
5543                    </t>
5544                    <t>Server will start sending the following notification messages:</t>
5545                    <t>
5546                        <list>
5547                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
5548                        </list>
5549                    </t>
5550                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5551                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
5552                    be replaced by the numerical ID of the changed effect send.</t>
5553                </section>
5554    
5555              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
5556                  <t>Client may want to be notified when the total number of voices on the                  <t>Client may want to be notified when the total number of voices on the
5557                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 5464  Schoenebeck'> Line 5563  Schoenebeck'>
5563                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5564                  <t>                  <t>
5565                      <list>                      <list>
5566                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
5567                      </list>                      </list>
5568                  </t>                  </t>
5569                  <t>where &lt;voices&gt; will be replaced by the new number of                  <t>where &lt;voices&gt; will be replaced by the new number of
# Line 5553  Schoenebeck'> Line 5652  Schoenebeck'>
5652                  message is sufficient here.</t>                  message is sufficient here.</t>
5653              </section>              </section>
5654    
5655                <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
5656                    <t>Client may want to be notified when changes to the global settings
5657                    of the sampler were made by issuing the following command:</t>
5658                    <t>
5659                        <list>
5660                            <t>SUBSCRIBE GLOBAL_INFO</t>
5661                        </list>
5662                    </t>
5663                    <t>Server will start sending the following types of notification messages:</t>
5664                    <t>
5665                        <list>
5666                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
5667                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
5668                            replaced by the optional dotted floating point value, reflecting the
5669                            new global volume parameter.</t>
5670                        </list>
5671                    </t>
5672                </section>
5673    
5674              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
5675                  <t>Client may want to be notified of miscellaneous and debugging events occurring at                  <t>Client may want to be notified of miscellaneous and debugging events occurring at
5676                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.1047  
changed lines
  Added in v.1135
  ViewVC Help
Powered by ViewVC