/[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 944 by schoenebeck, Sun Nov 26 16:29:57 2006 UTC revision 1005 by schoenebeck, Fri Dec 29 20:06:14 2006 UTC
# Line 11  Line 11 
11  <?rfc symrefs="yes" ?>  <?rfc symrefs="yes" ?>
12  <?rfc sortrefs="yes"?>  <?rfc sortrefs="yes"?>
13  <?rfc iprnotified="no" ?>  <?rfc iprnotified="no" ?>
 <?rfc strict="yes" ?>  
14    
15  <rfc category="std" ipr="full2026" docName="LSCP 1.2">  <!-- FIXME: next attribute should actually be "yes", temporarily disbled due
16         to an annoying "missing Normative/Informative References" error message -->
17    <?rfc strict="no" ?>
18    
19    <rfc category="std" ipr="full3978" docName="LSCP 1.2">
20      <front>      <front>
21          <title>LinuxSampler Control Protocol</title>          <title>LinuxSampler Control Protocol</title>
22          <author initials='C.S.' surname="Schoenebeck" fullname='C.          <author initials='C.S.' surname="Schoenebeck" fullname='C.
# Line 31  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="November" year="2006"/>          <date month="December" year="2006"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 2571  Schoenebeck'> Line 2574  Schoenebeck'>
2574                                              the channel is a solo channel; "false" otherwise</t>                                              the channel is a solo channel; "false" otherwise</t>
2575                                          </list>                                          </list>
2576                                      </t>                                      </t>
2577                                        <t>MIDI_INSTRUMENT_MAP -
2578                                            <list>
2579                                                <t>Determines to which MIDI instrument map this sampler
2580                                                channel is assigned to. Read chapter
2581                                                <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
2582                                                for a list of possible values.</t>
2583                                            </list>
2584                                        </t>
2585                                  </list>                                  </list>
2586                              </t>                              </t>
2587                          </list>                          </list>
# Line 2593  Schoenebeck'> Line 2604  Schoenebeck'>
2604                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_DEVICE: 0"</t>
2605                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_PORT: 0"</t>
2606                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>                              <t>&nbsp;&nbsp;&nbsp;"MIDI_INPUT_CHANNEL: 5"</t>
2607                                <t>&nbsp;&nbsp;&nbsp;"VOLUME: 1.0"</t>
2608                                <t>&nbsp;&nbsp;&nbsp;"MUTE: false"</t>
2609                                <t>&nbsp;&nbsp;&nbsp;"SOLO: false"</t>
2610                                <t>&nbsp;&nbsp;&nbsp;"MIDI_INSTRUMENT_MAP: NONE"</t>
2611                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
2612                          </list>                          </list>
2613                      </t>                      </t>
# Line 2753  Schoenebeck'> Line 2768  Schoenebeck'>
2768                      </t>                      </t>
2769                  </section>                  </section>
2770    
2771                  <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYP">                  <section title="Setting audio output type" anchor="SET CHANNEL AUDIO_OUTPUT_TYPE">
2772                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>                      <t>DEPRECATED: THIS COMMAND WILL DISAPPEAR SOON!</t>
2773    
2774                      <t>The front-end can alter the audio output type on a specific sampler                      <t>The front-end can alter the audio output type on a specific sampler
# Line 3144  Schoenebeck'> Line 3159  Schoenebeck'>
3159                      </t>                      </t>
3160                  </section>                  </section>
3161    
3162                    <section title="Assigning a MIDI instrument map to a sampler channel" anchor="SET CHANNEL MIDI_INSTRUMENT_MAP">
3163                        <t>The front-end can assign a MIDI instrument map to a specific sampler channel
3164                        by sending the following command:</t>
3165                        <t>
3166                            <list>
3167                                <t>SET CHANNEL MIDI_INSTRUMENT_MAP &lt;sampler-channel&gt; &lt;map&gt;</t>
3168                            </list>
3169                        </t>
3170                        <t>Where &lt;sampler-channel&gt; is the respective sampler channel
3171                        number as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3172                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command and
3173                        &lt;map&gt; can have the following possibilites:</t>
3174                        <t>
3175                            <list>
3176                                <t>"NONE" -
3177                                    <list>
3178                                        <t>This is the default setting. In this case
3179                                        the sampler channel is not assigned any MIDI
3180                                        instrument map and thus will ignore all MIDI
3181                                        program change messages.</t>
3182                                    </list>
3183                                </t>
3184                                <t>"DEFAULT" -
3185                                    <list>
3186                                        <t>The sampler channel will always use the
3187                                        default MIDI instrument map to handle MIDI
3188                                        program change messages.</t>
3189                                    </list>
3190                                </t>
3191                                <t>numeric ID -
3192                                    <list>
3193                                        <t>You can assign a specific MIDI instrument map
3194                                        by replacing &lt;map&gt; with the respective numeric
3195                                        ID of the MIDI instrument map as returned by the
3196                                        <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
3197                                        command. Once that map will be deleted, the sampler
3198                                        channel would fall back to "NONE".</t>
3199                                    </list>
3200                                </t>
3201                            </list>
3202                        </t>
3203                        <t>Read chapter <xref target="MIDI Instrument Mapping">"MIDI Instrument Mapping"</xref>
3204                        for details regarding MIDI instrument mapping.</t>
3205    
3206                        <t>Possible Answers:</t>
3207                        <t>
3208                            <list>
3209                                <t>"OK" -
3210                                    <list>
3211                                        <t>on success</t>
3212                                    </list>
3213                                </t>
3214                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3215                                    <list>
3216                                        <t>in case it failed, providing an appropriate error code and error message</t>
3217                                    </list>
3218                                </t>
3219                            </list>
3220                        </t>
3221    
3222                        <t>Examples:</t>
3223                        <t>
3224                            <list>
3225                                <t></t>
3226                            </list>
3227                        </t>
3228                    </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>AUDIO_OUTPUT_ROUTING -
3438                                            <list>
3439                                                <t>comma separated list which reflects to which audio
3440                                                channel of the selected audio output device each
3441                                                effect send output channel is routed to, e.g. "0,3" would
3442                                                mean the effect send's output channel 0 is routed to channel
3443                                                0 of the audio output device and the effect send's output
3444                                                channel 1 is routed to the channel 3 of the audio
3445                                                output device (see
3446                                                <xref target="SET FX_SEND AUDIO_OUTPUT_CHANNEL">"SET FX_SEND AUDIO_OUTPUT_CHANNEL"</xref>
3447                                                for details)</t>
3448                                            </list>
3449                                        </t>
3450                                    </list>
3451                                </t>
3452                            </list>
3453                        </t>
3454                        <t>The mentioned fields above don't have to be in particular order.</t>
3455    
3456                        <t>Example:</t>
3457                        <t>
3458                            <list>
3459                                <t>C: "GET FX_SEND INFO 0 0"</t>
3460                                <t>S: "NAME: Reverb Send"</t>
3461                                <t>&nbsp;&nbsp;&nbsp;"AUDIO_OUTPUT_ROUTING: 2,3"</t>
3462                                <t>&nbsp;&nbsp;&nbsp;"."</t>
3463                            </list>
3464                        </t>
3465                    </section>
3466    
3467                    <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3468                        <t>The front-end can alter the destination of an effect send's audio channel on a specific
3469                        sampler channel by sending the following command:</t>
3470                        <t>
3471                            <list>
3472                                <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>
3473                            </list>
3474                        </t>
3475                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3476                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3477                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3478                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3479                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3480                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command,
3481                        &lt;audio-src&gt; is the numerical ID of the effect send's audio channel
3482                        which should be rerouted and &lt;audio-dst&gt; is the numerical ID of
3483                        the audio channel of the selected audio output device where &lt;audio-src&gt;
3484                        should be routed to.</t>
3485    
3486                        <t>Note that effect sends can only route audio to the same audio output
3487                        device as assigned to the effect send's sampler channel. Also note that an
3488                        effect send entity does always have exactly as much audio channels as its
3489                        sampler channel. So if the sampler channel is stereo, the effect send does
3490                        have two audio channels as well. Also keep in mind that the amount of audio
3491                        channels on a sampler channel might be dependant not only to the deployed
3492                        sampler engine on the sampler channel, but also dependant to the instrument
3493                        currently loaded. However you can (effectively) turn an i.e. stereo effect
3494                        send into a mono one by simply altering its audio routing appropriately.</t>
3495    
3496                        <t>Possible Answers:</t>
3497                        <t>
3498                            <list>
3499                                <t>"OK" -
3500                                    <list>
3501                                        <t>on success</t>
3502                                    </list>
3503                                </t>
3504                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3505                                    <list>
3506                                        <t>if audio output channel was set, but there are noteworthy
3507                                        issue(s) related, providing an appropriate warning code and
3508                                        warning message</t>
3509                                    </list>
3510                                </t>
3511                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3512                                    <list>
3513                                        <t>in case it failed, providing an appropriate error code and error message</t>
3514                                    </list>
3515                                </t>
3516                            </list>
3517                        </t>
3518                        <t>Example:</t>
3519                        <t>
3520                            <list>
3521                                <t>C: "SET FX_SEND AUDIO_OUTPUT_CHANNEL 0 0 0 2"</t>
3522                                <t>S: "OK"</t>
3523                            </list>
3524                        </t>
3525                    </section>
3526    
3527    
3528                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">                  <section title="Resetting a sampler channel" anchor="RESET CHANNEL">
3529                      <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>
3530                      <t>                      <t>
# Line 3433  Schoenebeck'> Line 3814  Schoenebeck'>
3814                      <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.
3815                      Other fields might be added in future.</t>                      Other fields might be added in future.</t>
3816                  </section>                  </section>
3817    
3818                    <section title="Getting global volume attenuation" anchor="GET VOLUME">
3819                        <t>The client can ask for the current global sampler-wide volume
3820                        attenuation by sending the following command:</t>
3821                        <t>
3822                            <list>
3823                                <t>GET VOLUME</t>
3824                            </list>
3825                        </t>
3826                        <t>Possible Answers:</t>
3827                        <t>
3828                            <list>
3829                                <t>The sampler will always answer by returning the optional
3830                                dotted floating point coefficient, reflecting the current
3831                                global volume attenuation.
3832                                </t>
3833                            </list>
3834                        </t>
3835                        <t>Note: it is up to the respective sampler engine whether to obey
3836                        that global volume parameter or not, but in general all engines SHOULD
3837                        use this parameter.</t>
3838                    </section>
3839    
3840                    <section title="Setting global volume attenuation" anchor="SET VOLUME">
3841                        <t>The client can alter the current global sampler-wide volume
3842                        attenuation by sending the following command:</t>
3843                        <t>
3844                            <list>
3845                                <t>SET VOLUME &lt;volume&gt;</t>
3846                            </list>
3847                        </t>
3848                       <t>Where &lt;volume&gt; should be replaced by the optional dotted
3849                       floating point value, reflecting the new global volume parameter.
3850                       This value might usually be in the range between 0.0 and 1.0, that
3851                       is for attenuating the overall volume.</t>
3852    
3853                        <t>Possible Answers:</t>
3854                        <t>
3855                            <list>
3856                                <t>"OK" -
3857                                    <list>
3858                                        <t>on success</t>
3859                                    </list>
3860                                </t>
3861                                <t>"WRN:&lt;warning-code&gt;:&lt;warning-message&gt;" -
3862                                    <list>
3863                                        <t>if the global volume was set, but there are noteworthy
3864                                        issue(s) related, providing an appropriate warning code and
3865                                        warning message</t>
3866                                    </list>
3867                                </t>
3868                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3869                                    <list>
3870                                        <t>in case it failed, providing an appropriate error code and error message</t>
3871                                    </list>
3872                                </t>
3873                            </list>
3874                        </t>
3875                    </section>
3876              </section>              </section>
3877    
3878    
3879              <section title="MIDI Instrument Mapping">              <section title="MIDI Instrument Mapping" anchor="MIDI Instrument Mapping">
3880                  <t>The MIDI protocol provides a way to switch between instruments                  <t>The MIDI protocol provides a way to switch between instruments
3881                  by sending so called MIDI bank select and MIDI program change                  by sending so called MIDI bank select and MIDI program change
3882                  messages which are essentially just numbers. The following commands                  messages which are essentially just numbers. The following commands
3883                  allow to actually map arbitrary MIDI bank select / program change                  allow to actually map arbitrary MIDI bank select / program change
3884                  numbers with real instruments.</t>                  numbers with real instruments.</t>
3885                  <t>By default, that is when the sampler is launched, this map will                  <t>The sampler allows to manage an arbitrary amount of MIDI
3886                  be empty, thus the sampler will simply ignore all program change                  instrument maps which define which instrument to load on
3887                  messages. The front-end has to explicitly add entries to the map                  which MIDI program change message.</t>
3888                  so the sampler knows how to react on a given program change                  <t>By default, that is when the sampler is launched, there is no
3889                  message, that is by switching to the respectively defined engine                  map, thus the sampler will simply ignore all program change
3890                  type and loading the respective instrument.</t>                  messages. The front-end has to explicitly create at least one
3891                    map, add entries to the map and tell the respective sampler
3892                    channel(s) which MIDI instrument map to use, so the sampler
3893                    knows how to react on a given program change message on the
3894                    respective sampler channel, that is by switching to the
3895                    respectively defined engine type and loading the respective
3896                    instrument. See command
3897                    <xref target="SET CHANNEL MIDI_INSTRUMENT_MAP">"SET CHANNEL MIDI_INSTRUMENT_MAP"</xref>
3898                    for how to assign a MIDI instrument map to a sampler channel.</t>
3899                  <t>Also note per MIDI specification a bank select message does not                  <t>Also note per MIDI specification a bank select message does not
3900                  cause to switch to another instrument. Instead when receiving a                  cause to switch to another instrument. Instead when receiving a
3901                  bank select message the bank value will be stored and a subsequent                  bank select message the bank value will be stored and a subsequent
# Line 3455  Schoenebeck'> Line 3903  Schoenebeck'>
3903                  cause the sampler to switch to the respective instrument as                  cause the sampler to switch to the respective instrument as
3904                  reflected by the current MIDI instrument map.</t>                  reflected by the current MIDI instrument map.</t>
3905    
3906                    <section title="Create a new MIDI instrument map" anchor="ADD MIDI_INSTRUMENT MAP">
3907                        <t>The front-end can add a new MIDI instrument map by sending
3908                        the following command:</t>
3909                        <t>
3910                            <list>
3911                                <t>ADD MIDI_INSTRUMENT_MAP [&lt;name&gt;]</t>
3912                            </list>
3913                        </t>
3914                        <t>Where &lt;name&gt; is an optional argument allowing to
3915                        assign a custom name to the new map. MIDI instrument Map
3916                        names do not have to be unique.</t>
3917    
3918                        <t>Possible Answers:</t>
3919                        <t>
3920                            <list>
3921                                <t>"OK[&lt;map&gt;]" -
3922                                    <list>
3923                                        <t>in case a new MIDI instrument map could
3924                                        be added, where &lt;map&gt; reflects the
3925                                        unique ID of the newly created MIDI
3926                                        instrument map</t>
3927                                    </list>
3928                                </t>
3929                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3930                                    <list>
3931                                        <t>when a new map could not be created, which
3932                                        might never occur in practice</t>
3933                                    </list>
3934                                </t>
3935                            </list>
3936                        </t>
3937    
3938                        <t>Examples:</t>
3939                        <t>
3940                            <list>
3941                                <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Map'"</t>
3942                                <t>S: "OK[0]"</t>
3943                            </list>
3944                        </t>
3945                        <t>
3946                            <list>
3947                                <t>C: "ADD MIDI_INSTRUMENT_MAP 'Standard Drumkit'"</t>
3948                                <t>S: "OK[1]"</t>
3949                            </list>
3950                        </t>
3951                        <t>
3952                            <list>
3953                                <t>C: "ADD MIDI_INSTRUMENT_MAP"</t>
3954                                <t>S: "OK[5]"</t>
3955                            </list>
3956                        </t>
3957                    </section>
3958    
3959                    <section title="Delete one particular or all MIDI instrument maps" anchor="REMOVE MIDI_INSTRUMENT_MAP">
3960                        <t>The front-end can delete a particular MIDI instrument map
3961                        by sending the following command:</t>
3962                        <t>
3963                            <list>
3964                                <t>REMOVE MIDI_INSTRUMENT_MAP &lt;map&gt;</t>
3965                            </list>
3966                        </t>
3967                        <t>Where &lt;map&gt; reflects the unique ID of the map to delete
3968                        as returned by the <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
3969                        command.</t>
3970                        <t>The front-end can delete all MIDI instrument maps by
3971                        sending the following command:</t>
3972                        <t>
3973                            <list>
3974                                <t>REMOVE MIDI_INSTRUMENT_MAP ALL</t>
3975                            </list>
3976                        </t>
3977    
3978                        <t>Possible Answers:</t>
3979                        <t>
3980                            <list>
3981                                <t>"OK" -
3982                                    <list>
3983                                        <t>in case the map(s) could be deleted</t>
3984                                    </list>
3985                                </t>
3986                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3987                                    <list>
3988                                        <t>when the given map does not exist</t>
3989                                    </list>
3990                                </t>
3991                            </list>
3992                        </t>
3993    
3994                        <t>Examples:</t>
3995                        <t>
3996                            <list>
3997                                <t>C: "REMOVE MIDI_INSTRUMENT_MAP 0"</t>
3998                                <t>S: "OK"</t>
3999                            </list>
4000                        </t>
4001                        <t>
4002                            <list>
4003                                <t>C: "REMOVE MIDI_INSTRUMENT_MAP ALL"</t>
4004                                <t>S: "OK"</t>
4005                            </list>
4006                        </t>
4007                    </section>
4008    
4009                    <section title="Get amount of existing MIDI instrument maps" anchor="GET MIDI_INSTRUMENT_MAPS">
4010                        <t>The front-end can retrieve the current amount of MIDI
4011                        instrument maps by sending the following command:</t>
4012                        <t>
4013                            <list>
4014                                <t>GET MIDI_INSTRUMENT_MAPS</t>
4015                            </list>
4016                        </t>
4017    
4018                        <t>Possible Answers:</t>
4019                        <t>
4020                            <list>
4021                                <t>The sampler will answer by returning the current
4022                                number of MIDI instrument maps.</t>
4023                            </list>
4024                        </t>
4025    
4026                        <t>Example:</t>
4027                        <t>
4028                            <list>
4029                                <t>C: "GET MIDI_INSTRUMENT_MAPS"</t>
4030                                <t>S: "2"</t>
4031                            </list>
4032                        </t>
4033                    </section>
4034    
4035                    <section title="Getting all created MIDI instrument maps" anchor="LIST MIDI_INSTRUMENT_MAPS">
4036                        <t>The number of MIDI instrument maps can change on runtime. To get the
4037                        current list of MIDI instrument maps, the front-end can send the
4038                        following command:</t>
4039                        <t>
4040                            <list>
4041                                <t>LIST MIDI_INSTRUMENT_MAPS</t>
4042                            </list>
4043                        </t>
4044                        <t>Possible Answers:</t>
4045                        <t>
4046                            <list>
4047                                <t>The sampler will answer by returning a comma separated list
4048                                with all MIDI instrument maps' numerical IDs.</t>
4049                            </list>
4050                        </t>
4051                        <t>Example:</t>
4052                        <t>
4053                            <list>
4054                                <t>C: "LIST MIDI_INSTRUMENT_MAPS"</t>
4055                                <t>S: "0,1,5,12"</t>
4056                            </list>
4057                        </t>
4058                    </section>
4059    
4060                    <section title="Getting MIDI instrument map information" anchor="GET MIDI_INSTRUMENT_MAP INFO">
4061                        <t>The front-end can ask for the current settings of a MIDI
4062                        instrument map by sending the following command:</t>
4063                        <t>
4064                            <list>
4065                                <t>GET MIDI_INSTRUMENT_MAP INFO &lt;map&gt;</t>
4066                            </list>
4067                        </t>
4068                        <t>Where &lt;map&gt; is the numerical ID of the map the
4069                        front-end is interested in as returned by the
4070                        <xref target="LIST MIDI_INSTRUMENT_MAPS">"LIST MIDI_INSTRUMENT_MAPS"</xref>
4071                        command.</t>
4072    
4073                        <t>Possible Answers:</t>
4074                        <t>
4075                            <list>
4076                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4077                                Each answer line begins with the settings category name
4078                                followed by a colon and then a space character &lt;SP&gt; and finally
4079                                the info character string to that setting category. At the
4080                                moment the following categories are defined:</t>
4081    
4082                                <t>
4083                                    <list>
4084                                        <t>NAME -
4085                                            <list>
4086                                                <t>custom name of the given map,
4087                                                which does not have to be unique</t>
4088                                            </list>
4089                                        </t>
4090                                    </list>
4091                                </t>
4092                            </list>
4093                        </t>
4094                        <t>The mentioned fields above don't have to be in particular order.</t>
4095    
4096                        <t>Example:</t>
4097                        <t>
4098                            <list>
4099                                <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4100                                <t>S: "NAME: Standard Map"</t>
4101                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4102                            </list>
4103                        </t>
4104                    </section>
4105    
4106                    <section title="Renaming a MIDI instrument map" anchor="SET MIDI_INSTRUMENT_MAP NAME">
4107                        <t>The front-end can alter the custom name of a MIDI
4108                        instrument map by sending the following command:</t>
4109                        <t>
4110                            <list>
4111                                <t>SET MIDI_INSTRUMENT_MAP NAME &lt;map&gt; &lt;name&gt;</t>
4112                            </list>
4113                        </t>
4114                        <t>Where &lt;map&gt; is the numerical ID of the map and
4115                        &lt;name&gt; the new custom name of the map, which does not
4116                        have to be unique.</t>
4117    
4118                        <t>Possible Answers:</t>
4119                        <t>
4120                            <list>
4121                                <t>"OK" -
4122                                    <list>
4123                                        <t>on success</t>
4124                                    </list>
4125                                </t>
4126                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4127                                    <list>
4128                                        <t>in case the given map does not exist</t>
4129                                    </list>
4130                                </t>
4131                            </list>
4132                        </t>
4133    
4134                        <t>Example:</t>
4135                        <t>
4136                            <list>
4137                                <t>C: "SET MIDI_INSTRUMENT_MAP NAME 0 'Foo instruments'"</t>
4138                                <t>S: "OK"</t>
4139                            </list>
4140                        </t>
4141                    </section>
4142    
4143                  <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">                  <section title="Create or replace a MIDI instrument map entry" anchor="MAP MIDI_INSTRUMENT">
4144                      <t>The front-end can create a new or replace an existing entry                      <t>The front-end can create a new or replace an existing entry
4145                      in the sampler's MIDI instrument map by sending the following                      in a sampler's MIDI instrument map by sending the following
4146                      command:</t>                      command:</t>
4147                      <t>                      <t>
4148                          <list>                          <list>
4149                              <t>MAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt;                              <t>MAP MIDI_INSTRUMENT &lt;map&gt;
4150                              &lt;midi_bank_lsb&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4151                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4152                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
4153                          </list>                          </list>
4154                      </t>                      </t>
4155                      <t>Where &lt;midi_bank_msb&gt; is an integer value between                      <t>Where &lt;map&gt; is the numeric ID of the map to alter,
4156                      0..127 reflecting the MIDI bank select MSB (coarse) index,                      &lt;midi_bank&gt; is an integer value between
4157                      &lt;midi_bank_lsb&gt; an integer value between 0..127 reflecting                      0..16383 reflecting the MIDI bank select index,
4158                      the MIDI bank select LSB (fine) index, &lt;midi_prog&gt; an                      &lt;midi_prog&gt; an
4159                      integer value between 0..127 reflecting the MIDI program change                      integer value between 0..127 reflecting the MIDI program change
4160                      index, &lt;engine_name&gt; a sampler engine name as returned by                      index, &lt;engine_name&gt; a sampler engine name as returned by
4161                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>                      the <xref target="LIST AVAILABLE_ENGINES">"LIST AVAILABLE_ENGINES"</xref>
4162                      command (not encapsulated into apostrophes), &lt;filename&gt; the name                      command (not encapsulated into apostrophes), &lt;filename&gt; the name
4163                      of the instrument's file to be deployed (encapsulated into apostrophes), &lt;instrument_index&gt; the index (integer value) of the instrument                      of the instrument's file to be deployed (encapsulated into apostrophes),
4164                        &lt;instrument_index&gt; the index (integer value) of the instrument
4165                      within the given file, &lt;volume_value&gt; reflects the master                      within the given file, &lt;volume_value&gt; reflects the master
4166                      volume of the instrument as optionally dotted number (where a                      volume of the instrument as optionally dotted number (where a
4167                      value < 1.0 means attenuation and a value > 1.0 means                      value < 1.0 means attenuation and a value > 1.0 means
# Line 3582  Schoenebeck'> Line 4268  Schoenebeck'>
4268                              </t>                              </t>
4269                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4270                                  <list>                                  <list>
4271                                      <t>when the given engine does not exist or a value                                      <t>when the given map or engine does not exist or a value
4272                                      is out of range</t>                                      is out of range</t>
4273                                  </list>                                  </list>
4274                              </t>                              </t>
# Line 3592  Schoenebeck'> Line 4278  Schoenebeck'>
4278                      <t>Examples:</t>                      <t>Examples:</t>
4279                      <t>                      <t>
4280                          <list>                          <list>
4281                              <t>C: "MAP MIDI_INSTRUMENT 3 0 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>                              <t>C: "MAP MIDI_INSTRUMENT 0 3 0 gig '/usr/share/Steinway D.gig' 0 0.8 PERSISTENT"</t>
4282                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4283                          </list>                          </list>
4284                      </t>                      </t>
4285                      <t>                      <t>
4286                          <list>                          <list>
4287                              <t>C: "MAP MIDI_INSTRUMENT 127 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>                              <t>C: "MAP MIDI_INSTRUMENT 0 4 50 gig '/home/john/foostrings.gig' 7 1.0"</t>
4288                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4289                          </list>                          </list>
4290                      </t>                      </t>
# Line 3606  Schoenebeck'> Line 4292  Schoenebeck'>
4292                          <list>                          <list>
4293                              <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>                              <t>C: "MAP MIDI_INSTRUMENT 0 0 0 gig '/usr/share/piano.gig' 0 1.0 'Normal Piano'"</t>
4294                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4295                              <t>C: "MAP MIDI_INSTRUMENT 1 0 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>                              <t>C: "MAP MIDI_INSTRUMENT 0 1 0 gig '/usr/share/piano.gig' 0 0.25 'Silent Piano'"</t>
4296                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4297                          </list>                          </list>
4298                      </t>                      </t>
4299                      <t>                      <t>
4300                          <list>                          <list>
4301                              <t>C: "MAP MIDI_INSTRUMENT 99 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>                              <t>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4302                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4303                          </list>                          </list>
4304                      </t>                      </t>
4305                  </section>                  </section>
4306    
4307                  <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">                  <section title="Getting ammount of MIDI instrument map entries" anchor="GET MIDI_INSTRUMENTS">
4308                      <t>The front-end can query the amount of currently existing MIDI                      <t>The front-end can query the amount of currently existing
4309                      instrument map entries by sending the following                      entries in a MIDI instrument map by sending the following
4310                      command:</t>                      command:</t>
4311                      <t>                      <t>
4312                          <list>                          <list>
4313                              <t>GET MIDI_INSTRUMENTS</t>                              <t>GET MIDI_INSTRUMENTS &lt;map&gt;</t>
4314                            </list>
4315                        </t>
4316                        <t>The front-end can query the amount of currently existing
4317                        entries in all MIDI instrument maps by sending the following
4318                        command:</t>
4319                        <t>
4320                            <list>
4321                                <t>GET MIDI_INSTRUMENTS ALL</t>
4322                          </list>                          </list>
4323                      </t>                      </t>
4324                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4325                      <t>                      <t>
4326                          <list>                          <list>
4327                              <t>LinuxSampler will answer by sending the current number of                              <t>The sampler will answer by sending the current number of
4328                              entries in the sampler's MIDI instrument map.</t>                              entries in the MIDI instrument map(s).</t>
4329                          </list>                          </list>
4330                      </t>                      </t>
4331    
4332                      <t>Example:</t>                      <t>Example:</t>
4333                      <t>                      <t>
4334                          <list>                          <list>
4335                              <t>C: "GET MIDI_INSTRUMENTS"</t>                              <t>C: "GET MIDI_INSTRUMENTS 0"</t>
4336                              <t>S: "634"</t>                              <t>S: "234"</t>
4337                            </list>
4338                        </t>
4339                        <t>
4340                            <list>
4341                                <t>C: "GET MIDI_INSTRUMENTS ALL"</t>
4342                                <t>S: "954"</t>
4343                          </list>                          </list>
4344                      </t>                      </t>
4345                  </section>                  </section>
4346    
4347                  <section title="Getting indeces of all MIDI instrument map entries" anchor="LIST MIDI_INSTRUMENTS">                  <section title="Getting indeces of all entries of a MIDI instrument map" anchor="LIST MIDI_INSTRUMENTS">
4348                      <t>The front-end can query a list of all currently existing MIDI                      <t>The front-end can query a list of all currently existing
4349                      instrument map entries by sending the following command:</t>                      entries in a certain MIDI instrument map by sending the following
4350                        command:</t>
4351                      <t>                      <t>
4352                          <list>                          <list>
4353                              <t>LIST MIDI_INSTRUMENTS</t>                              <t>LIST MIDI_INSTRUMENTS &lt;map&gt;</t>
4354                          </list>                          </list>
4355                      </t>                      </t>
4356                        <t>Where &lt;map&gt; is the numeric ID of the MIDI instrument map.</t>
4357                        <t>The front-end can query a list of all currently existing
4358                        entries of all MIDI instrument maps by sending the following
4359                        command:</t>
4360                        <t>
4361                            <list>
4362                                <t>LIST MIDI_INSTRUMENTS ALL</t>
4363                            </list>
4364                        </t>
4365    
4366                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
4367                      <t>                      <t>
4368                          <list>                          <list>
4369                              <t>LinuxSampler will answer by sending a comma separated                              <t>The sampler will answer by sending a comma separated
4370                              list of MIDI bank MSB (coarse) - MIDI bank LSB (fine) -                              list of map ID - MIDI bank - MIDI program triples, where
4371                              MIDI program triples, where each triple is encapsulated                              each triple is encapsulated into curly braces. The
4372                              into curly braces. The list is returned in one single                              list is returned in one single line. Each triple
4373                              line. Each triple just reflects the key of the respective                              just reflects the key of the respective map entry,
4374                              map entry, thus subsequent                              thus subsequent
4375                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>                              <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>
4376                              command(s) are necessary to retrieve detailed informations                              command(s) are necessary to retrieve detailed informations
4377                              about each entry.</t>                              about each entry.</t>
# Line 3670  Schoenebeck'> Line 4381  Schoenebeck'>
4381                      <t>Example:</t>                      <t>Example:</t>
4382                      <t>                      <t>
4383                          <list>                          <list>
4384                              <t>C: "LIST MIDI_INSTRUMENTS"</t>                              <t>C: "LIST MIDI_INSTRUMENTS 0"</t>
4385                              <t>S: "{0,0,0},{0,0,1},{120,0,3},{120,0,4},{23,127,127}"</t>                              <t>S: "{0,0,0},{0,0,1},{0,0,3},{0,1,4},{1,127,127}"</t>
4386                          </list>                          </list>
4387                      </t>                      </t>
4388                  </section>                  </section>
4389    
4390                  <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">                  <section title="Remove an entry from the MIDI instrument map" anchor="UNMAP MIDI_INSTRUMENT">
4391                      <t>The front-end can delete an entry from the MIDI instrument                      <t>The front-end can delete an entry from a MIDI instrument
4392                      map by sending the following command:</t>                      map by sending the following command:</t>
4393                      <t>                      <t>
4394                          <list>                          <list>
4395                              <t>UNMAP MIDI_INSTRUMENT &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>                              <t>UNMAP MIDI_INSTRUMENT &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4396                          </list>                          </list>
4397                      </t>                      </t>
4398                      <t>                      <t>
4399                      Where &lt;midi_bank_msb&gt; is an integer value between 0..127                      Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4400                      reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;                      &lt;midi_bank&gt; is an integer value between 0..16383
4401                      an integer value between 0..127 reflecting the MIDI bank LSB                      reflecting the MIDI bank value and
4402                      (fine) value and &lt;midi_prog&gt; an integer value between                      &lt;midi_prog&gt; an integer value between
4403                      0..127 reflecting the MIDI program value of the map entrie's key                      0..127 reflecting the MIDI program value of the map's entrie's key
4404                      index triple.                      index triple.
4405                      </t>                      </t>
4406    
# Line 3712  Schoenebeck'> Line 4423  Schoenebeck'>
4423                      <t>Example:</t>                      <t>Example:</t>
4424                      <t>                      <t>
4425                          <list>                          <list>
4426                              <t>C: "UNMAP MIDI_INSTRUMENT 2 40 127"</t>                              <t>C: "UNMAP MIDI_INSTRUMENT 0 2 127"</t>
4427                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4428                          </list>                          </list>
4429                      </t>                      </t>
# Line 3723  Schoenebeck'> Line 4434  Schoenebeck'>
4434                      instrument map entry by sending the following command:</t>                      instrument map entry by sending the following command:</t>
4435                      <t>                      <t>
4436                          <list>                          <list>
4437                              <t>GET MIDI_INSTRUMENT INFO &lt;midi_bank_msb&gt; &lt;midi_bank_lsb&gt; &lt;midi_prog&gt;</t>                              <t>GET MIDI_INSTRUMENT INFO &lt;map&gt; &lt;midi_bank&gt; &lt;midi_prog&gt;</t>
4438                          </list>                          </list>
4439                      </t>                      </t>
4440                      <t>                      <t>
4441                      Where &lt;midi_bank_msb&gt; is an integer value between 0..127                      Where &lt;map&gt; is the numeric ID of the MIDI instrument map,
4442                      reflecting the MIDI bank MSB (coarse) value, &lt;midi_bank_lsb&gt;                      &lt;midi_bank&gt; is an integer value between 0..16383
4443                      an integer value between 0..127 reflecting the MIDI bank LSB                      reflecting the MIDI bank value, &lt;midi_bank&gt;
4444                      (fine) value and &lt;midi_prog&gt; an integer value between                      and &lt;midi_prog&gt; an integer value between
4445                      0..127 reflecting the MIDI program value of the map entrie's key                      0..127 reflecting the MIDI program value of the map's entrie's key
4446                      index triple.                      index triple.
4447                      </t>                      </t>
4448    
# Line 3797  Schoenebeck'> Line 4508  Schoenebeck'>
4508                      <t>Example:</t>                      <t>Example:</t>
4509                      <t>                      <t>
4510                          <list>                          <list>
4511                              <t>C: "GET MIDI_INSTRUMENT INFO 3 45 120"</t>                              <t>C: "GET MIDI_INSTRUMENT INFO 1 45 120"</t>
4512                              <t>S: "NAME: Drums for Foo Song"</t>                              <t>S: "NAME: Drums for Foo Song"</t>
4513                              <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>                              <t>&nbsp;&nbsp;&nbsp;"ENGINE_NAME: GigEngine"</t>
4514                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>                              <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_FILE: /usr/share/joesdrumkit.gig"</t>
# Line 3811  Schoenebeck'> Line 4522  Schoenebeck'>
4522                  </section>                  </section>
4523    
4524                  <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">                  <section title="Clear MIDI instrument map" anchor="CLEAR MIDI_INSTRUMENTS">
4525                      <t>The front-end can clear the whole MIDI instrument map, that                      <t>The front-end can clear a whole MIDI instrument map, that
4526                      is delete all entries by sending the following command:</t>                      is delete all its entries by sending the following command:</t>
4527                        <t>
4528                            <list>
4529                                <t>CLEAR MIDI_INSTRUMENTS &lt;map&gt;</t>
4530                            </list>
4531                        </t>
4532                        <t>Where &lt;map&gt; is the numeric ID of the map to clear.</t>
4533                        <t>The front-end can clear all MIDI instrument maps, that
4534                        is delete all entries of all maps by sending the following
4535                        command:</t>
4536                      <t>                      <t>
4537                          <list>                          <list>
4538                              <t>CLEAR MIDI_INSTRUMENTS</t>                              <t>CLEAR MIDI_INSTRUMENTS ALL</t>
4539                          </list>                          </list>
4540                      </t>                      </t>
4541                        <t>The command "CLEAR MIDI_INSTRUMENTS ALL" does not delete the
4542                        maps, only their entries, thus the map's settings like
4543                        custom name will be preservevd.</t>
4544    
4545                     <t>Possible Answers:</t>                     <t>Possible Answers:</t>
4546                      <t>                      <t>
# Line 3830  Schoenebeck'> Line 4553  Schoenebeck'>
4553                          </list>                          </list>
4554                      </t>                      </t>
4555    
4556                      <t>Example:</t>                      <t>Examples:</t>
4557                      <t>                      <t>
4558                         <list>                         <list>
4559                              <t>C: "CLEAR MIDI_INSTRUMENTS"</t>                              <t>C: "CLEAR MIDI_INSTRUMENTS 0"</t>
4560                                <t>S: "OK"</t>
4561                            </list>
4562                        </t>
4563                        <t>
4564                           <list>
4565                                <t>C: "CLEAR MIDI_INSTRUMENTS ALL"</t>
4566                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4567                          </list>                          </list>
4568                      </t>                      </t>
# Line 3891  Schoenebeck'> Line 4620  Schoenebeck'>
4620  </t>  </t>
4621  <t>command =  <t>command =
4622          <list>          <list>
4623                  <t>ADD SP CHANNEL                  <t>ADD SP add_instruction
4624                  </t>                  </t>
4625                  <t>/ MAP SP map_instruction                  <t>/ MAP SP map_instruction
4626                  </t>                  </t>
# Line 3908  Schoenebeck'> Line 4637  Schoenebeck'>
4637                  <t>/ LOAD SP load_instruction                  <t>/ LOAD SP load_instruction
4638                  </t>                  </t>
4639                  <t>/ REMOVE SP remove_instruction                  <t>/ REMOVE SP remove_instruction
   
4640                  </t>                  </t>
4641                  <t>/ SET SP set_instruction                  <t>/ SET SP set_instruction
4642                  </t>                  </t>
# Line 3928  Schoenebeck'> Line 4656  Schoenebeck'>
4656                  </t>                  </t>
4657          </list>          </list>
4658  </t>  </t>
4659    <t>add_instruction =
4660            <list>
4661                    <t>CHANNEL
4662                    </t>
4663                    <t>/ MIDI_INSTRUMENT_MAP
4664                    </t>
4665                    <t>/ MIDI_INSTRUMENT_MAP SP map_name
4666                    </t>
4667            </list>
4668    </t>
4669  <t>subscribe_event =  <t>subscribe_event =
4670          <list>          <list>
4671                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4672                    </t>
4673                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4674                    </t>
4675                    <t>/ MIDI_INPUT_DEVICE_COUNT
4676                    </t>
4677                    <t>/ MIDI_INPUT_DEVICE_INFO
4678                    </t>
4679                    <t>/ CHANNEL_COUNT
4680                  </t>                  </t>
4681                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4682                  </t>                  </t>
# Line 3940  Schoenebeck'> Line 4686  Schoenebeck'>
4686                  </t>                  </t>
4687                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4688                  </t>                  </t>
4689                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4690                    </t>
4691                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4692                    </t>
4693                    <t>/ MIDI_INSTRUMENT_COUNT
4694                    </t>
4695                    <t>/ MIDI_INSTRUMENT_INFO
4696                    </t>
4697                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4698                  </t>                  </t>
4699                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 3948  Schoenebeck'> Line 4702  Schoenebeck'>
4702  </t>  </t>
4703  <t>unsubscribe_event =  <t>unsubscribe_event =
4704          <list>          <list>
4705                  <t>CHANNEL_COUNT                  <t>AUDIO_OUTPUT_DEVICE_COUNT
4706                    </t>
4707                    <t>/ AUDIO_OUTPUT_DEVICE_INFO
4708                    </t>
4709                    <t>/ MIDI_INPUT_DEVICE_COUNT
4710                    </t>
4711                    <t>/ MIDI_INPUT_DEVICE_INFO
4712                    </t>
4713                    <t>/ CHANNEL_COUNT
4714                  </t>                  </t>
4715                  <t>/ VOICE_COUNT                  <t>/ VOICE_COUNT
4716                  </t>                  </t>
# Line 3958  Schoenebeck'> Line 4720  Schoenebeck'>
4720                  </t>                  </t>
4721                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
4722                  </t>                  </t>
4723                    <t>/ MIDI_INSTRUMENT_MAP_COUNT
4724                    </t>
4725                    <t>/ MIDI_INSTRUMENT_MAP_INFO
4726                    </t>
4727                    <t>/ MIDI_INSTRUMENT_COUNT
4728                    </t>
4729                    <t>/ MIDI_INSTRUMENT_INFO
4730                    </t>
4731                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
4732                  </t>                  </t>
4733                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 3966  Schoenebeck'> Line 4736  Schoenebeck'>
4736  </t>  </t>
4737  <t>map_instruction =  <t>map_instruction =
4738          <list>          <list>
4739                  <t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value                  <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
4740                  </t>                  </t>
4741                  <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode                  <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
4742                  </t>                  </t>
4743                  <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name                  <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
4744                  </t>                  </t>
4745                  <t>/ MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb 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 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
4746                  </t>                  </t>
4747          </list>          </list>
4748  </t>  </t>
4749  <t>unmap_instruction =  <t>unmap_instruction =
4750          <list>          <list>
4751                  <t>MIDI_INSTRUMENT SP midi_bank_msb SP midi_bank_lsb SP midi_prog                  <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog
4752                  </t>                  </t>
4753          </list>          </list>
4754  </t>  </t>
# Line 3986  Schoenebeck'> Line 4756  Schoenebeck'>
4756          <list>          <list>
4757                  <t>CHANNEL SP sampler_channel                  <t>CHANNEL SP sampler_channel
4758                  </t>                  </t>
4759                    <t>/ MIDI_INSTRUMENT_MAP SP midi_map
4760                    </t>
4761                    <t>/ MIDI_INSTRUMENT_MAP SP ALL
4762                    </t>
4763          </list>          </list>
4764  </t>  </t>
4765  <t>get_instruction =  <t>get_instruction =
# Line 4042  Schoenebeck'> Line 4816  Schoenebeck'>
4816                  </t>                  </t>
4817                  <t>/ TOTAL_VOICE_COUNT_MAX                  <t>/ TOTAL_VOICE_COUNT_MAX
4818                  </t>                  </t>
4819                  <t>/ MIDI_INSTRUMENTS                  <t>/ MIDI_INSTRUMENTS SP midi_map
4820                    </t>
4821                    <t>/ MIDI_INSTRUMENTS SP ALL
4822                  </t>                  </t>
4823                  <t>/ MIDI_INSTRUMENT SP INFO SP midi_bank_msb SP midi_bank_lsb SP midi_prog                  <t>/ MIDI_INSTRUMENT SP INFO SP midi_map SP midi_bank SP midi_prog
4824                    </t>
4825                    <t>/ MIDI_INSTRUMENT_MAPS
4826                    </t>
4827                    <t>/ MIDI_INSTRUMENT_MAP SP INFO SP midi_map
4828                    </t>
4829                    <t>/ FX_SENDS SP sampler_channel
4830                    </t>
4831                    <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
4832                    </t>
4833                    <t>/ VOLUME
4834                  </t>                  </t>
4835          </list>          </list>
4836  </t>  </t>
# Line 4060  Schoenebeck'> Line 4846  Schoenebeck'>
4846                  </t>                  </t>
4847                  <t>/ CHANNEL SP set_chan_instruction                  <t>/ CHANNEL SP set_chan_instruction
4848                  </t>                  </t>
4849                    <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
4850                    </t>
4851                    <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
4852                    </t>
4853                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
4854                  </t>                  </t>
4855                    <t>/ VOLUME SP volume_value
4856                    </t>
4857          </list>          </list>
4858  </t>  </t>
4859  <t>create_instruction =  <t>create_instruction =
# Line 4074  Schoenebeck'> Line 4866  Schoenebeck'>
4866                  </t>                  </t>
4867                  <t>/ MIDI_INPUT_DEVICE SP string                  <t>/ MIDI_INPUT_DEVICE SP string
4868                  </t>                  </t>
4869                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl
4870                    </t>
4871                    <t>/ FX_SEND SP sampler_channel SP midi_ctrl SP fx_send_name
4872                    </t>
4873          </list>          </list>
4874  </t>  </t>
4875  <t>reset_instruction =  <t>reset_instruction =
# Line 4084  Schoenebeck'> Line 4880  Schoenebeck'>
4880  </t>  </t>
4881  <t>clear_instruction =  <t>clear_instruction =
4882          <list>          <list>
4883                  <t>MIDI_INSTRUMENTS                  <t>MIDI_INSTRUMENTS SP midi_map
4884                    </t>
4885                    <t>/ MIDI_INSTRUMENTS SP ALL
4886                  </t>                  </t>
4887          </list>          </list>
4888  </t>  </t>
# Line 4094  Schoenebeck'> Line 4892  Schoenebeck'>
4892                  </t>                  </t>
4893                  <t>/ MIDI_INPUT_DEVICE SP number                  <t>/ MIDI_INPUT_DEVICE SP number
4894                  </t>                  </t>
4895                    <t>/ FX_SEND SP sampler_channel SP fx_send_id
4896                    </t>
4897          </list>          </list>
4898  </t>  </t>
4899  <t>load_instruction =  <t>load_instruction =
# Line 4128  Schoenebeck'> Line 4928  Schoenebeck'>
4928                  </t>                  </t>
4929                  <t>/ SOLO SP sampler_channel SP boolean                  <t>/ SOLO SP sampler_channel SP boolean
4930                  </t>                  </t>
4931                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP midi_map
4932                    </t>
4933                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP NONE
4934                    </t>
4935                    <t>/ MIDI_INSTRUMENT_MAP SP sampler_channel SP DEFAULT
4936                    </t>
4937          </list>          </list>
4938  </t>  </t>
4939  <t>key_val_list =  <t>key_val_list =
# Line 4160  Schoenebeck'> Line 4966  Schoenebeck'>
4966                  </t>                  </t>
4967                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS                  <t>/ AVAILABLE_AUDIO_OUTPUT_DRIVERS
4968                  </t>                  </t>
4969                  <t>/ MIDI_INSTRUMENTS                  <t>/ MIDI_INSTRUMENTS SP midi_map
4970                    </t>
4971                    <t>/ MIDI_INSTRUMENTS SP ALL
4972                    </t>
4973                    <t>/ MIDI_INSTRUMENT_MAPS
4974                    </t>
4975                    <t>/ FX_SENDS SP sampler_channel
4976                  </t>                  </t>
4977          </list>          </list>
4978  </t>  </t>
# Line 4226  Schoenebeck'> Line 5038  Schoenebeck'>
5038                  </t>                  </t>
5039          </list>          </list>
5040  </t>  </t>
5041  <t>midi_bank_msb =  <t>midi_map =
5042          <list>          <list>
5043                  <t>number                  <t>number
5044                  </t>                  </t>
5045          </list>          </list>
5046  </t>  </t>
5047  <t>midi_bank_lsb =  <t>midi_bank =
5048          <list>          <list>
5049                  <t>number                  <t>number
5050                  </t>                  </t>
# Line 4244  Schoenebeck'> Line 5056  Schoenebeck'>
5056                  </t>                  </t>
5057          </list>          </list>
5058  </t>  </t>
5059    <t>midi_ctrl =
5060            <list>
5061                    <t>number
5062                    </t>
5063            </list>
5064    </t>
5065  <t>volume_value =  <t>volume_value =
5066          <list>          <list>
5067                  <t>dotnum                  <t>dotnum
# Line 4264  Schoenebeck'> Line 5082  Schoenebeck'>
5082                  </t>                  </t>
5083          </list>          </list>
5084  </t>  </t>
5085    <t>fx_send_id =
5086            <list>
5087                    <t>number
5088                    </t>
5089            </list>
5090    </t>
5091  <t>engine_name =  <t>engine_name =
5092          <list>          <list>
5093                  <t>string                  <t>string
# Line 4276  Schoenebeck'> Line 5100  Schoenebeck'>
5100                  </t>                  </t>
5101          </list>          </list>
5102  </t>  </t>
5103    <t>map_name =
5104            <list>
5105                    <t>stringval
5106                    </t>
5107            </list>
5108    </t>
5109  <t>entry_name =  <t>entry_name =
5110          <list>          <list>
5111                  <t>stringval                  <t>stringval
5112                  </t>                  </t>
5113          </list>          </list>
5114  </t>  </t>
5115    <t>fx_send_name =
5116            <list>
5117                    <t>stringval
5118                    </t>
5119            </list>
5120    </t>
5121  <t>param_val_list =  <t>param_val_list =
5122          <list>          <list>
5123                  <t>param_val                  <t>param_val
# Line 4309  Schoenebeck'> Line 5145  Schoenebeck'>
5145          <section title="Events" anchor="events">          <section title="Events" anchor="events">
5146              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>              <t>This chapter will describe all currently defined events supported by LinuxSampler.</t>
5147    
5148              <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL">              <section title="Number of audio output devices changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT">
5149                    <t>Client may want to be notified when the total number of audio output devices on the
5150                    back-end changes by issuing the following command:</t>
5151                    <t>
5152                        <list>
5153                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_COUNT</t>
5154                        </list>
5155                    </t>
5156                    <t>Server will start sending the following notification messages:</t>
5157                    <t>
5158                        <list>
5159                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
5160                        </list>
5161                    </t>
5162                    <t>where &lt;devices&gt; will be replaced by the new number
5163                    of audio output devices.</t>
5164                </section>
5165    
5166                <section title="Audio output device's settings changed" anchor="SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO">
5167                    <t>Client may want to be notified when changes were made to audio output devices on the
5168                    back-end by issuing the following command:</t>
5169                    <t>
5170                        <list>
5171                            <t>SUBSCRIBE AUDIO_OUTPUT_DEVICE_INFO</t>
5172                        </list>
5173                    </t>
5174                    <t>Server will start sending the following notification messages:</t>
5175                    <t>
5176                        <list>
5177                            <t>"NOTIFY:AUDIO_OUTPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
5178                        </list>
5179                    </t>
5180                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the audio output device,
5181                    which settings has been changed. The front-end will have to send
5182                    the respective command to actually get the audio output device info. Because these messages
5183                    will be triggered by LSCP commands issued by other clients rather than real
5184                    time events happening on the server, it is believed that an empty notification
5185                    message is sufficient here.</t>
5186                </section>
5187    
5188                <section title="Number of MIDI input devices changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_COUNT">
5189                    <t>Client may want to be notified when the total number of MIDI input devices on the
5190                    back-end changes by issuing the following command:</t>
5191                    <t>
5192                        <list>
5193                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_COUNT</t>
5194                        </list>
5195                    </t>
5196                    <t>Server will start sending the following notification messages:</t>
5197                    <t>
5198                        <list>
5199                            <t>"NOTIFY:MIDI_INPUT_DEVICE_COUNT:&lt;devices&gt;"</t>
5200                        </list>
5201                    </t>
5202                    <t>where &lt;devices&gt; will be replaced by the new number
5203                    of MIDI input devices.</t>
5204                </section>
5205    
5206                <section title="MIDI input device's settings changed" anchor="SUBSCRIBE MIDI_INPUT_DEVICE_INFO">
5207                    <t>Client may want to be notified when changes were made to MIDI input devices on the
5208                    back-end by issuing the following command:</t>
5209                    <t>
5210                        <list>
5211                            <t>SUBSCRIBE MIDI_INPUT_DEVICE_INFO</t>
5212                        </list>
5213                    </t>
5214                    <t>Server will start sending the following notification messages:</t>
5215                    <t>
5216                        <list>
5217                            <t>"NOTIFY:MIDI_INPUT_DEVICE_INFO:&lt;device-id&gt;"</t>
5218                        </list>
5219                    </t>
5220                    <t>where &lt;device-id&gt; will be replaced by the numerical ID of the MIDI input device,
5221                    which settings has been changed. The front-end will have to send
5222                    the respective command to actually get the MIDI input device info. Because these messages
5223                    will be triggered by LSCP commands issued by other clients rather than real
5224                    time events happening on the server, it is believed that an empty notification
5225                    message is sufficient here.</t>
5226                </section>
5227    
5228                <section title="Number of sampler channels changed" anchor="SUBSCRIBE CHANNEL_COUNT">
5229                  <t>Client may want to be notified when the total number of channels on the                  <t>Client may want to be notified when the total number of channels on the
5230                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
5231                  <t>                  <t>
# Line 4386  Schoenebeck'> Line 5302  Schoenebeck'>
5302                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>                  "GET CHANNEL BUFFER_FILL PERCENTAGE"</xref> command was issued on this channel.</t>
5303              </section>              </section>
5304    
5305              <section title="Channel information changed" anchor="SUBSCRIBE INFO">              <section title="Channel information changed" anchor="SUBSCRIBE CHANNEL_INFO">
5306                  <t>Client may want to be notified when changes were made to sampler channels on the                  <t>Client may want to be notified when changes were made to sampler channels on the
5307                  back-end by issuing the following command:</t>                  back-end by issuing the following command:</t>
5308                  <t>                  <t>
# Line 4426  Schoenebeck'> Line 5342  Schoenebeck'>
5342                  all currently active voices.</t>                  all currently active voices.</t>
5343              </section>              </section>
5344    
5345                <section title="Number of MIDI instrument maps changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT">
5346                    <t>Client may want to be notified when the number of MIDI instrument maps on the
5347                    back-end changes by issuing the following command:</t>
5348                    <t>
5349                        <list>
5350                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_COUNT</t>
5351                        </list>
5352                    </t>
5353                    <t>Server will start sending the following notification messages:</t>
5354                    <t>
5355                        <list>
5356                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_COUNT:&lt;maps&gt;"</t>
5357                        </list>
5358                    </t>
5359                    <t>where &lt;maps&gt; will be replaced by the new number
5360                    of MIDI instrument maps.</t>
5361                </section>
5362    
5363                <section title="MIDI instrument map information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO">
5364                    <t>Client may want to be notified when changes were made to MIDI instrument maps on the
5365                    back-end by issuing the following command:</t>
5366                    <t>
5367                        <list>
5368                            <t>SUBSCRIBE MIDI_INSTRUMENT_MAP_INFO</t>
5369                        </list>
5370                    </t>
5371                    <t>Server will start sending the following notification messages:</t>
5372                    <t>
5373                        <list>
5374                            <t>"NOTIFY:MIDI_INSTRUMENT_MAP_INFO:&lt;map-id&gt;"</t>
5375                        </list>
5376                    </t>
5377                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5378                    for which information changes occurred. The front-end will have to send
5379                    the respective command to actually get the MIDI instrument map info. Because these messages
5380                    will be triggered by LSCP commands issued by other clients rather than real
5381                    time events happening on the server, it is believed that an empty notification
5382                    message is sufficient here.</t>
5383                </section>
5384    
5385                <section title="Number of MIDI instruments changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_COUNT">
5386                    <t>Client may want to be notified when the number of MIDI instrument maps on the
5387                    back-end changes by issuing the following command:</t>
5388                    <t>
5389                        <list>
5390                            <t>SUBSCRIBE MIDI_INSTRUMENT_COUNT</t>
5391                        </list>
5392                    </t>
5393                    <t>Server will start sending the following notification messages:</t>
5394                    <t>
5395                        <list>
5396                            <t>"NOTIFY:MIDI_INSTRUMENT_COUNT:&lt;map-id&gt; &lt;instruments&gt;"</t>
5397                        </list>
5398                    </t>
5399                    <t>where &lt;map-id&gt; is the numerical ID of the MIDI instrument map, in which
5400                    the nuber of instruments has changed and &lt;instruments&gt; will be replaced by
5401                    the new number of MIDI instruments in the specified map.</t>
5402                </section>
5403    
5404                <section title="MIDI instrument information changed" anchor="SUBSCRIBE MIDI_INSTRUMENT_INFO">
5405                    <t>Client may want to be notified when changes were made to MIDI instruments on the
5406                    back-end by issuing the following command:</t>
5407                    <t>
5408                        <list>
5409                            <t>SUBSCRIBE MIDI_INSTRUMENT_INFO</t>
5410                        </list>
5411                    </t>
5412                    <t>Server will start sending the following notification messages:</t>
5413                    <t>
5414                        <list>
5415                            <t>"NOTIFY:MIDI_INSTRUMENT_INFO:&lt;map-id&gt; &lt;bank&gt; &lt;program&gt;"</t>
5416                        </list>
5417                    </t>
5418                    <t>where &lt;map-id&gt; will be replaced by the numerical ID of the MIDI instrument map,
5419                    in which a MIDI instrument is changed. &lt;bank&gt; and &lt;program&gt; specifies
5420                    the location of the changed MIDI instrument in the map. The front-end will have to send
5421                    the respective command to actually get the MIDI instrument info. Because these messages
5422                    will be triggered by LSCP commands issued by other clients rather than real
5423                    time events happening on the server, it is believed that an empty notification
5424                    message is sufficient here.</t>
5425                </section>
5426    
5427              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
5428                  <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
5429                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.944  
changed lines
  Added in v.1005
  ViewVC Help
Powered by ViewVC