/[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 973 by schoenebeck, Fri Dec 15 21:40:27 2006 UTC revision 1136 by iliev, Thu Mar 29 10:01:50 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="December" year="2006"/>          <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 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 3227  Schoenebeck'> Line 3227  Schoenebeck'>
3227                      </t>                      </t>
3228                  </section>                  </section>
3229    
3230                    <section title="Adding an effect send to a sampler channel" anchor="CREATE FX_SEND">
3231                        <t>The front-end can create an additional effect send on a specific sampler channel
3232                        by sending the following command:</t>
3233                        <t>
3234                            <list>
3235                                <t>CREATE FX_SEND &lt;sampler-channel&gt; &lt;midi-ctrl&gt; [&lt;name&gt;]</t>
3236                            </list>
3237                        </t>
3238                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3239                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3240                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3241                        sampler channel on which the effect send should be created on, &lt;midi-ctrl&gt;
3242                        is a number between 0..127 defining the MIDI controller which can alter the
3243                        effect send level and &lt;name&gt; is an optional argument defining a name
3244                        for the effect send entity. The name does not have to be unique.</t>
3245    
3246                        <t>By default, that is as initial routing, the effect send's audio channels
3247                        are automatically routed to the last audio channels of the sampler channel's
3248                        audio output device, that way you can i.e. first increase the amount of audio
3249                        channels on the audio output device for having dedicated effect send output
3250                        channels and when "CREATE FX_SEND" is called, those channels will automatically
3251                        be picked. You can alter the destination channels however with
3252                        <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>.
3253                        </t>
3254    
3255                        <t>Note: Create effect sends on a sampler channel only when needed, because having effect
3256                        sends on a sampler channel will decrease runtime performance, because for implementing channel
3257                        effect sends, separate (sampler channel local) audio buffers are needed to render and mix
3258                        the voices and route the audio signal afterwards to the master outputs and effect send
3259                        outputs (along with their respective effect send levels). A sampler channel without effect
3260                        sends however can mix its voices directly into the audio output devices's audio buffers
3261                        and is thus faster.
3262                        </t>
3263    
3264                        <t>Possible Answers:</t>
3265                        <t>
3266                            <list>
3267                                <t>"OK[&lt;fx-send-id&gt;]" -
3268                                    <list>
3269                                        <t>in case a new effect send could be added to the
3270                                        sampler channel, where &lt;fx-send-id&gt; reflects the
3271                                        unique ID of the newly created effect send entity</t>
3272                                    </list>
3273                                </t>
3274                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3275                                    <list>
3276                                        <t>when a new effect send could not be added, i.e.
3277                                        due to invalid parameters</t>
3278                                    </list>
3279                                </t>
3280                            </list>
3281                        </t>
3282    
3283                        <t>Examples:</t>
3284                        <t>
3285                            <list>
3286                                <t>C: "CREATE FX_SEND 0 91 'Reverb Send'"</t>
3287                                <t>S: "OK[0]"</t>
3288                            </list>
3289                        </t>
3290                        <t>
3291                            <list>
3292                                <t>C: "CREATE FX_SEND 0 93"</t>
3293                                <t>S: "OK[1]"</t>
3294                            </list>
3295                        </t>
3296                    </section>
3297    
3298                    <section title="Removing an effect send from a sampler channel" anchor="DESTROY FX_SEND">
3299                        <t>The front-end can remove an existing effect send on a specific sampler channel
3300                        by sending the following command:</t>
3301                        <t>
3302                            <list>
3303                                <t>DESTROY FX_SEND &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3304                            </list>
3305                        </t>
3306                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3307                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3308                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command, that is the
3309                        sampler channel from which the effect send should be removed from and
3310                        &lt;fx-send-id&gt; is the respective effect send number as returned by the
3311                        <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3312                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.</t>
3313    
3314                        <t>Possible Answers:</t>
3315                        <t>
3316                            <list>
3317                                <t>"OK" -
3318                                    <list>
3319                                        <t>on success</t>
3320                                    </list>
3321                                </t>
3322                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3323                                    <list>
3324                                        <t>in case it failed, providing an appropriate error code and
3325                                        error message</t>
3326                                    </list>
3327                                </t>
3328                            </list>
3329                        </t>
3330    
3331                        <t>Example:</t>
3332                        <t>
3333                            <list>
3334                                <t>C: "DESTROY FX_SEND 0 0"</t>
3335                                <t>S: "OK"</t>
3336                            </list>
3337                        </t>
3338                    </section>
3339    
3340                    <section title="Getting amount of effect sends on a sampler channel" anchor="GET FX_SENDS">
3341                        <t>The front-end can ask for the amount of effect sends on a specific sampler channel
3342                        by sending the following command:</t>
3343                        <t>
3344                            <list>
3345                                <t>GET FX_SENDS &lt;sampler-channel&gt;</t>
3346                            </list>
3347                        </t>
3348                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3349                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3350                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3351    
3352                        <t>Possible Answers:</t>
3353                        <t>
3354                            <list>
3355                                <t>The sampler will answer by returning the number of effect
3356                                sends on the given sampler channel.</t>
3357                            </list>
3358                        </t>
3359    
3360                        <t>Example:</t>
3361                        <t>
3362                            <list>
3363                                <t>C: "GET FX_SENDS 0"</t>
3364                                <t>S: "2"</t>
3365                            </list>
3366                        </t>
3367                    </section>
3368    
3369                    <section title="Listing all effect sends on a sampler channel" anchor="LIST FX_SENDS">
3370                        <t>The front-end can ask for a list of effect sends on a specific sampler channel
3371                        by sending the following command:</t>
3372                        <t>
3373                            <list>
3374                                <t>LIST FX_SENDS &lt;sampler-channel&gt;</t>
3375                            </list>
3376                        </t>
3377                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3378                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3379                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command.</t>
3380    
3381                        <t>Possible Answers:</t>
3382                        <t>
3383                            <list>
3384                                <t>The sampler will answer by returning a comma separated list
3385                                with all effect sends' numerical IDs on the given sampler
3386                                channel.</t>
3387                            </list>
3388                        </t>
3389    
3390                        <t>Examples:</t>
3391                        <t>
3392                            <list>
3393                                <t>C: "LIST FX_SENDS 0"</t>
3394                                <t>S: "0,1"</t>
3395                            </list>
3396                        </t>
3397                        <t>
3398                            <list>
3399                                <t>C: "LIST FX_SENDS 1"</t>
3400                                <t>S: ""</t>
3401                            </list>
3402                        </t>
3403                    </section>
3404    
3405                    <section title="Getting effect send information" anchor="GET FX_SEND INFO">
3406                        <t>The front-end can ask for the current settings of an effect send entity
3407                        by sending the following command:</t>
3408                        <t>
3409                            <list>
3410                                <t>GET FX_SEND INFO &lt;sampler-channel&gt; &lt;fx-send-id&gt;</t>
3411                            </list>
3412                        </t>
3413                        <t>Where &lt;sampler-channel&gt; is the sampler channel number
3414                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3415                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3416                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3417                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3418                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command.
3419                       </t>
3420    
3421                        <t>Possible Answers:</t>
3422                        <t>
3423                            <list>
3424                                <t>The sampler will answer by sending a &lt;CRLF&gt; separated list.
3425                                Each answer line begins with the settings category name
3426                                followed by a colon and then a space character &lt;SP&gt; and finally
3427                                the info character string to that setting category. At the
3428                                moment the following categories are defined:</t>
3429    
3430                                <t>
3431                                    <list>
3432                                        <t>NAME -
3433                                            <list>
3434                                                <t>name of the effect send entity</t>
3435                                            </list>
3436                                        </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 -
3451                                            <list>
3452                                                <t>comma separated list which reflects to which audio
3453                                                channel of the selected audio output device each
3454                                                effect send output channel is routed to, e.g. "0,3" would
3455                                                mean the effect send's output channel 0 is routed to channel
3456                                                0 of the audio output device and the effect send's output
3457                                                channel 1 is routed to the channel 3 of the audio
3458                                                output device (see
3459                                                <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3460                                                for details)</t>
3461                                            </list>
3462                                        </t>
3463                                    </list>
3464                                </t>
3465                            </list>
3466                        </t>
3467                        <t>The mentioned fields above don't have to be in particular order.</t>
3468    
3469                        <t>Example:</t>
3470                        <t>
3471                            <list>
3472                                <t>C: "GET FX_SEND INFO 0 0"</t>
3473                                <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>
3477                                <t>&nbsp;&nbsp;&nbsp;"."</t>
3478                            </list>
3479                        </t>
3480                    </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">
3524                        <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>
3526                        <t>
3527                            <list>
3528                                <t>SET FX_SEND AUDIO_OUTPUT_CHANNEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;audio-src&gt; &lt;audio-dst&gt;</t>
3529                            </list>
3530                        </t>
3531                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3532                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3533                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3534                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3535                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3536                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3537                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3538                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3539                        the audio channel of the selected audio output device where &lt;audio-src&gt;
3540                        should be routed to.</t>
3541    
3542                        <t>Note that effect sends can only route audio to the same audio output
3543                        device as assigned to the effect send's sampler channel. Also note that an
3544                        effect send entity does always have exactly as much audio channels as its
3545                        sampler channel. So if the sampler channel is stereo, the effect send does
3546                        have two audio channels as well. Also keep in mind that the amount of audio
3547                        channels on a sampler channel might be dependant not only to the deployed
3548                        sampler engine on the sampler channel, but also dependant to the instrument
3549                        currently loaded. However you can (effectively) turn an i.e. stereo effect
3550                        send into a mono one by simply altering its audio routing appropriately.</t>
3551    
3552                        <t>Possible Answers:</t>
3553                        <t>
3554                            <list>
3555                                <t>"OK" -
3556                                    <list>
3557                                        <t>on success</t>
3558                                    </list>
3559                                </t>
3560                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3561                                    <list>
3562                                        <t>if audio output channel was set, but there are noteworthy
3563                                        issue(s) related, providing an appropriate warning code and
3564                                        warning message</t>
3565                                    </list>
3566                                </t>
3567                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3568                                    <list>
3569                                        <t>in case it failed, providing an appropriate error code and error message</t>
3570                                    </list>
3571                                </t>
3572                            </list>
3573                        </t>
3574                        <t>Example:</t>
3575                        <t>
3576                            <list>
3577                                <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3578                                <t>S: "OK"</t>
3579                            </list>
3580                        </t>
3581                    </section>
3582    
3583                    <section title="Altering effect send's MIDI controller" anchor="SET FX_SEND MIDI_CONTROLLER">
3584                        <t>The front-end can alter the MIDI controller of an effect
3585                        send entity by sending the following command:</t>
3586                        <t>
3587                            <list>
3588                                <t>SET FX_SEND MIDI_CONTROLLER &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;midi-ctrl&gt;</t>
3589                            </list>
3590                        </t>
3591                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3592                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3593                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3594                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3595                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3596                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3597                        &lt;midi-ctrl&gt; reflects the MIDI controller which shall be
3598                        able to modify the effect send's send level.</t>
3599    
3600                        <t>Possible Answers:</t>
3601                        <t>
3602                            <list>
3603                                <t>"OK" -
3604                                    <list>
3605                                        <t>on success</t>
3606                                    </list>
3607                                </t>
3608                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3609                                    <list>
3610                                        <t>if MIDI controller was set, but there are noteworthy
3611                                        issue(s) related, providing an appropriate warning code and
3612                                        warning message</t>
3613                                    </list>
3614                                </t>
3615                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3616                                    <list>
3617                                        <t>in case it failed, providing an appropriate error code and error message</t>
3618                                    </list>
3619                                </t>
3620                            </list>
3621                        </t>
3622                        <t>Example:</t>
3623                        <t>
3624                            <list>
3625                                <t>C: "SET FX_SEND MIDI_CONTROLLER 0 0 91"</t>
3626                                <t>S: "OK"</t>
3627                            </list>
3628                        </t>
3629                    </section>
3630    
3631                    <section title="Altering effect send's send level" anchor="SET FX_SEND LEVEL">
3632                        <t>The front-end can alter the current send level of an effect
3633                        send entity by sending the following command:</t>
3634                        <t>
3635                            <list>
3636                                <t>SET FX_SEND LEVEL &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;volume&gt;</t>
3637                            </list>
3638                        </t>
3639                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3640                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3641                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3642                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3643                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3644                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3645                        &lt;volume&gt; is an optionally dotted positive number (a value
3646                        smaller than 1.0 means attenuation, whereas a value greater than
3647                        1.0 means amplification) reflecting the new send level.</t>
3648    
3649                        <t>Possible Answers:</t>
3650                        <t>
3651                            <list>
3652                                <t>"OK" -
3653                                    <list>
3654                                        <t>on success</t>
3655                                    </list>
3656                                </t>
3657                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3658                                    <list>
3659                                        <t>if new send level was set, but there are noteworthy
3660                                        issue(s) related, providing an appropriate warning code and
3661                                        warning message</t>
3662                                    </list>
3663                                </t>
3664                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3665                                    <list>
3666                                        <t>in case it failed, providing an appropriate error code and error message</t>
3667                                    </list>
3668                                </t>
3669                            </list>
3670                        </t>
3671                        <t>Example:</t>
3672                        <t>
3673                            <list>
3674                                <t>C: "SET FX_SEND LEVEL 0 0 0.15"</t>
3675                                <t>S: "OK"</t>
3676                            </list>
3677                        </t>
3678                    </section>
3679    
3680                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3681                      <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>
3682                      <t>                      <t>
# Line 3516  Schoenebeck'> Line 3966  Schoenebeck'>
3966                      <t>The mentioned fields above don't have to be in particular order.                      <t>The mentioned fields above don't have to be in particular order.
3967                      Other fields might be added in future.</t>                      Other fields might be added in future.</t>
3968                  </section>                  </section>
3969    
3970                    <section title="Getting global volume attenuation" anchor="GET VOLUME">
3971                        <t>The client can ask for the current global sampler-wide volume
3972                        attenuation by sending the following command:</t>
3973                        <t>
3974                            <list>
3975                                <t>GET VOLUME</t>
3976                            </list>
3977                        </t>
3978                        <t>Possible Answers:</t>
3979                        <t>
3980                            <list>
3981                                <t>The sampler will always answer by returning the optional
3982                                dotted floating point coefficient, reflecting the current
3983                                global volume attenuation.
3984                                </t>
3985                            </list>
3986                        </t>
3987                        <t>Note: it is up to the respective sampler engine whether to obey
3988                        that global volume parameter or not, but in general all engines SHOULD
3989                        use this parameter.</t>
3990                    </section>
3991    
3992                    <section title="Setting global volume attenuation" anchor="SET VOLUME">
3993                        <t>The client can alter the current global sampler-wide volume
3994                        attenuation by sending the following command:</t>
3995                        <t>
3996                            <list>
3997                                <t>SET VOLUME &lt;volume&gt;</t>
3998                            </list>
3999                        </t>
4000                       <t>Where &lt;volume&gt; should be replaced by the optional dotted
4001                       floating point value, reflecting the new global volume parameter.
4002                       This value might usually be in the range between 0.0 and 1.0, that
4003                       is for attenuating the overall volume.</t>
4004    
4005                        <t>Possible Answers:</t>
4006                        <t>
4007                            <list>
4008                                <t>"OK" -
4009                                    <list>
4010                                        <t>on success</t>
4011                                    </list>
4012                                </t>
4013                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4014                                    <list>
4015                                        <t>if the global volume was set, but there are noteworthy
4016                                        issue(s) related, providing an appropriate warning code and
4017                                        warning message</t>
4018                                    </list>
4019                                </t>
4020                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4021                                    <list>
4022                                        <t>in case it failed, providing an appropriate error code and error message</t>
4023                                    </list>
4024                                </t>
4025                            </list>
4026                        </t>
4027                    </section>
4028              </section>              </section>
4029    
4030    
# Line 3730  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 3741  Schoenebeck'> Line 4256  Schoenebeck'>
4256                          <list>                          <list>
4257                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4258                              <t>S: "NAME: Standard Map"</t>                              <t>S: "NAME: Standard Map"</t>
4259                                <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4260                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
4261                          </list>                          </list>
4262                      </t>                      </t>
# Line 3789  Schoenebeck'> Line 4305  Schoenebeck'>
4305                      command:</t>                      command:</t>
4306                      <t>                      <t>
4307                          <list>                          <list>
4308                              <t>MAP MIDI_INSTRUMENT &lt;map&gt;                              <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4309                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4310                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4311                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
# Line 3807  Schoenebeck'> Line 4323  Schoenebeck'>
4323                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4324                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4325                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
4326                      value < 1.0 means attenuation and a value > 1.0 means                      value &lt; 1.0 means attenuation and a value > 1.0 means
4327                      amplification). This parameter easily allows to adjust the                      amplification). This parameter easily allows to adjust the
4328                      volume of all intruments within a custom instrument map                      volume of all intruments within a custom instrument map
4329                      without having to adjust their instrument files. The                      without having to adjust their instrument files. The
# Line 3842  Schoenebeck'> Line 4358  Schoenebeck'>
4358                              <t>"PERSISTENT" -                              <t>"PERSISTENT" -
4359                                  <list>                                  <list>
4360                                      <t>The instrument will immediately be loaded                                      <t>The instrument will immediately be loaded
4361                                      into memory in the background when this mapping                                      into memory when this mapping
4362                                      command is sent and the instrument is kept all                                      command is sent and the instrument is kept all
4363                                      the time. Instruments with this mode are                                      the time. Instruments with this mode are
4364                                      only freed when the sampler is reset or all                                      only freed when the sampler is reset or all
# Line 3892  Schoenebeck'> Line 4408  Schoenebeck'>
4408                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4409                      </t>                      </t>
4410                      <t>                      <t>
4411                      The "MAP MIDI_INSTRUMENT" command                      By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4412                      will immediately return, thus it will not block when an                      completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4413                      instrument is to be loaded due to a "PERSISTENT" type                      however causes the respective "MAP MIDI_INSTRUMENT" command to return
4414                      entry as instruments are loaded in the background. As a                      immediately, that is to let the sampler establish the mapping in the
4415                      consequence this command may not necessarily return an error                      background. So this argument might be especially useful for mappings with
4416                      i.e. when the given instrument file does not exist or may                      a "PERSISTENT" type, because these have to load the respective instruments
4417                      turn out to be corrupt.                      immediately and might thus block for a very long time. It is recommended
4418                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4419                        because it has the following drawbacks: as "NON_MODAL" instructions return
4420                        immediately, they may not necessarily return an error i.e. when the given
4421                        instrument file turns out to be corrupt, beside that subsequent commands
4422                        in a LSCP instruction sequence might fail, because mandatory mappings are
4423                        not yet completed.
4424                      </t>                      </t>
4425    
4426                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 3941  Schoenebeck'> Line 4463  Schoenebeck'>
4463                      </t>                      </t>
4464                      <t>                      <t>
4465                          <list>                          <list>
4466                              <t>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>                              <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4467                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4468                          </list>                          </list>
4469                      </t>                      </t>
# Line 4140  Schoenebeck'> Line 4662  Schoenebeck'>
4662                              <t>"VOLUME" -                              <t>"VOLUME" -
4663                                  <list>                                  <list>
4664                                      <t>master volume of the instrument as optionally                                      <t>master volume of the instrument as optionally
4665                                      dotted number (where a value < 1.0 means attenuation                                      dotted number (where a value &lt; 1.0 means attenuation
4666                                      and a value > 1.0 means amplification)</t>                                      and a value > 1.0 means amplification)</t>
4667                                  </list>                                  </list>
4668                              </t>                              </t>
# Line 4311  Schoenebeck'> Line 4833  Schoenebeck'>
4833  </t>  </t>
4834  <t>subscribe_event =  <t>subscribe_event =
4835          <list>          <list>
4836                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4837                    </t>
4838                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4839                    </t>
4840                    <t>/ MIDI_INPUT_DEVICE_COUNT
4841                    </t>
4842                    <t>/ MIDI_INPUT_DEVICE_INFO
4843                    </t>
4844                    <t>/ CHANNEL_COUNT
4845                  </t>                  </t>
4846                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4847                  </t>                  </t>
# Line 4321  Schoenebeck'> Line 4851  Schoenebeck'>
4851                  </t>                  </t>
4852                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4853                  </t>                  </t>
4854                    <t>/ FX_SEND_COUNT
4855                    </t>
4856                    <t>/ FX_SEND_INFO
4857                    </t>
4858                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4859                    </t>
4860                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4861                    </t>
4862                    <t>/ MIDI_INSTRUMENT_COUNT
4863                    </t>
4864                    <t>/ MIDI_INSTRUMENT_INFO
4865                    </t>
4866                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4867                  </t>                  </t>
4868                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4869                  </t>                  </t>
4870                    <t>/ GLOBAL_INFO
4871                    </t>
4872          </list>          </list>
4873  </t>  </t>
4874  <t>unsubscribe_event =  <t>unsubscribe_event =
4875          <list>          <list>
4876                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4877                    </t>
4878                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4879                    </t>
4880                    <t>/ MIDI_INPUT_DEVICE_COUNT
4881                    </t>
4882                    <t>/ MIDI_INPUT_DEVICE_INFO
4883                    </t>
4884                    <t>/ CHANNEL_COUNT
4885                  </t>                  </t>
4886                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4887                  </t>                  </t>
# Line 4339  Schoenebeck'> Line 4891  Schoenebeck'>
4891                  </t>                  </t>
4892                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4893                  </t>                  </t>
4894                    <t>/ FX_SEND_COUNT
4895                    </t>
4896                    <t>/ FX_SEND_INFO
4897                    </t>
4898                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4899                    </t>
4900                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4901                    </t>
4902                    <t>/ MIDI_INSTRUMENT_COUNT
4903                    </t>
4904                    <t>/ MIDI_INSTRUMENT_INFO
4905                    </t>
4906                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4907                  </t>                  </t>
4908                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
4909                  </t>                  </t>
4910                    <t>/ GLOBAL_INFO
4911                    </t>
4912          </list>          </list>
4913  </t>  </t>
4914  <t>map_instruction =  <t>map_instruction =
4915          <list>          <list>
4916                  <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value                  <t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
4917                  </t>                  </t>
4918                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
4919                  </t>                  </t>
4920                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
4921                  </t>                  </t>
4922                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
4923                  </t>                  </t>
4924          </list>          </list>
4925  </t>  </t>
# Line 4437  Schoenebeck'> Line 5003  Schoenebeck'>
5003                  </t>                  </t>
5004                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
5005                  </t>                  </t>
5006                    <t>/ FX_SENDS SP sampler_channel
5007                    </t>
5008                    <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
5009                    </t>
5010                    <t>/ VOLUME
5011                    </t>
5012          </list>          </list>
5013  </t>  </t>
5014  <t>set_instruction =  <t>set_instruction =
# Line 4453  Schoenebeck'> Line 5025  Schoenebeck'>
5025                  </t>                  </t>
5026                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5027                  </t>                  </t>
5028                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5029                    </t>
5030                    <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
5031                    </t>
5032                    <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
5033                    </t>
5034                    <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
5035                    </t>
5036                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
5037                  </t>                  </t>
5038                    <t>/ VOLUME SP volume_value
5039                    </t>
5040          </list>          </list>
5041  </t>  </t>
5042  <t>create_instruction =  <t>create_instruction =
# Line 4467  Schoenebeck'> Line 5049  Schoenebeck'>
5049                  </t>                  </t>
5050                  <t>/ MIDI_INPUT_DEVICE SP string                  <t>/ MIDI_INPUT_DEVICE SP string
5051                  </t>                  </t>
5052                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl
5053                    </t>
5054                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
5055                    </t>
5056          </list>          </list>
5057  </t>  </t>
5058  <t>reset_instruction =  <t>reset_instruction =
# Line 4489  Schoenebeck'> Line 5075  Schoenebeck'>
5075                  </t>                  </t>
5076                  <t>/ MIDI_INPUT_DEVICE SP number                  <t>/ MIDI_INPUT_DEVICE SP number
5077                  </t>                  </t>
5078                    <t>/ FX_SEND SP sampler_channel SP fx_send_id
5079                    </t>
5080          </list>          </list>
5081  </t>  </t>
5082  <t>load_instruction =  <t>load_instruction =
# Line 4531  Schoenebeck'> Line 5119  Schoenebeck'>
5119                  </t>                  </t>
5120          </list>          </list>
5121  </t>  </t>
5122    <t>modal_arg =
5123            <list>
5124                    <t>/* epsilon (empty argument) */
5125                    </t>
5126                    <t>/ NON_MODAL SP
5127                    </t>
5128            </list>
5129    </t>
5130  <t>key_val_list =  <t>key_val_list =
5131          <list>          <list>
5132                  <t>string '=' param_val_list                  <t>string '=' param_val_list
# Line 4567  Schoenebeck'> Line 5163  Schoenebeck'>
5163                  </t>                  </t>
5164                  <t>/ MIDI_INSTRUMENT_MAPS                  <t>/ MIDI_INSTRUMENT_MAPS
5165                  </t>                  </t>
5166                    <t>/ FX_SENDS SP sampler_channel
5167                    </t>
5168          </list>          </list>
5169  </t>  </t>
5170  <t>load_instr_args =  <t>load_instr_args =
# Line 4649  Schoenebeck'> Line 5247  Schoenebeck'>
5247                  </t>                  </t>
5248          </list>          </list>
5249  </t>  </t>
5250    <t>midi_ctrl =
5251            <list>
5252                    <t>number
5253                    </t>
5254            </list>
5255    </t>
5256  <t>volume_value =  <t>volume_value =
5257          <list>          <list>
5258                  <t>dotnum                  <t>dotnum
# Line 4669  Schoenebeck'> Line 5273  Schoenebeck'>
5273                  </t>                  </t>
5274          </list>          </list>
5275  </t>  </t>
5276    <t>fx_send_id =
5277            <list>
5278                    <t>number
5279                    </t>
5280            </list>
5281    </t>
5282  <t>engine_name =  <t>engine_name =
5283          <list>          <list>
5284                  <t>string                  <t>string
# Line 4693  Schoenebeck'> Line 5303  Schoenebeck'>
5303                  </t>                  </t>
5304          </list>          </list>
5305  </t>  </t>
5306    <t>fx_send_name =
5307            <list>
5308                    <t>stringval
5309                    </t>
5310            </list>
5311    </t>
5312  <t>param_val_list =  <t>param_val_list =
5313          <list>          <list>
5314                  <t>param_val                  <t>param_val
# Line 4720  Schoenebeck'> Line 5336  Schoenebeck'>
5336          <section title="Events" anchor="events">          <section title="Events" anchor="events">
5337              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
5338    
5339              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
5340                    <t>Client may want to be notified when the total number of audio output devices on the
5341                    back-end changes by issuing the following command:</t>
5342                    <t>
5343                        <list>
5344                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
5345                        </list>
5346                    </t>
5347                    <t>Server will start sending the following notification messages:</t>
5348                    <t>
5349                        <list>
5350                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
5351                        </list>
5352                    </t>
5353                    <t>where &lt;devices&gt; will be replaced by the new number
5354                    of audio output devices.</t>
5355                </section>
5356    
5357                <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
5358                    <t>Client may want to be notified when changes were made to audio output devices on the
5359                    back-end by issuing the following command:</t>
5360                    <t>
5361                        <list>
5362                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
5363                        </list>
5364                    </t>
5365                    <t>Server will start sending the following notification messages:</t>
5366                    <t>
5367                        <list>
5368                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
5369                        </list>
5370                    </t>
5371                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
5372                    which settings has been changed. The front-end will have to send
5373                    the respective command to actually get the audio output device info. Because these messages
5374                    will be triggered by LSCP commands issued by other clients rather than real
5375                    time events happening on the server, it is believed that an empty notification
5376                    message is sufficient here.</t>
5377                </section>
5378    
5379                <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
5380                    <t>Client may want to be notified when the total number of MIDI input devices on the
5381                    back-end changes by issuing the following command:</t>
5382                    <t>
5383                        <list>
5384                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
5385                        </list>
5386                    </t>
5387                    <t>Server will start sending the following notification messages:</t>
5388                    <t>
5389                        <list>
5390                            <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
5391                        </list>
5392                    </t>
5393                    <t>where &lt;devices&gt; will be replaced by the new number
5394                    of MIDI input devices.</t>
5395                </section>
5396    
5397                <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
5398                    <t>Client may want to be notified when changes were made to MIDI input devices on the
5399                    back-end by issuing the following command:</t>
5400                    <t>
5401                        <list>
5402                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
5403                        </list>
5404                    </t>
5405                    <t>Server will start sending the following notification messages:</t>
5406                    <t>
5407                        <list>
5408                            <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
5409                        </list>
5410                    </t>
5411                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
5412                    which settings has been changed. The front-end will have to send
5413                    the respective command to actually get the MIDI input device info. Because these messages
5414                    will be triggered by LSCP commands issued by other clients rather than real
5415                    time events happening on the server, it is believed that an empty notification
5416                    message is sufficient here.</t>
5417                </section>
5418    
5419                <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
5420                  <t>Client may want to be notified when the total number of channels on the                  <t>Client may want to be notified when the total number of channels on the
5421                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
5422                  <t>                  <t>
# Line 4749  Schoenebeck'> Line 5445  Schoenebeck'>
5445                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5446                  <t>                  <t>
5447                      <list>                      <list>
5448                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
5449                      </list>                      </list>
5450                  </t>                  </t>
5451                  <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 4797  Schoenebeck'> Line 5493  Schoenebeck'>
5493                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
5494              </section>              </section>
5495    
5496              <section title="Channel information changed" anchor="SUBSCRIBE INFO">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
5497                  <t>Client may want to be notified when changes were made to sampler channels on the                  <t>Client may want to be notified when changes were made to sampler channels on the
5498                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
5499                  <t>                  <t>
# Line 4819  Schoenebeck'> Line 5515  Schoenebeck'>
5515                  message is sufficient here.</t>                  message is sufficient here.</t>
5516              </section>              </section>
5517    
5518                <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
5519                    <t>Client may want to be notified when the number of effect sends on
5520                    a particular sampler channel is changed by issuing the following command:</t>
5521                    <t>
5522                        <list>
5523                            <t>SUBSCRIBE FX_SEND_COUNT</t>
5524                        </list>
5525                    </t>
5526                    <t>Server will start sending the following notification messages:</t>
5527                    <t>
5528                        <list>
5529                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
5530                        </list>
5531                    </t>
5532                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5533                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
5534                    be replaced by the new number of effect sends on that channel.</t>
5535                </section>
5536    
5537                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
5538                    <t>Client may want to be notified when changes were made to effect sends on a
5539                    a particular sampler channel by issuing the following command:</t>
5540                    <t>
5541                        <list>
5542                            <t>SUBSCRIBE FX_SEND_INFO</t>
5543                        </list>
5544                    </t>
5545                    <t>Server will start sending the following notification messages:</t>
5546                    <t>
5547                        <list>
5548                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
5549                        </list>
5550                    </t>
5551                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
5552                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
5553                    be replaced by the numerical ID of the changed effect send.</t>
5554                </section>
5555    
5556              <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">
5557                  <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
5558                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 4830  Schoenebeck'> Line 5564  Schoenebeck'>
5564                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
5565                  <t>                  <t>
5566                      <list>                      <list>
5567                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
5568                      </list>                      </list>
5569                  </t>                  </t>
5570                  <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
5571                  all currently active voices.</t>                  all currently active voices.</t>
5572              </section>              </section>
5573    
5574                <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
5575                    <t>Client may want to be notified when the number of MIDI instrument maps on the
5576                    back-end changes by issuing the following command:</t>
5577                    <t>
5578                        <list>
5579                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
5580                        </list>
5581                    </t>
5582                    <t>Server will start sending the following notification messages:</t>
5583                    <t>
5584                        <list>
5585                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
5586                        </list>
5587                    </t>
5588                    <t>where &lt;maps&gt; will be replaced by the new number
5589                    of MIDI instrument maps.</t>
5590                </section>
5591    
5592                <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
5593                    <t>Client may want to be notified when changes were made to MIDI instrument maps on the
5594                    back-end by issuing the following command:</t>
5595                    <t>
5596                        <list>
5597                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
5598                        </list>
5599                    </t>
5600                    <t>Server will start sending the following notification messages:</t>
5601                    <t>
5602                        <list>
5603                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
5604                        </list>
5605                    </t>
5606                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5607                    for which information changes occurred. The front-end will have to send
5608                    the respective command to actually get the MIDI instrument map info. Because these messages
5609                    will be triggered by LSCP commands issued by other clients rather than real
5610                    time events happening on the server, it is believed that an empty notification
5611                    message is sufficient here.</t>
5612                </section>
5613    
5614                <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
5615                    <t>Client may want to be notified when the number of MIDI instrument maps on the
5616                    back-end changes by issuing the following command:</t>
5617                    <t>
5618                        <list>
5619                            <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
5620                        </list>
5621                    </t>
5622                    <t>Server will start sending the following notification messages:</t>
5623                    <t>
5624                        <list>
5625                            <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
5626                        </list>
5627                    </t>
5628                    <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
5629                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
5630                    the new number of MIDI instruments in the specified map.</t>
5631                </section>
5632    
5633                <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
5634                    <t>Client may want to be notified when changes were made to MIDI instruments on the
5635                    back-end by issuing the following command:</t>
5636                    <t>
5637                        <list>
5638                            <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
5639                        </list>
5640                    </t>
5641                    <t>Server will start sending the following notification messages:</t>
5642                    <t>
5643                        <list>
5644                            <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
5645                        </list>
5646                    </t>
5647                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5648                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
5649                    the location of the changed MIDI instrument in the map. The front-end will have to send
5650                    the respective command to actually get the MIDI instrument info. Because these messages
5651                    will be triggered by LSCP commands issued by other clients rather than real
5652                    time events happening on the server, it is believed that an empty notification
5653                    message is sufficient here.</t>
5654                </section>
5655    
5656                <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
5657                    <t>Client may want to be notified when changes to the global settings
5658                    of the sampler were made by issuing the following command:</t>
5659                    <t>
5660                        <list>
5661                            <t>SUBSCRIBE GLOBAL_INFO</t>
5662                        </list>
5663                    </t>
5664                    <t>Server will start sending the following types of notification messages:</t>
5665                    <t>
5666                        <list>
5667                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
5668                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
5669                            replaced by the optional dotted floating point value, reflecting the
5670                            new global volume parameter.</t>
5671                        </list>
5672                    </t>
5673                </section>
5674    
5675              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
5676                  <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
5677                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.973  
changed lines
  Added in v.1136
  ViewVC Help
Powered by ViewVC