/[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 1005 by schoenebeck, Fri Dec 29 20:06:14 2006 UTC revision 1026 by schoenebeck, Sun Jan 14 17:10:59 2007 UTC
# Line 2555  Schoenebeck'> Line 2555  Schoenebeck'>
2555                                      <t>VOLUME -                                      <t>VOLUME -
2556                                          <list>                                          <list>
2557                                              <t>optionally dotted number for the channel volume factor                                              <t>optionally dotted number for the channel volume factor
2558                                              (where a value < 1.0 means attenuation and a value >                                              (where a value &lt; 1.0 means attenuation and a value >
2559                                              1.0 means amplification)</t>                                              1.0 means amplification)</t>
2560                                          </list>                                          </list>
2561                                      </t>                                      </t>
# Line 3287  Schoenebeck'> Line 3287  Schoenebeck'>
3287                              <t>S: "OK[0]"</t>                              <t>S: "OK[0]"</t>
3288                          </list>                          </list>
3289                      </t>                      </t>
3290                      <t>                      <t>
3291                          <list>                          <list>
3292                              <t>C: "CREATE FX_SEND 0 93"</t>                              <t>C: "CREATE FX_SEND 0 93"</t>
3293                              <t>S: "OK[1]"</t>                              <t>S: "OK[1]"</t>
# Line 3434  Schoenebeck'> Line 3434  Schoenebeck'>
3434                                              <t>name of the effect send entity</t>                                              <t>name of the effect send entity</t>
3435                                          </list>                                          </list>
3436                                      </t>                                      </t>
3437                                        <t>MIDI_CONTROLLER -
3438                                            <list>
3439                                                <t>a value between 0 and 127 reflecting the MIDI controller
3440                                                which is able to modify the effect send's send level</t>
3441                                            </list>
3442                                        </t>
3443                                        <t>LEVEL -
3444                                            <list>
3445                                                <t>optionally dotted number reflecting the effect send's
3446                                                current send level (where a value &lt; 1.0 means attenuation
3447                                                and a value > 1.0 means amplification)</t>
3448                                            </list>
3449                                        </t>
3450                                      <t>AUDIO_OUTPUT_ROUTING -                                      <t>AUDIO_OUTPUT_ROUTING -
3451                                          <list>                                          <list>
3452                                              <t>comma separated list which reflects to which audio                                              <t>comma separated list which reflects to which audio
# Line 3458  Schoenebeck'> Line 3471  Schoenebeck'>
3471                          <list>                          <list>
3472                              <t>C: "GET FX_SEND INFO 0 0"</t>                              <t>C: "GET FX_SEND INFO 0 0"</t>
3473                              <t>S: "NAME: Reverb Send"</t>                              <t>S: "NAME: Reverb Send"</t>
3474                                <t>&nbsp;&nbsp;&nbsp;"MIDI_CONTROLLER: 91"</t>
3475                                <t>&nbsp;&nbsp;&nbsp;"LEVEL: 0.3"</t>
3476                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>                              <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3477                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
3478                          </list>                          </list>
# Line 3524  Schoenebeck'> Line 3539  Schoenebeck'>
3539                      </t>                      </t>
3540                  </section>                  </section>
3541    
3542                    <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3543                        <t>The front-end can alter the MIDI controller of an effect
3544                        send entity by sending the following command:</t>
3545                        <t>
3546                            <list>
3547                                <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3548                            </list>
3549                        </t>
3550                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3551                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3552                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3553                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3554                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3555                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3556                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3557                        able to modify the effect send's send level.</t>
3558    
3559                        <t>Possible Answers:</t>
3560                        <t>
3561                            <list>
3562                                <t>"OK" -
3563                                    <list>
3564                                        <t>on success</t>
3565                                    </list>
3566                                </t>
3567                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3568                                    <list>
3569                                        <t>if MIDI controller was set, but there are noteworthy
3570                                        issue(s) related, providing an appropriate warning code and
3571                                        warning message</t>
3572                                    </list>
3573                                </t>
3574                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3575                                    <list>
3576                                        <t>in case it failed, providing an appropriate error code and error message</t>
3577                                    </list>
3578                                </t>
3579                            </list>
3580                        </t>
3581                        <t>Example:</t>
3582                        <t>
3583                            <list>
3584                                <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3585                                <t>S: "OK"</t>
3586                            </list>
3587                        </t>
3588                    </section>
3589    
3590                    <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3591                        <t>The front-end can alter the current send level of an effect
3592                        send entity by sending the following command:</t>
3593                        <t>
3594                            <list>
3595                                <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3596                            </list>
3597                        </t>
3598                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3599                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3600                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3601                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3602                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3603                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3604                        &lt;volume&gt; is an optionally dotted positive number (a value
3605                        smaller than 1.0 means attenuation, whereas a value greater than
3606                        1.0 means amplification) reflecting the new send level.</t>
3607    
3608                        <t>Possible Answers:</t>
3609                        <t>
3610                            <list>
3611                                <t>"OK" -
3612                                    <list>
3613                                        <t>on success</t>
3614                                    </list>
3615                                </t>
3616                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3617                                    <list>
3618                                        <t>if new send level was set, but there are noteworthy
3619                                        issue(s) related, providing an appropriate warning code and
3620                                        warning message</t>
3621                                    </list>
3622                                </t>
3623                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3624                                    <list>
3625                                        <t>in case it failed, providing an appropriate error code and error message</t>
3626                                    </list>
3627                                </t>
3628                            </list>
3629                        </t>
3630                        <t>Example:</t>
3631                        <t>
3632                            <list>
3633                                <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3634                                <t>S: "OK"</t>
3635                            </list>
3636                        </t>
3637                    </section>
3638    
3639                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3640                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>                      <t>The front-end can reset a particular sampler channel by sending the following command:</t>
# Line 4164  Schoenebeck'> Line 4275  Schoenebeck'>
4275                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4276                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4277                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
4278                      value < 1.0 means attenuation and a value > 1.0 means                      value &lt; 1.0 means attenuation and a value > 1.0 means
4279                      amplification). This parameter easily allows to adjust the                      amplification). This parameter easily allows to adjust the
4280                      volume of all intruments within a custom instrument map                      volume of all intruments within a custom instrument map
4281                      without having to adjust their instrument files. The                      without having to adjust their instrument files. The
# Line 4497  Schoenebeck'> Line 4608  Schoenebeck'>
4608                              <t>"VOLUME" -                              <t>"VOLUME" -
4609                                  <list>                                  <list>
4610                                      <t>master volume of the instrument as optionally                                      <t>master volume of the instrument as optionally
4611                                      dotted number (where a value < 1.0 means attenuation                                      dotted number (where a value &lt; 1.0 means attenuation
4612                                      and a value > 1.0 means amplification)</t>                                      and a value > 1.0 means amplification)</t>
4613                                  </list>                                  </list>
4614                              </t>                              </t>
# Line 4850  Schoenebeck'> Line 4961  Schoenebeck'>
4961                  </t>                  </t>
4962                  <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
4963                  </t>                  </t>
4964                    <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
4965                    </t>
4966                    <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
4967                    </t>
4968                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
4969                  </t>                  </t>
4970                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
Legend:
Removed from v.1005  
changed lines
  Added in v.1026
  ViewVC Help
Powered by ViewVC