/[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 984 by iliev, Mon Dec 18 10:28:00 2006 UTC revision 1187 by iliev, Wed May 16 14:22:26 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="April" 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 3509  Schoenebeck'> Line 3959  Schoenebeck'>
3959                                              complies with (see <xref target="LSCP versioning" /> for details)</t>                                              complies with (see <xref target="LSCP versioning" /> for details)</t>
3960                                          </list>                                          </list>
3961                                      </t>                                      </t>
3962                                        <t>INSTRUMENTS_DB_SUPPORT -
3963                                            <list>
3964                                                <t>either yes or no, specifies whether the
3965                                                sampler is build with instruments database support.</t>
3966                                            </list>
3967                                        </t>
3968                                  </list>                                  </list>
3969                              </t>                              </t>
3970                          </list>                          </list>
# Line 3516  Schoenebeck'> Line 3972  Schoenebeck'>
3972                      <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.
3973                      Other fields might be added in future.</t>                      Other fields might be added in future.</t>
3974                  </section>                  </section>
3975    
3976                    <section title="Getting global volume attenuation" anchor="GET VOLUME">
3977                        <t>The client can ask for the current global sampler-wide volume
3978                        attenuation by sending the following command:</t>
3979                        <t>
3980                            <list>
3981                                <t>GET VOLUME</t>
3982                            </list>
3983                        </t>
3984                        <t>Possible Answers:</t>
3985                        <t>
3986                            <list>
3987                                <t>The sampler will always answer by returning the optional
3988                                dotted floating point coefficient, reflecting the current
3989                                global volume attenuation.
3990                                </t>
3991                            </list>
3992                        </t>
3993                        <t>Note: it is up to the respective sampler engine whether to obey
3994                        that global volume parameter or not, but in general all engines SHOULD
3995                        use this parameter.</t>
3996                    </section>
3997    
3998                    <section title="Setting global volume attenuation" anchor="SET VOLUME">
3999                        <t>The client can alter the current global sampler-wide volume
4000                        attenuation by sending the following command:</t>
4001                        <t>
4002                            <list>
4003                                <t>SET VOLUME &lt;volume&gt;</t>
4004                            </list>
4005                        </t>
4006                       <t>Where &lt;volume&gt; should be replaced by the optional dotted
4007                       floating point value, reflecting the new global volume parameter.
4008                       This value might usually be in the range between 0.0 and 1.0, that
4009                       is for attenuating the overall volume.</t>
4010    
4011                        <t>Possible Answers:</t>
4012                        <t>
4013                            <list>
4014                                <t>"OK" -
4015                                    <list>
4016                                        <t>on success</t>
4017                                    </list>
4018                                </t>
4019                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
4020                                    <list>
4021                                        <t>if the global volume was set, but there are noteworthy
4022                                        issue(s) related, providing an appropriate warning code and
4023                                        warning message</t>
4024                                    </list>
4025                                </t>
4026                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4027                                    <list>
4028                                        <t>in case it failed, providing an appropriate error code and error message</t>
4029                                    </list>
4030                                </t>
4031                            </list>
4032                        </t>
4033                    </section>
4034              </section>              </section>
4035    
4036    
# Line 3730  Schoenebeck'> Line 4245  Schoenebeck'>
4245                                              which does not have to be unique</t>                                              which does not have to be unique</t>
4246                                          </list>                                          </list>
4247                                      </t>                                      </t>
4248                                        <t>DEFAULT -
4249                                            <list>
4250                                                <t>either true or false,
4251                                                defines whether this map is the default map</t>
4252                                            </list>
4253                                        </t>
4254                                  </list>                                  </list>
4255                              </t>                              </t>
4256                          </list>                          </list>
# Line 3741  Schoenebeck'> Line 4262  Schoenebeck'>
4262                          <list>                          <list>
4263                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4264                              <t>S: "NAME: Standard Map"</t>                              <t>S: "NAME: Standard Map"</t>
4265                                <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4266                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
4267                          </list>                          </list>
4268                      </t>                      </t>
# Line 3789  Schoenebeck'> Line 4311  Schoenebeck'>
4311                      command:</t>                      command:</t>
4312                      <t>                      <t>
4313                          <list>                          <list>
4314                              <t>MAP MIDI_INSTRUMENT &lt;map&gt;                              <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4315                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4316                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4317                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
# Line 3807  Schoenebeck'> Line 4329  Schoenebeck'>
4329                      &lt;instrument_index&gt; the index (integer value) of the instrument                      &lt;instrument_index&gt; the index (integer value) of the instrument
4330                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4331                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
4332                      value < 1.0 means attenuation and a value > 1.0 means                      value &lt; 1.0 means attenuation and a value > 1.0 means
4333                      amplification). This parameter easily allows to adjust the                      amplification). This parameter easily allows to adjust the
4334                      volume of all intruments within a custom instrument map                      volume of all intruments within a custom instrument map
4335                      without having to adjust their instrument files. The                      without having to adjust their instrument files. The
# Line 3842  Schoenebeck'> Line 4364  Schoenebeck'>
4364                              <t>"PERSISTENT" -                              <t>"PERSISTENT" -
4365                                  <list>                                  <list>
4366                                      <t>The instrument will immediately be loaded                                      <t>The instrument will immediately be loaded
4367                                      into memory in the background when this mapping                                      into memory when this mapping
4368                                      command is sent and the instrument is kept all                                      command is sent and the instrument is kept all
4369                                      the time. Instruments with this mode are                                      the time. Instruments with this mode are
4370                                      only freed when the sampler is reset or all                                      only freed when the sampler is reset or all
# Line 3892  Schoenebeck'> Line 4414  Schoenebeck'>
4414                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4415                      </t>                      </t>
4416                      <t>                      <t>
4417                      The "MAP MIDI_INSTRUMENT" command                      By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4418                      will immediately return, thus it will not block when an                      completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4419                      instrument is to be loaded due to a "PERSISTENT" type                      however causes the respective "MAP MIDI_INSTRUMENT" command to return
4420                      entry as instruments are loaded in the background. As a                      immediately, that is to let the sampler establish the mapping in the
4421                      consequence this command may not necessarily return an error                      background. So this argument might be especially useful for mappings with
4422                      i.e. when the given instrument file does not exist or may                      a "PERSISTENT" type, because these have to load the respective instruments
4423                      turn out to be corrupt.                      immediately and might thus block for a very long time. It is recommended
4424                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4425                        because it has the following drawbacks: as "NON_MODAL" instructions return
4426                        immediately, they may not necessarily return an error i.e. when the given
4427                        instrument file turns out to be corrupt, beside that subsequent commands
4428                        in a LSCP instruction sequence might fail, because mandatory mappings are
4429                        not yet completed.
4430                      </t>                      </t>
4431    
4432                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 3941  Schoenebeck'> Line 4469  Schoenebeck'>
4469                      </t>                      </t>
4470                      <t>                      <t>
4471                          <list>                          <list>
4472                              <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>
4473                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4474                          </list>                          </list>
4475                      </t>                      </t>
# Line 4140  Schoenebeck'> Line 4668  Schoenebeck'>
4668                              <t>"VOLUME" -                              <t>"VOLUME" -
4669                                  <list>                                  <list>
4670                                      <t>master volume of the instrument as optionally                                      <t>master volume of the instrument as optionally
4671                                      dotted number (where a value < 1.0 means attenuation                                      dotted number (where a value &lt; 1.0 means attenuation
4672                                      and a value > 1.0 means amplification)</t>                                      and a value > 1.0 means amplification)</t>
4673                                  </list>                                  </list>
4674                              </t>                              </t>
# Line 4212  Schoenebeck'> Line 4740  Schoenebeck'>
4740                  </section>                  </section>
4741              </section>              </section>
4742    
4743    
4744                <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4745                    <t>The following commands describe how to use and manage
4746                    the instruments database.</t>
4747    
4748                    <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4749                        <t>The front-end can add a new instrument directory to the
4750                        instruments database by sending the following command:</t>
4751                        <t>
4752                            <list>
4753                                <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
4754                            </list>
4755                        </t>
4756                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4757                        to be created (encapsulated into apostrophes).</t>
4758    
4759                        <t>Possible Answers:</t>
4760                        <t>
4761                            <list>
4762                                <t>"OK" -
4763                                    <list>
4764                                        <t>on success</t>
4765                                    </list>
4766                                </t>
4767                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4768                                    <list>
4769                                        <t>when the directory could not be created, which
4770                                        can happen if the directory already exists or the
4771                                        name contains not allowed symbols</t>
4772                                    </list>
4773                                </t>
4774                            </list>
4775                        </t>
4776    
4777                        <t>Examples:</t>
4778                        <t>
4779                            <list>
4780                                <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
4781                                <t>S: "OK"</t>
4782                            </list>
4783                        </t>
4784                    </section>
4785    
4786                    <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
4787                        <t>The front-end can delete a particular instrument directory
4788                        from the instruments database by sending the following command:</t>
4789                        <t>
4790                            <list>
4791                                <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
4792                            </list>
4793                        </t>
4794                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4795                        to delete. The optional FORCE argument can be used to
4796                        force the deletion of a non-empty directory and all its content.</t>
4797    
4798                        <t>Possible Answers:</t>
4799                        <t>
4800                            <list>
4801                                <t>"OK" -
4802                                    <list>
4803                                        <t>if the directory is deleted successfully</t>
4804                                    </list>
4805                                </t>
4806                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4807                                    <list>
4808                                        <t>if the given directory does not exist, or
4809                                        if trying to delete a non-empty directory,
4810                                        without using the FORCE argument.</t>
4811                                    </list>
4812                                </t>
4813                            </list>
4814                        </t>
4815    
4816                        <t>Examples:</t>
4817                        <t>
4818                            <list>
4819                                <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
4820                                <t>S: "OK"</t>
4821                            </list>
4822                        </t>
4823                    </section>
4824    
4825                    <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
4826                        <t>The front-end can retrieve the current amount of
4827                        directories in a specific directory by sending the following command:</t>
4828                        <t>
4829                            <list>
4830                                <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4831                            </list>
4832                        </t>
4833                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4834                        name of the directory. If RECURSIVE is specified, the number of
4835                        all directories, including those located in subdirectories of the
4836                        specified directory, will be returned.</t>
4837    
4838                        <t>Possible Answers:</t>
4839                        <t>
4840                            <list>
4841                                <t>The current number of instrument directories
4842                                in the specified directory.</t>
4843                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4844                                    <list>
4845                                        <t>if the given directory does not exist.</t>
4846                                    </list>
4847                                </t>
4848                            </list>
4849                        </t>
4850    
4851                        <t>Example:</t>
4852                        <t>
4853                            <list>
4854                                <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
4855                                <t>S: "2"</t>
4856                            </list>
4857                        </t>
4858                    </section>
4859    
4860                    <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
4861                        <t>The front-end can retrieve the current list of directories
4862                        in specific directory by sending the following command:</t>
4863                        <t>
4864                            <list>
4865                                <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4866                            </list>
4867                        </t>
4868                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4869                        name of the directory. If RECURSIVE is specified, the absolute path names
4870                        of all directories, including those located in subdirectories of the
4871                        specified directory, will be returned.</t>
4872    
4873                        <t>Possible Answers:</t>
4874                        <t>
4875                            <list>
4876                                <t>A comma separated list of all instrument directories
4877                                (encapsulated into apostrophes) in the specified directory.</t>
4878                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4879                                    <list>
4880                                        <t>if the given directory does not exist.</t>
4881                                    </list>
4882                                </t>
4883                            </list>
4884                        </t>
4885                        <t>Example:</t>
4886                        <t>
4887                            <list>
4888                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
4889                                <t>S: "'Piano Collection','Percussion Collection'"</t>
4890                            </list>
4891                        </t>
4892                        <t>
4893                            <list>
4894                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4895                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4896                            </list>
4897                        </t>
4898                    </section>
4899    
4900                    <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
4901                        <t>The front-end can ask for the current settings of an
4902                        instrument directory by sending the following command:</t>
4903                        <t>
4904                            <list>
4905                                <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
4906                            </list>
4907                        </t>
4908                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4909                        name of the directory the front-end is interested in.</t>
4910    
4911                        <t>Possible Answers:</t>
4912                        <t>
4913                            <list>
4914                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4915                                Each answer line begins with the settings category name
4916                                followed by a colon and then a space character &lt;SP&gt; and finally
4917                                the info character string to that setting category. At the
4918                                moment the following categories are defined:</t>
4919    
4920                                <t>
4921                                    <list>
4922                                        <t>DESCRIPTION -
4923                                            <list>
4924                                                <t>A brief description of the directory content</t>
4925                                            </list>
4926                                        </t>
4927                                        <t>CREATED -
4928                                            <list>
4929                                                <t>The creation date and time of the directory,
4930                                                represented in "YYYY-MM-DD HH:MM:SS" format</t>
4931                                            </list>
4932                                        </t>
4933                                        <t>MODIFIED -
4934                                            <list>
4935                                                <t>The date and time of the last modification of the
4936                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
4937                                            </list>
4938                                        </t>
4939                                    </list>
4940                                </t>
4941                            </list>
4942                        </t>
4943                        <t>The mentioned fields above don't have to be in particular order.</t>
4944    
4945                        <t>Example:</t>
4946                        <t>
4947                            <list>
4948                                <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
4949                                <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
4950                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
4951                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
4952                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4953                            </list>
4954                        </t>
4955                    </section>
4956    
4957                    <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
4958                        <t>The front-end can alter the name of a specific
4959                        instrument directory by sending the following command:</t>
4960                        <t>
4961                            <list>
4962                                <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
4963                            </list>
4964                        </t>
4965                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
4966                        &lt;name&gt; is the new name for that directory.</t>
4967    
4968                        <t>Possible Answers:</t>
4969                        <t>
4970                            <list>
4971                                <t>"OK" -
4972                                    <list>
4973                                        <t>on success</t>
4974                                    </list>
4975                                </t>
4976                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4977                                    <list>
4978                                        <t>in case the given directory does not exists,
4979                                        or if a directory with name equal to the new
4980                                        name already exists.</t>
4981                                    </list>
4982                                </t>
4983                            </list>
4984                        </t>
4985    
4986                        <t>Example:</t>
4987                        <t>
4988                            <list>
4989                                <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
4990                                <t>S: "OK"</t>
4991                            </list>
4992                        </t>
4993                    </section>
4994    
4995                    <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
4996                        <t>The front-end can move a specific
4997                        instrument directory by sending the following command:</t>
4998                        <t>
4999                            <list>
5000                                <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5001                            </list>
5002                        </t>
5003                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5004                        to move and &lt;dst&gt; is the location where the directory will
5005                        be moved to.</t>
5006    
5007                        <t>Possible Answers:</t>
5008                        <t>
5009                            <list>
5010                                <t>"OK" -
5011                                    <list>
5012                                        <t>on success</t>
5013                                    </list>
5014                                </t>
5015                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5016                                    <list>
5017                                        <t>in case a given directory does not exists,
5018                                        or if a directory with name equal to the name
5019                                        of the specified directory already exists in
5020                                        the destination directory. Error is also thrown
5021                                        when trying to move a directory to a subdirectory
5022                                        of itself.</t>
5023                                    </list>
5024                                </t>
5025                            </list>
5026                        </t>
5027    
5028                        <t>Example:</t>
5029                        <t>
5030                            <list>
5031                                <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5032                                <t>S: "OK"</t>
5033                            </list>
5034                        </t>
5035                    </section>
5036    
5037                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5038                        <t>The front-end can copy a specific
5039                        instrument directory by sending the following command:</t>
5040                        <t>
5041                            <list>
5042                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5043                            </list>
5044                        </t>
5045                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5046                        to copy and &lt;dst&gt; is the location where the directory will
5047                        be copied to.</t>
5048    
5049                        <t>Possible Answers:</t>
5050                        <t>
5051                            <list>
5052                                <t>"OK" -
5053                                    <list>
5054                                        <t>on success</t>
5055                                    </list>
5056                                </t>
5057                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5058                                    <list>
5059                                        <t>in case a given directory does not exists,
5060                                        or if a directory with name equal to the name
5061                                        of the specified directory already exists in
5062                                        the destination directory. Error is also thrown
5063                                        when trying to copy a directory to a subdirectory
5064                                        of itself.</t>
5065                                    </list>
5066                                </t>
5067                            </list>
5068                        </t>
5069    
5070                        <t>Example:</t>
5071                        <t>
5072                            <list>
5073                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5074                                <t>S: "OK"</t>
5075                            </list>
5076                        </t>
5077                    </section>
5078    
5079                    <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5080                        <t>The front-end can alter the description of a specific
5081                        instrument directory by sending the following command:</t>
5082                        <t>
5083                            <list>
5084                                <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5085                            </list>
5086                        </t>
5087                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5088                        &lt;desc&gt; is the new description for the directory.</t>
5089    
5090                        <t>Possible Answers:</t>
5091                        <t>
5092                            <list>
5093                                <t>"OK" -
5094                                    <list>
5095                                        <t>on success</t>
5096                                    </list>
5097                                </t>
5098                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5099                                    <list>
5100                                        <t>in case the given directory does not exists.</t>
5101                                    </list>
5102                                </t>
5103                            </list>
5104                        </t>
5105    
5106                        <t>Example:</t>
5107                        <t>
5108                            <list>
5109                                <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5110                                <t>S: "OK"</t>
5111                            </list>
5112                        </t>
5113                    </section>
5114    
5115                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5116                        <t>The front-end can search for directories
5117                        in specific directory by sending the following command:</t>
5118                        <t>
5119                            <list>
5120                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5121                            </list>
5122                        </t>
5123                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5124                        name of the directory to search in. If NON_RECURSIVE is specified, the
5125                        directories located in subdirectories of the specified directory will not
5126                        be searched. &lt;criteria-list&gt; is a list of search criterias
5127                        in form of "key1=val1 key2=val2 ...". The following criterias are
5128                        allowed:</t>
5129                        <t>
5130                          <t>NAME='&lt;search-string&gt;'
5131                              <list>
5132                                  <t>Restricts the search to directories, which names
5133                                  satisfy the supplied search string.</t>
5134                              </list>
5135                          </t>
5136    
5137                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5138                              <list>
5139                                  <t>Restricts the search to directories, which creation
5140                                  date satisfies the specified period, where &lt;date-after&gt;
5141                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5142                                  If &lt;date-after&gt; is omitted the search is restricted to
5143                                  directories created before &lt;date-before&gt;. If
5144                                  &lt;date-before&gt; is omitted, the search is restricted
5145                                  to directories created after &lt;date-after&gt;.</t>
5146                              </list>
5147                          </t>
5148    
5149                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5150                              <list>
5151                                  <t>Restricts the search to directories, which
5152                                  date of last modification satisfies the specified period, where
5153                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5154                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5155                                  directories, which are last modified before &lt;date-before&gt;. If
5156                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5157                                  which are last modified after &lt;date-after&gt;.</t>
5158                              </list>
5159                          </t>
5160    
5161                          <t>DESCRIPTION='&lt;search-string&gt;'
5162                              <list>
5163                                  <t>Restricts the search to directories with description
5164                                  that satisfies the supplied search string.</t>
5165                              </list>
5166                          </t>
5167                        </t>
5168    
5169                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5170                        word list separated with spaces for OR search and with '+' for AND search.</t>
5171    
5172                        <t>Possible Answers:</t>
5173                        <t>
5174                            <list>
5175                                <t>A comma separated list with the absolute path names (encapsulated into
5176                                apostrophes) of all directories in the specified directory that satisfy
5177                                the supplied search criterias.</t>
5178                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5179                                    <list>
5180                                        <t>if the given directory does not exist.</t>
5181                                    </list>
5182                                </t>
5183                            </list>
5184                        </t>
5185                        <t>Example:</t>
5186                        <t>
5187                            <list>
5188                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5189                                <t>S: "'/Piano Collection'"</t>
5190                            </list>
5191                        </t>
5192                        <t>
5193                            <list>
5194                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5195                                <t>S: "'/Piano Collection','/Percussions'"</t>
5196                            </list>
5197                        </t>
5198                    </section>
5199    
5200                    <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5201                        <t>The front-end can add one or more instruments
5202                        to the instruments database by sending the following command:</t>
5203                        <t>
5204                            <list>
5205                                <t>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5206                            </list>
5207                        </t>
5208                        <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5209                        (encapsulated into apostrophes) in the instruments database in which
5210                        only the new instruments (that are not already in the database) will
5211                        be added, &lt;file_path&gt; is the absolute path name of a file or
5212                        directory in the file system (encapsulated into apostrophes). In case
5213                        an instrument file is supplied, only the instruments in the specified
5214                        file will be added to the instruments database. If the optional
5215                        &lt;instr_index&gt; (the index of the instrument within the given file)
5216                        is supplied too, then only the specified instrument will be added.
5217                        In case a directory is supplied, the instruments in that directory
5218                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5219                        when a directory is provided as &lt;file_path&gt; and specifies how the
5220                        scanning will be done and has exactly the following possibilities:</t>
5221                        <t>
5222                            <list>
5223                                <t>"NON_RECURSIVE" -
5224                                    <list>
5225                                        <t>Only the instruments in the specified directory
5226                                        will be added, the instruments in the subdirectories
5227                                        will not be processed.</t>
5228                                    </list>
5229                                </t>
5230                                <t>"FLAT" -
5231                                    <list>
5232                                        <t>All instruments will be processed, including those
5233                                        in the subdirectories, but the respective subdirectory
5234                                        structure will not be recreated in the instruments
5235                                        database. All instruments will be added directly in
5236                                        the specified database directory.</t>
5237                                    </list>
5238                                </t>
5239                                <t>not supplied -
5240                                    <list>
5241                                        <t>The subdirectory tree structure will be recreated
5242                                        in the instruments database and all instruments will be
5243                                        processed and added to the respective subdirectory
5244                                        in the instruments database.</t>
5245                                    </list>
5246                                </t>
5247                            </list>
5248                        </t>
5249    
5250                        <t>Possible Answers:</t>
5251                        <t>
5252                            <list>
5253                                <t>"OK" -
5254                                    <list>
5255                                        <t>on success</t>
5256                                    </list>
5257                                </t>
5258                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5259                                    <list>
5260                                        <t>if an invalid path is specified.</t>
5261                                    </list>
5262                                </t>
5263                            </list>
5264                        </t>
5265    
5266                        <t>Examples:</t>
5267                        <t>
5268                            <list>
5269                                <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5270                                <t>S: "OK"</t>
5271                            </list>
5272                        </t>
5273                    </section>
5274    
5275                    <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5276                        <t>The front-end can remove a particular instrument
5277                        from the instruments database by sending the following command:</t>
5278                        <t>
5279                            <list>
5280                                <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5281                            </list>
5282                        </t>
5283                        <t>Where &lt;instr_path&gt; is the absolute path name
5284                        (in the instruments database) of the instrument to remove.</t>
5285    
5286                        <t>Possible Answers:</t>
5287                        <t>
5288                            <list>
5289                                <t>"OK" -
5290                                    <list>
5291                                        <t>if the instrument is removed successfully</t>
5292                                    </list>
5293                                </t>
5294                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5295                                    <list>
5296                                        <t>if the given path does not exist or
5297                                        is a directory.</t>
5298                                    </list>
5299                                </t>
5300                            </list>
5301                        </t>
5302    
5303                        <t>Examples:</t>
5304                        <t>
5305                            <list>
5306                                <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5307                                <t>S: "OK"</t>
5308                            </list>
5309                        </t>
5310                    </section>
5311    
5312                    <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5313                        <t>The front-end can retrieve the current amount of
5314                        instruments in a specific directory by sending the following command:</t>
5315                        <t>
5316                            <list>
5317                                <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5318                            </list>
5319                        </t>
5320                        <t>Where &lt;dir&gt; should be replaced by the absolute path name
5321                        of the directory. If RECURSIVE is specified, the number of all
5322                        instruments, including those located in subdirectories of the
5323                        specified directory, will be returned.</t>
5324    
5325                        <t>Possible Answers:</t>
5326                        <t>
5327                            <list>
5328                                <t>The current number of instruments
5329                                in the specified directory.</t>
5330                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5331                                    <list>
5332                                        <t>if the given directory does not exist.</t>
5333                                    </list>
5334                                </t>
5335                            </list>
5336                        </t>
5337    
5338                        <t>Example:</t>
5339                        <t>
5340                            <list>
5341                                <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5342                                <t>S: "2"</t>
5343                            </list>
5344                        </t>
5345                    </section>
5346    
5347                    <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5348                        <t>The front-end can retrieve the current list of instruments
5349                        in specific directory by sending the following command:</t>
5350                        <t>
5351                            <list>
5352                                <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5353                            </list>
5354                        </t>
5355                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5356                        name of the directory. If RECURSIVE is specified, the absolute path
5357                        names of all instruments, including those located in subdirectories
5358                        of the specified directory, will be returned.</t>
5359    
5360                        <t>Possible Answers:</t>
5361                        <t>
5362                            <list>
5363                                <t>A comma separated list of all instruments
5364                                (encapsulated into apostrophes) in the specified directory.</t>
5365                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5366                                    <list>
5367                                        <t>if the given directory does not exist.</t>
5368                                    </list>
5369                                </t>
5370                            </list>
5371                        </t>
5372                        <t>Example:</t>
5373                        <t>
5374                            <list>
5375                                <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5376                                <t>S: "'Bosendorfer 290','Steinway D'"</t>
5377                            </list>
5378                        </t>
5379                        <t>
5380                            <list>
5381                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5382                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5383                            </list>
5384                        </t>
5385                    </section>
5386    
5387                    <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5388                        <t>The front-end can ask for the current settings of an
5389                        instrument by sending the following command:</t>
5390                        <t>
5391                            <list>
5392                                <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5393                            </list>
5394                        </t>
5395                        <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5396                        name of the instrument the front-end is interested in.</t>
5397    
5398                        <t>Possible Answers:</t>
5399                        <t>
5400                            <list>
5401                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5402                                Each answer line begins with the settings category name
5403                                followed by a colon and then a space character &lt;SP&gt; and finally
5404                                the info character string to that setting category. At the
5405                                moment the following categories are defined:</t>
5406    
5407                                <t>
5408                                    <list>
5409                                        <t>INSTRUMENT_FILE -
5410                                            <list>
5411                                                <t>File name of the instrument.</t>
5412                                            </list>
5413                                        </t>
5414                                        <t>INSTRUMENT_NR -
5415                                            <list>
5416                                                <t>Index of the instrument within the file.</t>
5417                                            </list>
5418                                        </t>
5419                                        <t>FORMAT_FAMILY -
5420                                            <list>
5421                                                <t>The format family of the instrument.</t>
5422                                            </list>
5423                                        </t>
5424                                        <t>FORMAT_VERSION -
5425                                            <list>
5426                                                <t>The format version of the instrument.</t>
5427                                            </list>
5428                                        </t>
5429                                        <t>SIZE -
5430                                            <list>
5431                                                <t>The size of the instrument in bytes.</t>
5432                                            </list>
5433                                        </t>
5434                                        <t>CREATED -
5435                                            <list>
5436                                                <t>The date and time when the instrument is added
5437                                                in the instruments database, represented in
5438                                               "YYYY-MM-DD HH:MM:SS" format</t>
5439                                            </list>
5440                                        </t>
5441                                        <t>MODIFIED -
5442                                            <list>
5443                                                <t>The date and time of the last modification of the
5444                                                instrument's database settings, represented in
5445                                                "YYYY-MM-DD HH:MM:SS" format</t>
5446                                            </list>
5447                                        </t>
5448                                        <t>DESCRIPTION -
5449                                            <list>
5450                                                <t>A brief description of the instrument</t>
5451                                            </list>
5452                                        </t>
5453                                        <t>IS_DRUM -
5454                                            <list>
5455                                                <t>either true or false, determines whether the
5456                                                instrument is a drumkit or a chromatic instrument</t>
5457                                            </list>
5458                                        </t>
5459                                        <t>PRODUCT -
5460                                            <list>
5461                                                <t>The product title of the instrument</t>
5462                                            </list>
5463                                        </t>
5464                                        <t>ARTISTS -
5465                                            <list>
5466                                                <t>Lists the artist names</t>
5467                                            </list>
5468                                        </t>
5469                                        <t>KEYWORDS -
5470                                            <list>
5471                                                <t>Provides a list of keywords that refer to the instrument.
5472                                                Keywords are separated with semicolon and blank.</t>
5473                                            </list>
5474                                        </t>
5475                                    </list>
5476                                </t>
5477                            </list>
5478                        </t>
5479                        <t>The mentioned fields above don't have to be in particular order.</t>
5480    
5481                        <t>Example:</t>
5482                        <t>
5483                            <list>
5484                                <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5485                                <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5486                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5487                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5488                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5489                                <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5490                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5491                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5492                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5493                                <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5494                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5495                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5496                                <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5497                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5498                            </list>
5499                        </t>
5500                    </section>
5501    
5502                    <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5503                        <t>The front-end can alter the name of a specific
5504                        instrument by sending the following command:</t>
5505                        <t>
5506                            <list>
5507                                <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5508                            </list>
5509                        </t>
5510                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5511                        &lt;name&gt; is the new name for that instrument.</t>
5512    
5513                        <t>Possible Answers:</t>
5514                        <t>
5515                            <list>
5516                                <t>"OK" -
5517                                    <list>
5518                                        <t>on success</t>
5519                                    </list>
5520                                </t>
5521                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5522                                    <list>
5523                                        <t>in case the given instrument does not exists,
5524                                        or if an instrument with name equal to the new
5525                                        name already exists.</t>
5526                                    </list>
5527                                </t>
5528                            </list>
5529                        </t>
5530    
5531                        <t>Example:</t>
5532                        <t>
5533                            <list>
5534                                <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5535                                <t>S: "OK"</t>
5536                            </list>
5537                        </t>
5538                    </section>
5539    
5540                    <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5541                        <t>The front-end can move a specific instrument to another directory by
5542                        sending the following command:</t>
5543                        <t>
5544                            <list>
5545                                <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5546                            </list>
5547                        </t>
5548                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5549                        to move and &lt;dst&gt; is the directory where the instrument will
5550                        be moved to.</t>
5551    
5552                        <t>Possible Answers:</t>
5553                        <t>
5554                            <list>
5555                                <t>"OK" -
5556                                    <list>
5557                                        <t>on success</t>
5558                                    </list>
5559                                </t>
5560                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5561                                    <list>
5562                                        <t>in case the given instrument does not exists,
5563                                        or if an instrument with name equal to the name of the
5564                                        specified instrument already exists in the destination
5565                                        directory.</t>
5566                                    </list>
5567                                </t>
5568                            </list>
5569                        </t>
5570    
5571                        <t>Example:</t>
5572                        <t>
5573                            <list>
5574                                <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5575                                <t>S: "OK"</t>
5576                            </list>
5577                        </t>
5578                    </section>
5579    
5580                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5581                        <t>The front-end can copy a specific instrument to another directory by
5582                        sending the following command:</t>
5583                        <t>
5584                            <list>
5585                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5586                            </list>
5587                        </t>
5588                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5589                        to copy and &lt;dst&gt; is the directory where the instrument will
5590                        be copied to.</t>
5591    
5592                        <t>Possible Answers:</t>
5593                        <t>
5594                            <list>
5595                                <t>"OK" -
5596                                    <list>
5597                                        <t>on success</t>
5598                                    </list>
5599                                </t>
5600                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5601                                    <list>
5602                                        <t>in case the given instrument does not exists,
5603                                        or if an instrument with name equal to the name of the
5604                                        specified instrument already exists in the destination
5605                                        directory.</t>
5606                                    </list>
5607                                </t>
5608                            </list>
5609                        </t>
5610    
5611                        <t>Example:</t>
5612                        <t>
5613                            <list>
5614                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5615                                <t>S: "OK"</t>
5616                            </list>
5617                        </t>
5618                    </section>
5619    
5620                    <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5621                        <t>The front-end can alter the description of a specific
5622                        instrument by sending the following command:</t>
5623                        <t>
5624                            <list>
5625                                <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5626                            </list>
5627                        </t>
5628                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5629                        &lt;desc&gt; is the new description for the instrument.</t>
5630    
5631                        <t>Possible Answers:</t>
5632                        <t>
5633                            <list>
5634                                <t>"OK" -
5635                                    <list>
5636                                        <t>on success</t>
5637                                    </list>
5638                                </t>
5639                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5640                                    <list>
5641                                        <t>in case the given instrument does not exists.</t>
5642                                    </list>
5643                                </t>
5644                            </list>
5645                        </t>
5646    
5647                        <t>Example:</t>
5648                        <t>
5649                            <list>
5650                                <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5651                                <t>S: "OK"</t>
5652                            </list>
5653                        </t>
5654                    </section>
5655    
5656                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5657                        <t>The front-end can search for instruments
5658                        in specific directory by sending the following command:</t>
5659                        <t>
5660                            <list>
5661                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5662                            </list>
5663                        </t>
5664                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5665                        name of the directory to search in. If NON_RECURSIVE is specified, the
5666                        directories located in subdirectories of the specified directory will not
5667                        be searched. &lt;criteria-list&gt; is a list of search criterias
5668                        in form of "key1=val1 key2=val2 ...". The following criterias are
5669                        allowed:</t>
5670                        <t>
5671                          <t>NAME='&lt;search-string&gt;'
5672                              <list>
5673                                  <t>Restricts the search to instruments, which names
5674                                  satisfy the supplied search string.</t>
5675                              </list>
5676                          </t>
5677    
5678                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5679                              <list>
5680                                  <t>Restricts the search to instruments, which
5681                                  size is in the specified range. If &lt;min&gt; is omitted,
5682                                  the search results are restricted to instruments with size less then
5683                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5684                                  search is restricted to instruments with size greater then
5685                                  or equal to &lt;min&gt;.</t>
5686                              </list>
5687                          </t>
5688    
5689                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5690                              <list>
5691                                  <t>Restricts the search to instruments, which creation
5692                                  date satisfies the specified period, where &lt;date-after&gt;
5693                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5694                                  If &lt;date-after&gt; is omitted the search is restricted to
5695                                  instruments created before &lt;date-before&gt;. If
5696                                  &lt;date-before&gt; is omitted, the search is restricted
5697                                  to instruments created after &lt;date-after&gt;.</t>
5698                              </list>
5699                          </t>
5700    
5701                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5702                              <list>
5703                                  <t>Restricts the search to instruments, which
5704                                  date of last modification satisfies the specified period, where
5705                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5706                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5707                                  instruments, which are last modified before &lt;date-before&gt;. If
5708                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
5709                                  which are last modified after &lt;date-after&gt;.</t>
5710                              </list>
5711                          </t>
5712    
5713                          <t>DESCRIPTION='&lt;search-string&gt;'
5714                              <list>
5715                                  <t>Restricts the search to instruments with description
5716                                  that satisfies the supplied search string.</t>
5717                              </list>
5718                          </t>
5719    
5720                          <t>PRODUCT='&lt;search-string&gt;'
5721                              <list>
5722                                  <t>Restricts the search to instruments with product info
5723                                  that satisfies the supplied search string.</t>
5724                              </list>
5725                          </t>
5726    
5727                          <t>ARTISTS='&lt;search-string&gt;'
5728                              <list>
5729                                  <t>Restricts the search to instruments with artists info
5730                                  that satisfies the supplied search string.</t>
5731                              </list>
5732                          </t>
5733    
5734                          <t>KEYWORDS='&lt;search-string&gt;'
5735                              <list>
5736                                  <t>Restricts the search to instruments with keyword list
5737                                  that satisfies the supplied search string.</t>
5738                              </list>
5739                          </t>
5740    
5741                          <t>IS_DRUM=true | false
5742                              <list>
5743                                  <t>Either true or false. Restricts the search to
5744                                  drum kits or chromatic instruments.</t>
5745                              </list>
5746                          </t>
5747    
5748                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5749                              <list>
5750                                  <t>Restricts the search to instruments of the supplied format families,
5751                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
5752                              </list>
5753                          </t>
5754                        </t>
5755    
5756                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5757                        word list separated with spaces for OR search and with '+' for AND search.</t>
5758    
5759                        <t>Possible Answers:</t>
5760                        <t>
5761                            <list>
5762                                <t>A comma separated list with the absolute path names (encapsulated into
5763                                apostrophes) of all instruments in the specified directory that satisfy
5764                                the supplied search criterias.</t>
5765                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5766                                    <list>
5767                                        <t>if the given directory does not exist.</t>
5768                                    </list>
5769                                </t>
5770                            </list>
5771                        </t>
5772                        <t>Example:</t>
5773                        <t>
5774                            <list>
5775                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5776                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5777                            </list>
5778                        </t>
5779                        <t>
5780                            <list>
5781                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5782                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5783                            </list>
5784                        </t>
5785                    </section>
5786    
5787                </section>
5788    
5789          </section>          </section>
5790    
5791    
# Line 4287  Schoenebeck'> Line 5861  Schoenebeck'>
5861                  </t>                  </t>
5862                  <t>/ UNSUBSCRIBE SP unsubscribe_event                  <t>/ UNSUBSCRIBE SP unsubscribe_event
5863                  </t>                  </t>
                 <t>/ SELECT SP text  
                 </t>  
5864                  <t>/ RESET SP reset_instruction                  <t>/ RESET SP reset_instruction
5865                  </t>                  </t>
5866                  <t>/ CLEAR SP clear_instruction                  <t>/ CLEAR SP clear_instruction
5867                  </t>                  </t>
5868                    <t>/ FIND SP find_instruction
5869                    </t>
5870                    <t>/ MOVE SP move_instruction
5871                    </t>
5872                    <t>/ COPY SP copy_instruction
5873                    </t>
5874                  <t>/ RESET                  <t>/ RESET
5875                  </t>                  </t>
5876                  <t>/ QUIT                  <t>/ QUIT
# Line 4303  Schoenebeck'> Line 5881  Schoenebeck'>
5881          <list>          <list>
5882                  <t>CHANNEL                  <t>CHANNEL
5883                  </t>                  </t>
5884                    <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
5885                    </t>
5886                    <t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname
5887                    </t>
5888                    <t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
5889                    </t>
5890                    <t>/ DB_INSTRUMENTS SP pathname SP pathname
5891                    </t>
5892                    <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5893                    </t>
5894                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
5895                  </t>                  </t>
5896                  <t>/ MIDI_INSTRUMENT_MAP SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP map_name
# Line 4329  Schoenebeck'> Line 5917  Schoenebeck'>
5917                  </t>                  </t>
5918                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
5919                  </t>                  </t>
5920                    <t>/ FX_SEND_COUNT
5921                    </t>
5922                    <t>/ FX_SEND_INFO
5923                    </t>
5924                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
5925                  </t>                  </t>
5926                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4337  Schoenebeck'> Line 5929  Schoenebeck'>
5929                  </t>                  </t>
5930                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
5931                  </t>                  </t>
5932                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
5933                    </t>
5934                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
5935                    </t>
5936                    <t>/ DB_INSTRUMENT_COUNT
5937                    </t>
5938                    <t>/ DB_INSTRUMENT_INFO
5939                    </t>
5940                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
5941                  </t>                  </t>
5942                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
5943                  </t>                  </t>
5944                    <t>/ GLOBAL_INFO
5945                    </t>
5946          </list>          </list>
5947  </t>  </t>
5948  <t>unsubscribe_event =  <t>unsubscribe_event =
# Line 4363  Schoenebeck'> Line 5965  Schoenebeck'>
5965                  </t>                  </t>
5966                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
5967                  </t>                  </t>
5968                    <t>/ FX_SEND_COUNT
5969                    </t>
5970                    <t>/ FX_SEND_INFO
5971                    </t>
5972                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
5973                  </t>                  </t>
5974                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4371  Schoenebeck'> Line 5977  Schoenebeck'>
5977                  </t>                  </t>
5978                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
5979                  </t>                  </t>
5980                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
5981                    </t>
5982                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
5983                    </t>
5984                    <t>/ DB_INSTRUMENT_COUNT
5985                    </t>
5986                    <t>/ DB_INSTRUMENT_INFO
5987                    </t>
5988                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
5989                  </t>                  </t>
5990                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
5991                  </t>                  </t>
5992                    <t>/ GLOBAL_INFO
5993                    </t>
5994          </list>          </list>
5995  </t>  </t>
5996  <t>map_instruction =  <t>map_instruction =
5997          <list>          <list>
5998                  <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
5999                  </t>                  </t>
6000                  <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
6001                  </t>                  </t>
6002                  <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
6003                  </t>                  </t>
6004                  <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
6005                  </t>                  </t>
6006          </list>          </list>
6007  </t>  </t>
# Line 4403  Schoenebeck'> Line 6019  Schoenebeck'>
6019                  </t>                  </t>
6020                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6021                  </t>                  </t>
6022                    <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
6023                    </t>
6024                    <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
6025                    </t>
6026                    <t>/ DB_INSTRUMENT SP pathname
6027                    </t>
6028          </list>          </list>
6029  </t>  </t>
6030  <t>get_instruction =  <t>get_instruction =
# Line 4469  Schoenebeck'> Line 6091  Schoenebeck'>
6091                  </t>                  </t>
6092                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map                  <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
6093                  </t>                  </t>
6094                    <t>/ FX_SENDS SP sampler_channel
6095                    </t>
6096                    <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6097                    </t>
6098                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6099                    </t>
6100                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6101                    </t>
6102                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6103                    </t>
6104                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6105                    </t>
6106                    <t>/ DB_INSTRUMENTS SP pathname
6107                    </t>
6108                    <t>/ DB_INSTRUMENT SP INFO SP pathname
6109                    </t>
6110                    <t>/ VOLUME
6111                    </t>
6112          </list>          </list>
6113  </t>  </t>
6114  <t>set_instruction =  <t>set_instruction =
# Line 4485  Schoenebeck'> Line 6125  Schoenebeck'>
6125                  </t>                  </t>
6126                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6127                  </t>                  </t>
6128                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6129                    </t>
6130                    <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
6131                    </t>
6132                    <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
6133                    </t>
6134                    <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
6135                    </t>
6136                    <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
6137                    </t>
6138                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
6139                    </t>
6140                    <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
6141                    </t>
6142                    <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
6143                    </t>
6144                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6145                  </t>                  </t>
6146                    <t>/ VOLUME SP volume_value
6147                    </t>
6148          </list>          </list>
6149  </t>  </t>
6150  <t>create_instruction =  <t>create_instruction =
# Line 4499  Schoenebeck'> Line 6157  Schoenebeck'>
6157                  </t>                  </t>
6158                  <t>/ MIDI_INPUT_DEVICE SP string                  <t>/ MIDI_INPUT_DEVICE SP string
6159                  </t>                  </t>
6160                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl
6161                    </t>
6162                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
6163                    </t>
6164          </list>          </list>
6165  </t>  </t>
6166  <t>reset_instruction =  <t>reset_instruction =
# Line 4515  Schoenebeck'> Line 6177  Schoenebeck'>
6177                  </t>                  </t>
6178          </list>          </list>
6179  </t>  </t>
6180    <t>find_instruction =
6181            <list>
6182                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
6183                    </t>
6184                    <t>/ DB_INSTRUMENTS SP pathname SP query_val_list
6185                    </t>
6186                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list
6187                    </t>
6188                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
6189                    </t>
6190            </list>
6191    </t>
6192    <t>move_instruction =
6193            <list>
6194                    <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6195                    </t>
6196                    <t>/ DB_INSTRUMENT SP pathname SP pathname
6197                    </t>
6198            </list>
6199    </t>
6200    <t>copy_instruction =
6201            <list>
6202                    <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6203                    </t>
6204                    <t>/ DB_INSTRUMENT SP pathname SP pathname
6205                    </t>
6206            </list>
6207    </t>
6208  <t>destroy_instruction =  <t>destroy_instruction =
6209          <list>          <list>
6210                  <t>AUDIO_OUTPUT_DEVICE SP number                  <t>AUDIO_OUTPUT_DEVICE SP number
6211                  </t>                  </t>
6212                  <t>/ MIDI_INPUT_DEVICE SP number                  <t>/ MIDI_INPUT_DEVICE SP number
6213                  </t>                  </t>
6214                    <t>/ FX_SEND SP sampler_channel SP fx_send_id
6215                    </t>
6216          </list>          </list>
6217  </t>  </t>
6218  <t>load_instruction =  <t>load_instruction =
# Line 4563  Schoenebeck'> Line 6255  Schoenebeck'>
6255                  </t>                  </t>
6256          </list>          </list>
6257  </t>  </t>
6258    <t>modal_arg =
6259            <list>
6260                    <t>/* epsilon (empty argument) */
6261                    </t>
6262                    <t>/ NON_MODAL SP
6263                    </t>
6264            </list>
6265    </t>
6266  <t>key_val_list =  <t>key_val_list =
6267          <list>          <list>
6268                  <t>string '=' param_val_list                  <t>string '=' param_val_list
# Line 4599  Schoenebeck'> Line 6299  Schoenebeck'>
6299                  </t>                  </t>
6300                  <t>/ MIDI_INSTRUMENT_MAPS                  <t>/ MIDI_INSTRUMENT_MAPS
6301                  </t>                  </t>
6302                    <t>/ FX_SENDS SP sampler_channel
6303                    </t>
6304                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6305                    </t>
6306                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6307                    </t>
6308                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6309                    </t>
6310                    <t>/ DB_INSTRUMENTS SP pathname
6311                    </t>
6312          </list>          </list>
6313  </t>  </t>
6314  <t>load_instr_args =  <t>load_instr_args =
# Line 4681  Schoenebeck'> Line 6391  Schoenebeck'>
6391                  </t>                  </t>
6392          </list>          </list>
6393  </t>  </t>
6394    <t>midi_ctrl =
6395            <list>
6396                    <t>number
6397                    </t>
6398            </list>
6399    </t>
6400  <t>volume_value =  <t>volume_value =
6401          <list>          <list>
6402                  <t>dotnum                  <t>dotnum
# Line 4701  Schoenebeck'> Line 6417  Schoenebeck'>
6417                  </t>                  </t>
6418          </list>          </list>
6419  </t>  </t>
6420    <t>fx_send_id =
6421            <list>
6422                    <t>number
6423                    </t>
6424            </list>
6425    </t>
6426  <t>engine_name =  <t>engine_name =
6427          <list>          <list>
6428                  <t>string                  <t>string
6429                  </t>                  </t>
6430          </list>          </list>
6431  </t>  </t>
6432    <t>pathname =
6433            <list>
6434                    <t>stringval
6435                    </t>
6436            </list>
6437    </t>
6438    <t>dirname =
6439            <list>
6440                    <t>stringval
6441                    </t>
6442            </list>
6443    </t>
6444  <t>filename =  <t>filename =
6445          <list>          <list>
6446                  <t>stringval                  <t>stringval
# Line 4725  Schoenebeck'> Line 6459  Schoenebeck'>
6459                  </t>                  </t>
6460          </list>          </list>
6461  </t>  </t>
6462    <t>fx_send_name =
6463            <list>
6464                    <t>stringval
6465                    </t>
6466            </list>
6467    </t>
6468  <t>param_val_list =  <t>param_val_list =
6469          <list>          <list>
6470                  <t>param_val                  <t>param_val
# Line 4745  Schoenebeck'> Line 6485  Schoenebeck'>
6485                  </t>                  </t>
6486          </list>          </list>
6487  </t>  </t>
6488    <t>query_val_list =
6489            <list>
6490                    <t>string '=' query_val
6491                    </t>
6492                    <t>/ query_val_list SP string '=' query_val
6493                    </t>
6494            </list>
6495    </t>
6496    <t>query_val =
6497            <list>
6498                    <t>string
6499                    </t>
6500                    <t>/ stringval
6501                    </t>
6502            </list>
6503    </t>
6504    
6505              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6506          </section>          </section>
# Line 4861  Schoenebeck'> Line 6617  Schoenebeck'>
6617                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
6618                  <t>                  <t>
6619                      <list>                      <list>
6620                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
6621                      </list>                      </list>
6622                  </t>                  </t>
6623                  <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 4931  Schoenebeck'> Line 6687  Schoenebeck'>
6687                  message is sufficient here.</t>                  message is sufficient here.</t>
6688              </section>              </section>
6689    
6690                <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
6691                    <t>Client may want to be notified when the number of effect sends on
6692                    a particular sampler channel is changed by issuing the following command:</t>
6693                    <t>
6694                        <list>
6695                            <t>SUBSCRIBE FX_SEND_COUNT</t>
6696                        </list>
6697                    </t>
6698                    <t>Server will start sending the following notification messages:</t>
6699                    <t>
6700                        <list>
6701                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
6702                        </list>
6703                    </t>
6704                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
6705                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
6706                    be replaced by the new number of effect sends on that channel.</t>
6707                </section>
6708    
6709                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
6710                    <t>Client may want to be notified when changes were made to effect sends on a
6711                    a particular sampler channel by issuing the following command:</t>
6712                    <t>
6713                        <list>
6714                            <t>SUBSCRIBE FX_SEND_INFO</t>
6715                        </list>
6716                    </t>
6717                    <t>Server will start sending the following notification messages:</t>
6718                    <t>
6719                        <list>
6720                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
6721                        </list>
6722                    </t>
6723                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
6724                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
6725                    be replaced by the numerical ID of the changed effect send.</t>
6726                </section>
6727    
6728              <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">
6729                  <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
6730                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 4942  Schoenebeck'> Line 6736  Schoenebeck'>
6736                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
6737                  <t>                  <t>
6738                      <list>                      <list>
6739                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
6740                      </list>                      </list>
6741                  </t>                  </t>
6742                  <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 5031  Schoenebeck'> Line 6825  Schoenebeck'>
6825                  message is sufficient here.</t>                  message is sufficient here.</t>
6826              </section>              </section>
6827    
6828              <<section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
6829                    <t>Client may want to be notified when changes to the global settings
6830                    of the sampler were made by issuing the following command:</t>
6831                    <t>
6832                        <list>
6833                            <t>SUBSCRIBE GLOBAL_INFO</t>
6834                        </list>
6835                    </t>
6836                    <t>Server will start sending the following types of notification messages:</t>
6837                    <t>
6838                        <list>
6839                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
6840                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
6841                            replaced by the optional dotted floating point value, reflecting the
6842                            new global volume parameter.</t>
6843                        </list>
6844                    </t>
6845                </section>
6846    
6847                <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
6848                    <t>Client may want to be notified when the number of instrument
6849                    directories in a particular directory in the instruments database
6850                    is changed by issuing the following command:</t>
6851                    <t>
6852                        <list>
6853                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
6854                        </list>
6855                    </t>
6856                    <t>Server will start sending the following notification messages:</t>
6857                    <t>
6858                        <list>
6859                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
6860                        </list>
6861                    </t>
6862                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
6863                    name of the directory in the instruments database,
6864                    in which the number of directories is changed.</t>
6865                    <t>Note that when a non-empty directory is removed, this event
6866                    is not sent for the subdirectories in that directory.</t>
6867                </section>
6868    
6869                <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
6870                    <t>Client may want to be notified when changes were made to directories
6871                    in the instruments database by issuing the following command:</t>
6872                    <t>
6873                        <list>
6874                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
6875                        </list>
6876                    </t>
6877                    <t>Server will start sending the following notification messages:</t>
6878                    <t>
6879                        <list>
6880                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
6881                        </list>
6882                    </t>
6883                    <t>where &lt;dir-path&gt; will be replaced by the absolute path name
6884                    of the directory, for which information changes occurred. The front-end will have to send
6885                    the respective command to actually get the updated directory info. Because these messages
6886                    will be triggered by LSCP commands issued by other clients rather than real
6887                    time events happening on the server, it is believed that an empty notification
6888                    message is sufficient here.</t>
6889                    <t>
6890                        <list>
6891                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
6892                        </list>
6893                    </t>
6894                    <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
6895                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
6896                    the new name of the directory, encapsulated into apostrophes.</t>
6897                </section>
6898    
6899                <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
6900                    <t>Client may want to be notified when the number of instruments
6901                    in a particular directory in the instruments database
6902                    is changed by issuing the following command:</t>
6903                    <t>
6904                        <list>
6905                            <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
6906                        </list>
6907                    </t>
6908                    <t>Server will start sending the following notification messages:</t>
6909                    <t>
6910                        <list>
6911                            <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
6912                        </list>
6913                    </t>
6914                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
6915                    name of the directory in the instruments database,
6916                    in which the number of instruments is changed.</t>
6917                    <t>Note that when a non-empty directory is removed, this event
6918                    is not sent for the instruments in that directory.</t>
6919                </section>
6920    
6921                <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
6922                    <t>Client may want to be notified when changes were made to instruments
6923                    in the instruments database by issuing the following command:</t>
6924                    <t>
6925                        <list>
6926                            <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
6927                        </list>
6928                    </t>
6929                    <t>Server will start sending the following notification messages:</t>
6930                    <t>
6931                        <list>
6932                            <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
6933                        </list>
6934                    </t>
6935                    <t>where &lt;instr-path&gt; will be replaced by the absolute path name
6936                    of the instrument, which settings are changed. The front-end will have to send
6937                    the respective command to actually get the updated directory info. Because these messages
6938                    will be triggered by LSCP commands issued by other clients rather than real
6939                    time events happening on the server, it is believed that an empty notification
6940                    message is sufficient here.</t>
6941                    <t>
6942                        <list>
6943                            <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
6944                        </list>
6945                    </t>
6946                    <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
6947                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
6948                    the new name of the instrument, encapsulated into apostrophes.</t>
6949                </section>
6950    
6951                <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
6952                  <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
6953                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
6954                  <t>                  <t>
Legend:
Removed from v.984  
changed lines
  Added in v.1187
  ViewVC Help
Powered by ViewVC