/[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 1027 by schoenebeck, Sun Jan 14 17:31:48 2007 UTC revision 1161 by iliev, Mon Apr 16 15:51:18 2007 UTC
# Line 34  Schoenebeck'> Line 34  Schoenebeck'>
34                  <email>schoenebeck at software minus engineering dot org</email>                  <email>schoenebeck at software minus engineering dot org</email>
35              </address>              </address>
36          </author>          </author>
37          <date month="January" year="2007"/>          <date month="April" year="2007"/>
38          <workgroup>LinuxSampler Developers</workgroup>          <workgroup>LinuxSampler Developers</workgroup>
39          <keyword>LSCP</keyword>          <keyword>LSCP</keyword>
40          <abstract>          <abstract>
# Line 3479  Schoenebeck'> Line 3479  Schoenebeck'>
3479                      </t>                      </t>
3480                  </section>                  </section>
3481    
3482                    <section title="Changing effect send's name" anchor="SET FX_SEND NAME">
3483                        <t>The front-end can alter the current name of an effect
3484                        send entity by sending the following command:</t>
3485                        <t>
3486                            <list>
3487                                <t>SET FX_SEND NAME &lt;sampler-chan&gt; &lt;fx-send-id&gt; &lt;name&gt;</t>
3488                            </list>
3489                        </t>
3490                        <t>Where &lt;sampler-chan&gt; is the sampler channel number
3491                        as returned by the <xref target="ADD CHANNEL">"ADD CHANNEL"</xref>
3492                        or <xref target="LIST CHANNELS">"LIST CHANNELS"</xref> command,
3493                        &lt;fx-send-id&gt; reflects the numerical ID of the effect send entity
3494                        as returned by the <xref target="CREATE FX_SEND">"CREATE FX_SEND"</xref>
3495                        or <xref target="LIST FX_SENDS">"LIST FX_SENDS"</xref> command and
3496                        &lt;name&gt; is the new name of the effect send entity, which
3497                        does not have to be unique.</t>
3498    
3499                        <t>Possible Answers:</t>
3500                        <t>
3501                            <list>
3502                                <t>"OK" -
3503                                    <list>
3504                                        <t>on success</t>
3505                                    </list>
3506                                </t>
3507                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
3508                                    <list>
3509                                        <t>in case it failed, providing an appropriate error code and error message</t>
3510                                    </list>
3511                                </t>
3512                            </list>
3513                        </t>
3514                        <t>Example:</t>
3515                        <t>
3516                            <list>
3517                                <t>C: "SET FX_SEND NAME 0 0 'Fx Send 1'"</t>
3518                                <t>S: "OK"</t>
3519                            </list>
3520                        </t>
3521                    </section>
3522    
3523                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">                  <section title="Altering effect send's audio routing" anchor="SET FX_SEND AUDIO_OUTPUT_CHANNEL">
3524                      <t>The front-end can alter the destination of an effect send's audio channel on a specific                      <t>The front-end can alter the destination of an effect send's audio channel on a specific
3525                      sampler channel by sending the following command:</t>                      sampler channel by sending the following command:</t>
# Line 3918  Schoenebeck'> Line 3959  Schoenebeck'>
3959                                              complies with (see <xref target="LSCP versioning" /> for details)</t>                                              complies with (see <xref target="LSCP versioning" /> for details)</t>
3960                                          </list>                                          </list>
3961                                      </t>                                      </t>
3962                                        <t>INSTRUMENTS_DB_SUPPORT -
3963                                            <list>
3964                                                <t>either yes or no, specifies whether the
3965                                                sampler is build with instruments database support.</t>
3966                                            </list>
3967                                        </t>
3968                                  </list>                                  </list>
3969                              </t>                              </t>
3970                          </list>                          </list>
# Line 4198  Schoenebeck'> Line 4245  Schoenebeck'>
4245                                              which does not have to be unique</t>                                              which does not have to be unique</t>
4246                                          </list>                                          </list>
4247                                      </t>                                      </t>
4248                                        <t>DEFAULT -
4249                                            <list>
4250                                                <t>either true or false,
4251                                                defines whether this map is the default map</t>
4252                                            </list>
4253                                        </t>
4254                                  </list>                                  </list>
4255                              </t>                              </t>
4256                          </list>                          </list>
# Line 4209  Schoenebeck'> Line 4262  Schoenebeck'>
4262                          <list>                          <list>
4263                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>                              <t>C: "GET MIDI_INSTRUMENT_MAP INFO 0"</t>
4264                              <t>S: "NAME: Standard Map"</t>                              <t>S: "NAME: Standard Map"</t>
4265                                <t>&nbsp;&nbsp;&nbsp;"DEFAULT: true"</t>
4266                              <t>&nbsp;&nbsp;&nbsp;"."</t>                              <t>&nbsp;&nbsp;&nbsp;"."</t>
4267                          </list>                          </list>
4268                      </t>                      </t>
# Line 4257  Schoenebeck'> Line 4311  Schoenebeck'>
4311                      command:</t>                      command:</t>
4312                      <t>                      <t>
4313                          <list>                          <list>
4314                              <t>MAP MIDI_INSTRUMENT &lt;map&gt;                              <t>MAP MIDI_INSTRUMENT [NON_MODAL] &lt;map&gt;
4315                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;                              &lt;midi_bank&gt; &lt;midi_prog&gt; &lt;engine_name&gt;
4316                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;                              &lt;filename&gt; &lt;instrument_index&gt; &lt;volume_value&gt;
4317                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>                              [&lt;instr_load_mode&gt;] [&lt;name&gt;]</t>
# Line 4310  Schoenebeck'> Line 4364  Schoenebeck'>
4364                              <t>"PERSISTENT" -                              <t>"PERSISTENT" -
4365                                  <list>                                  <list>
4366                                      <t>The instrument will immediately be loaded                                      <t>The instrument will immediately be loaded
4367                                      into memory in the background when this mapping                                      into memory when this mapping
4368                                      command is sent and the instrument is kept all                                      command is sent and the instrument is kept all
4369                                      the time. Instruments with this mode are                                      the time. Instruments with this mode are
4370                                      only freed when the sampler is reset or all                                      only freed when the sampler is reset or all
# Line 4360  Schoenebeck'> Line 4414  Schoenebeck'>
4414                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).                      <xref target="GET MIDI_INSTRUMENT INFO">"GET MIDI_INSTRUMENT INFO"</xref>).
4415                      </t>                      </t>
4416                      <t>                      <t>
4417                      The "MAP MIDI_INSTRUMENT" command                      By default, "MAP MIDI_INSTRUMENT" commands block until the mapping is
4418                      will immediately return, thus it will not block when an                      completely established in the sampler. The OPTIONAL "NON_MODAL" argument
4419                      instrument is to be loaded due to a "PERSISTENT" type                      however causes the respective "MAP MIDI_INSTRUMENT" command to return
4420                      entry as instruments are loaded in the background. As a                      immediately, that is to let the sampler establish the mapping in the
4421                      consequence this command may not necessarily return an error                      background. So this argument might be especially useful for mappings with
4422                      i.e. when the given instrument file does not exist or may                      a "PERSISTENT" type, because these have to load the respective instruments
4423                      turn out to be corrupt.                      immediately and might thus block for a very long time. It is recommended
4424                        however to use the OPTIONAL "NON_MODAL" argument only if really necessary,
4425                        because it has the following drawbacks: as "NON_MODAL" instructions return
4426                        immediately, they may not necessarily return an error i.e. when the given
4427                        instrument file turns out to be corrupt, beside that subsequent commands
4428                        in a LSCP instruction sequence might fail, because mandatory mappings are
4429                        not yet completed.
4430                      </t>                      </t>
4431    
4432                      <t>Possible Answers:</t>                      <t>Possible Answers:</t>
# Line 4409  Schoenebeck'> Line 4469  Schoenebeck'>
4469                      </t>                      </t>
4470                      <t>                      <t>
4471                          <list>                          <list>
4472                              <t>C: "MAP MIDI_INSTRUMENT 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>                              <t>C: "MAP MIDI_INSTRUMENT NON_MODAL 1 8 120 gig '/home/joe/foodrums.gig' 0 1.0 PERSISTENT 'Foo Drumkit'"</t>
4473                              <t>S: "OK"</t>                              <t>S: "OK"</t>
4474                          </list>                          </list>
4475                      </t>                      </t>
# Line 4680  Schoenebeck'> Line 4740  Schoenebeck'>
4740                  </section>                  </section>
4741              </section>              </section>
4742    
4743    
4744                <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4745                    <t>The following commands describe how to use and manage
4746                    the instruments database.</t>
4747    
4748                    <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4749                        <t>The front-end can add a new instrument directory to the
4750                        instruments database by sending the following command:</t>
4751                        <t>
4752                            <list>
4753                                <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
4754                            </list>
4755                        </t>
4756                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4757                        to be created (encapsulated into apostrophes).</t>
4758    
4759                        <t>Possible Answers:</t>
4760                        <t>
4761                            <list>
4762                                <t>"OK" -
4763                                    <list>
4764                                        <t>on success</t>
4765                                    </list>
4766                                </t>
4767                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4768                                    <list>
4769                                        <t>when the directory could not be created, which
4770                                        can happen if the directory already exists or the
4771                                        name contains not allowed symbols</t>
4772                                    </list>
4773                                </t>
4774                            </list>
4775                        </t>
4776    
4777                        <t>Examples:</t>
4778                        <t>
4779                            <list>
4780                                <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
4781                                <t>S: "OK"</t>
4782                            </list>
4783                        </t>
4784                    </section>
4785    
4786                    <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
4787                        <t>The front-end can delete a particular instrument directory
4788                        from the instruments database by sending the following command:</t>
4789                        <t>
4790                            <list>
4791                                <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
4792                            </list>
4793                        </t>
4794                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4795                        to delete. The optional FORCE argument can be used to
4796                        force the deletion of a non-empty directory and all its content.</t>
4797    
4798                        <t>Possible Answers:</t>
4799                        <t>
4800                            <list>
4801                                <t>"OK" -
4802                                    <list>
4803                                        <t>if the directory is deleted successfully</t>
4804                                    </list>
4805                                </t>
4806                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4807                                    <list>
4808                                        <t>if the given directory does not exist, or
4809                                        if trying to delete a non-empty directory,
4810                                        without using the FORCE argument.</t>
4811                                    </list>
4812                                </t>
4813                            </list>
4814                        </t>
4815    
4816                        <t>Examples:</t>
4817                        <t>
4818                            <list>
4819                                <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
4820                                <t>S: "OK"</t>
4821                            </list>
4822                        </t>
4823                    </section>
4824    
4825                    <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
4826                        <t>The front-end can retrieve the current amount of
4827                        directories in a specific directory by sending the following command:</t>
4828                        <t>
4829                            <list>
4830                                <t>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>
4831                            </list>
4832                        </t>
4833                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4834                        name of the directory.</t>
4835    
4836                        <t>Possible Answers:</t>
4837                        <t>
4838                            <list>
4839                                <t>The current number of instrument directories
4840                                in the specified directory.</t>
4841                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4842                                    <list>
4843                                        <t>if the given directory does not exist.</t>
4844                                    </list>
4845                                </t>
4846                            </list>
4847                        </t>
4848    
4849                        <t>Example:</t>
4850                        <t>
4851                            <list>
4852                                <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
4853                                <t>S: "2"</t>
4854                            </list>
4855                        </t>
4856                    </section>
4857    
4858                    <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
4859                        <t>The front-end can retrieve the current list of directories
4860                        in specific directory by sending the following command:</t>
4861                        <t>
4862                            <list>
4863                                <t>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>
4864                            </list>
4865                        </t>
4866                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4867                        name of the directory.</t>
4868    
4869                        <t>Possible Answers:</t>
4870                        <t>
4871                            <list>
4872                                <t>A comma separated list of all instrument directories
4873                                (encapsulated into apostrophes) in the specified directory.</t>
4874                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4875                                    <list>
4876                                        <t>if the given directory does not exist.</t>
4877                                    </list>
4878                                </t>
4879                            </list>
4880                        </t>
4881                        <t>Example:</t>
4882                        <t>
4883                            <list>
4884                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
4885                                <t>S: "'Piano Collection','Percussion Collection'"</t>
4886                            </list>
4887                        </t>
4888                    </section>
4889    
4890                    <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
4891                        <t>The front-end can ask for the current settings of an
4892                        instrument directory by sending the following command:</t>
4893                        <t>
4894                            <list>
4895                                <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
4896                            </list>
4897                        </t>
4898                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4899                        name of the directory the front-end is interested in.</t>
4900    
4901                        <t>Possible Answers:</t>
4902                        <t>
4903                            <list>
4904                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4905                                Each answer line begins with the settings category name
4906                                followed by a colon and then a space character &lt;SP&gt; and finally
4907                                the info character string to that setting category. At the
4908                                moment the following categories are defined:</t>
4909    
4910                                <t>
4911                                    <list>
4912                                        <t>DESCRIPTION -
4913                                            <list>
4914                                                <t>A brief description of the directory content</t>
4915                                            </list>
4916                                        </t>
4917                                        <t>CREATED -
4918                                            <list>
4919                                                <t>The creation date and time of the directory,
4920                                                represented in "YYYY-MM-DD HH:MM:SS" format</t>
4921                                            </list>
4922                                        </t>
4923                                        <t>MODIFIED -
4924                                            <list>
4925                                                <t>The date and time of the last modification of the
4926                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
4927                                            </list>
4928                                        </t>
4929                                    </list>
4930                                </t>
4931                            </list>
4932                        </t>
4933                        <t>The mentioned fields above don't have to be in particular order.</t>
4934    
4935                        <t>Example:</t>
4936                        <t>
4937                            <list>
4938                                <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
4939                                <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
4940                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
4941                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
4942                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4943                            </list>
4944                        </t>
4945                    </section>
4946    
4947                    <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
4948                        <t>The front-end can alter the name of a specific
4949                        instrument directory by sending the following command:</t>
4950                        <t>
4951                            <list>
4952                                <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
4953                            </list>
4954                        </t>
4955                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
4956                        &lt;name&gt; is the new name for that directory.</t>
4957    
4958                        <t>Possible Answers:</t>
4959                        <t>
4960                            <list>
4961                                <t>"OK" -
4962                                    <list>
4963                                        <t>on success</t>
4964                                    </list>
4965                                </t>
4966                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4967                                    <list>
4968                                        <t>in case the given directory does not exists,
4969                                        or if a directory with name equal to the new
4970                                        name already exists.</t>
4971                                    </list>
4972                                </t>
4973                            </list>
4974                        </t>
4975    
4976                        <t>Example:</t>
4977                        <t>
4978                            <list>
4979                                <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
4980                                <t>S: "OK"</t>
4981                            </list>
4982                        </t>
4983                    </section>
4984    
4985                    <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
4986                        <t>The front-end can move a specific
4987                        instrument directory by sending the following command:</t>
4988                        <t>
4989                            <list>
4990                                <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
4991                            </list>
4992                        </t>
4993                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4994                        to move and &lt;dst&gt; is the location where the directory will
4995                        be moved to.</t>
4996    
4997                        <t>Possible Answers:</t>
4998                        <t>
4999                            <list>
5000                                <t>"OK" -
5001                                    <list>
5002                                        <t>on success</t>
5003                                    </list>
5004                                </t>
5005                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5006                                    <list>
5007                                        <t>in case a given directory does not exists,
5008                                        or if a directory with name equal to the name
5009                                        of the specified directory already exists in
5010                                        the destination directory. Error is also thrown
5011                                        when trying to move a directory to a subdirectory
5012                                        of itself.</t>
5013                                    </list>
5014                                </t>
5015                            </list>
5016                        </t>
5017    
5018                        <t>Example:</t>
5019                        <t>
5020                            <list>
5021                                <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5022                                <t>S: "OK"</t>
5023                            </list>
5024                        </t>
5025                    </section>
5026    
5027                    <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5028                        <t>The front-end can alter the description of a specific
5029                        instrument directory by sending the following command:</t>
5030                        <t>
5031                            <list>
5032                                <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5033                            </list>
5034                        </t>
5035                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5036                        &lt;desc&gt; is the new description for the directory.</t>
5037    
5038                        <t>Possible Answers:</t>
5039                        <t>
5040                            <list>
5041                                <t>"OK" -
5042                                    <list>
5043                                        <t>on success</t>
5044                                    </list>
5045                                </t>
5046                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5047                                    <list>
5048                                        <t>in case the given directory does not exists.</t>
5049                                    </list>
5050                                </t>
5051                            </list>
5052                        </t>
5053    
5054                        <t>Example:</t>
5055                        <t>
5056                            <list>
5057                                <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5058                                <t>S: "OK"</t>
5059                            </list>
5060                        </t>
5061                    </section>
5062    
5063                    <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5064                        <t>The front-end can add one or more instruments
5065                        to the instruments database by sending the following command:</t>
5066                        <t>
5067                            <list>
5068                                <t>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5069                            </list>
5070                        </t>
5071                        <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5072                        (encapsulated into apostrophes) in the instruments database in which
5073                        only the new instruments (that are not already in the database) will
5074                        be added, &lt;file_path&gt; is the absolute path name of a file or
5075                        directory in the file system (encapsulated into apostrophes). In case
5076                        an instrument file is supplied, only the instruments in the specified
5077                        file will be added to the instruments database. If the optional
5078                        &lt;instr_index&gt; (the index of the instrument within the given file)
5079                        is supplied too, then only the specified instrument will be added.
5080                        In case a directory is supplied, the instruments in that directory
5081                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5082                        when a directory is provided as &lt;file_path&gt; and specifies how the
5083                        scanning will be done and has exactly the following possibilities:</t>
5084                        <t>
5085                            <list>
5086                                <t>"NON_RECURSIVE" -
5087                                    <list>
5088                                        <t>Only the instruments in the specified directory
5089                                        will be added, the instruments in the subdirectories
5090                                        will not be processed.</t>
5091                                    </list>
5092                                </t>
5093                                <t>"FLAT" -
5094                                    <list>
5095                                        <t>All instruments will be processed, including those
5096                                        in the subdirectories, but the respective subdirectory
5097                                        structure will not be recreated in the instruments
5098                                        database. All instruments will be added directly in
5099                                        the specified database directory.</t>
5100                                    </list>
5101                                </t>
5102                                <t>not supplied -
5103                                    <list>
5104                                        <t>The subdirectory tree structure will be recreated
5105                                        in the instruments database and all instruments will be
5106                                        processed and added to the respective subdirectory
5107                                        in the instruments database.</t>
5108                                    </list>
5109                                </t>
5110                            </list>
5111                        </t>
5112    
5113                        <t>Possible Answers:</t>
5114                        <t>
5115                            <list>
5116                                <t>"OK" -
5117                                    <list>
5118                                        <t>on success</t>
5119                                    </list>
5120                                </t>
5121                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5122                                    <list>
5123                                        <t>if an invalid path is specified.</t>
5124                                    </list>
5125                                </t>
5126                            </list>
5127                        </t>
5128    
5129                        <t>Examples:</t>
5130                        <t>
5131                            <list>
5132                                <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5133                                <t>S: "OK"</t>
5134                            </list>
5135                        </t>
5136                    </section>
5137    
5138                    <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5139                        <t>The front-end can remove a particular instrument
5140                        from the instruments database by sending the following command:</t>
5141                        <t>
5142                            <list>
5143                                <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5144                            </list>
5145                        </t>
5146                        <t>Where &lt;instr_path&gt; is the absolute path name
5147                        (in the instruments database) of the instrument to remove.</t>
5148    
5149                        <t>Possible Answers:</t>
5150                        <t>
5151                            <list>
5152                                <t>"OK" -
5153                                    <list>
5154                                        <t>if the instrument is removed successfully</t>
5155                                    </list>
5156                                </t>
5157                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5158                                    <list>
5159                                        <t>if the given path does not exist or
5160                                        is a directory.</t>
5161                                    </list>
5162                                </t>
5163                            </list>
5164                        </t>
5165    
5166                        <t>Examples:</t>
5167                        <t>
5168                            <list>
5169                                <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5170                                <t>S: "OK"</t>
5171                            </list>
5172                        </t>
5173                    </section>
5174    
5175                    <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5176                        <t>The front-end can retrieve the current amount of
5177                        instruments in a specific directory by sending the following command:</t>
5178                        <t>
5179                            <list>
5180                                <t>GET DB_INSTRUMENTS &lt;dir&gt;</t>
5181                            </list>
5182                        </t>
5183                        <t>Where &lt;dir&gt; should be replaced by the absolute path name
5184                        of the directory.</t>
5185    
5186                        <t>Possible Answers:</t>
5187                        <t>
5188                            <list>
5189                                <t>The current number of instruments
5190                                in the specified directory.</t>
5191                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5192                                    <list>
5193                                        <t>if the given directory does not exist.</t>
5194                                    </list>
5195                                </t>
5196                            </list>
5197                        </t>
5198    
5199                        <t>Example:</t>
5200                        <t>
5201                            <list>
5202                                <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5203                                <t>S: "2"</t>
5204                            </list>
5205                        </t>
5206                    </section>
5207    
5208                    <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5209                        <t>The front-end can retrieve the current list of instruments
5210                        in specific directory by sending the following command:</t>
5211                        <t>
5212                            <list>
5213                                <t>LIST DB_INSTRUMENTS &lt;dir&gt;</t>
5214                            </list>
5215                        </t>
5216                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5217                        name of the directory.</t>
5218    
5219                        <t>Possible Answers:</t>
5220                        <t>
5221                            <list>
5222                                <t>A comma separated list of all instruments
5223                                (encapsulated into apostrophes) in the specified directory.</t>
5224                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5225                                    <list>
5226                                        <t>if the given directory does not exist.</t>
5227                                    </list>
5228                                </t>
5229                            </list>
5230                        </t>
5231                        <t>Example:</t>
5232                        <t>
5233                            <list>
5234                                <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5235                                <t>S: "'Bosendorfer 290','Steinway D'"</t>
5236                            </list>
5237                        </t>
5238                    </section>
5239    
5240                    <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5241                        <t>The front-end can ask for the current settings of an
5242                        instrument by sending the following command:</t>
5243                        <t>
5244                            <list>
5245                                <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5246                            </list>
5247                        </t>
5248                        <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5249                        name of the instrument the front-end is interested in.</t>
5250    
5251                        <t>Possible Answers:</t>
5252                        <t>
5253                            <list>
5254                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5255                                Each answer line begins with the settings category name
5256                                followed by a colon and then a space character &lt;SP&gt; and finally
5257                                the info character string to that setting category. At the
5258                                moment the following categories are defined:</t>
5259    
5260                                <t>
5261                                    <list>
5262                                        <t>INSTRUMENT_FILE -
5263                                            <list>
5264                                                <t>File name of the instrument.</t>
5265                                            </list>
5266                                        </t>
5267                                        <t>INSTRUMENT_NR -
5268                                            <list>
5269                                                <t>Index of the instrument within the file.</t>
5270                                            </list>
5271                                        </t>
5272                                        <t>FORMAT_FAMILY -
5273                                            <list>
5274                                                <t>The format family of the instrument.</t>
5275                                            </list>
5276                                        </t>
5277                                        <t>FORMAT_VERSION -
5278                                            <list>
5279                                                <t>The format version of the instrument.</t>
5280                                            </list>
5281                                        </t>
5282                                        <t>SIZE -
5283                                            <list>
5284                                                <t>The size of the instrument in bytes.</t>
5285                                            </list>
5286                                        </t>
5287                                        <t>CREATED -
5288                                            <list>
5289                                                <t>The date and time when the instrument is added
5290                                                in the instruments database, represented in
5291                                               "YYYY-MM-DD HH:MM:SS" format</t>
5292                                            </list>
5293                                        </t>
5294                                        <t>MODIFIED -
5295                                            <list>
5296                                                <t>The date and time of the last modification of the
5297                                                instrument's database settings, represented in
5298                                                "YYYY-MM-DD HH:MM:SS" format</t>
5299                                            </list>
5300                                        </t>
5301                                        <t>DESCRIPTION -
5302                                            <list>
5303                                                <t>A brief description of the instrument</t>
5304                                            </list>
5305                                        </t>
5306                                        <t>IS_DRUM -
5307                                            <list>
5308                                                <t>either true or false, determines whether the
5309                                                instrument is a drumkit or a chromatic instrument</t>
5310                                            </list>
5311                                        </t>
5312                                        <t>PRODUCT -
5313                                            <list>
5314                                                <t>The product title of the instrument</t>
5315                                            </list>
5316                                        </t>
5317                                        <t>ARTISTS -
5318                                            <list>
5319                                                <t>Lists the artist names</t>
5320                                            </list>
5321                                        </t>
5322                                        <t>KEYWORDS -
5323                                            <list>
5324                                                <t>Provides a list of keywords that refer to the instrument.
5325                                                Keywords are separated with semicolon and blank.</t>
5326                                            </list>
5327                                        </t>
5328                                    </list>
5329                                </t>
5330                            </list>
5331                        </t>
5332                        <t>The mentioned fields above don't have to be in particular order.</t>
5333    
5334                        <t>Example:</t>
5335                        <t>
5336                            <list>
5337                                <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5338                                <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5339                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5340                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5341                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5342                                <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5343                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5344                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5345                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5346                                <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5347                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5348                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5349                                <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5350                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5351                            </list>
5352                        </t>
5353                    </section>
5354    
5355                    <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5356                        <t>The front-end can alter the name of a specific
5357                        instrument by sending the following command:</t>
5358                        <t>
5359                            <list>
5360                                <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5361                            </list>
5362                        </t>
5363                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5364                        &lt;name&gt; is the new name for that instrument.</t>
5365    
5366                        <t>Possible Answers:</t>
5367                        <t>
5368                            <list>
5369                                <t>"OK" -
5370                                    <list>
5371                                        <t>on success</t>
5372                                    </list>
5373                                </t>
5374                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5375                                    <list>
5376                                        <t>in case the given instrument does not exists,
5377                                        or if an instrument with name equal to the new
5378                                        name already exists.</t>
5379                                    </list>
5380                                </t>
5381                            </list>
5382                        </t>
5383    
5384                        <t>Example:</t>
5385                        <t>
5386                            <list>
5387                                <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5388                                <t>S: "OK"</t>
5389                            </list>
5390                        </t>
5391                    </section>
5392    
5393                    <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5394                        <t>The front-end can move a specific instrument to another directory by
5395                        sending the following command:</t>
5396                        <t>
5397                            <list>
5398                                <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5399                            </list>
5400                        </t>
5401                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5402                        to move and &lt;dst&gt; is the directory where the instrument will
5403                        be moved to.</t>
5404    
5405                        <t>Possible Answers:</t>
5406                        <t>
5407                            <list>
5408                                <t>"OK" -
5409                                    <list>
5410                                        <t>on success</t>
5411                                    </list>
5412                                </t>
5413                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5414                                    <list>
5415                                        <t>in case the given instrument does not exists,
5416                                        or if an instrument with name equal to the name of the
5417                                        specified instrument already exists in the destination
5418                                        directory.</t>
5419                                    </list>
5420                                </t>
5421                            </list>
5422                        </t>
5423    
5424                        <t>Example:</t>
5425                        <t>
5426                            <list>
5427                                <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5428                                <t>S: "OK"</t>
5429                            </list>
5430                        </t>
5431                    </section>
5432    
5433                    <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5434                        <t>The front-end can alter the description of a specific
5435                        instrument by sending the following command:</t>
5436                        <t>
5437                            <list>
5438                                <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5439                            </list>
5440                        </t>
5441                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5442                        &lt;desc&gt; is the new description for the instrument.</t>
5443    
5444                        <t>Possible Answers:</t>
5445                        <t>
5446                            <list>
5447                                <t>"OK" -
5448                                    <list>
5449                                        <t>on success</t>
5450                                    </list>
5451                                </t>
5452                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5453                                    <list>
5454                                        <t>in case the given instrument does not exists.</t>
5455                                    </list>
5456                                </t>
5457                            </list>
5458                        </t>
5459    
5460                        <t>Example:</t>
5461                        <t>
5462                            <list>
5463                                <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5464                                <t>S: "OK"</t>
5465                            </list>
5466                        </t>
5467                    </section>
5468    
5469                </section>
5470    
5471          </section>          </section>
5472    
5473    
# Line 4755  Schoenebeck'> Line 5543  Schoenebeck'>
5543                  </t>                  </t>
5544                  <t>/ UNSUBSCRIBE SP unsubscribe_event                  <t>/ UNSUBSCRIBE SP unsubscribe_event
5545                  </t>                  </t>
                 <t>/ SELECT SP text  
                 </t>  
5546                  <t>/ RESET SP reset_instruction                  <t>/ RESET SP reset_instruction
5547                  </t>                  </t>
5548                  <t>/ CLEAR SP clear_instruction                  <t>/ CLEAR SP clear_instruction
5549                  </t>                  </t>
5550                    <t>/ MOVE SP move_instruction
5551                    </t>
5552                  <t>/ RESET                  <t>/ RESET
5553                  </t>                  </t>
5554                  <t>/ QUIT                  <t>/ QUIT
# Line 4771  Schoenebeck'> Line 5559  Schoenebeck'>
5559          <list>          <list>
5560                  <t>CHANNEL                  <t>CHANNEL
5561                  </t>                  </t>
5562                    <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
5563                    </t>
5564                    <t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname
5565                    </t>
5566                    <t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname
5567                    </t>
5568                    <t>/ DB_INSTRUMENTS SP pathname SP pathname
5569                    </t>
5570                    <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5571                    </t>
5572                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
5573                  </t>                  </t>
5574                  <t>/ MIDI_INSTRUMENT_MAP SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP map_name
# Line 4797  Schoenebeck'> Line 5595  Schoenebeck'>
5595                  </t>                  </t>
5596                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
5597                  </t>                  </t>
5598                    <t>/ FX_SEND_COUNT
5599                    </t>
5600                    <t>/ FX_SEND_INFO
5601                    </t>
5602                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
5603                  </t>                  </t>
5604                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4805  Schoenebeck'> Line 5607  Schoenebeck'>
5607                  </t>                  </t>
5608                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
5609                  </t>                  </t>
5610                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
5611                    </t>
5612                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
5613                    </t>
5614                    <t>/ DB_INSTRUMENT_COUNT
5615                    </t>
5616                    <t>/ DB_INSTRUMENT_INFO
5617                    </t>
5618                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
5619                  </t>                  </t>
5620                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
5621                  </t>                  </t>
5622                    <t>/ GLOBAL_INFO
5623                    </t>
5624          </list>          </list>
5625  </t>  </t>
5626  <t>unsubscribe_event =  <t>unsubscribe_event =
# Line 4831  Schoenebeck'> Line 5643  Schoenebeck'>
5643                  </t>                  </t>
5644                  <t>/ CHANNEL_INFO                  <t>/ CHANNEL_INFO
5645                  </t>                  </t>
5646                    <t>/ FX_SEND_COUNT
5647                    </t>
5648                    <t>/ FX_SEND_INFO
5649                    </t>
5650                  <t>/ MIDI_INSTRUMENT_MAP_COUNT                  <t>/ MIDI_INSTRUMENT_MAP_COUNT
5651                  </t>                  </t>
5652                  <t>/ MIDI_INSTRUMENT_MAP_INFO                  <t>/ MIDI_INSTRUMENT_MAP_INFO
# Line 4839  Schoenebeck'> Line 5655  Schoenebeck'>
5655                  </t>                  </t>
5656                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
5657                  </t>                  </t>
5658                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
5659                    </t>
5660                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
5661                    </t>
5662                    <t>/ DB_INSTRUMENT_COUNT
5663                    </t>
5664                    <t>/ DB_INSTRUMENT_INFO
5665                    </t>
5666                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
5667                  </t>                  </t>
5668                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
5669                  </t>                  </t>
5670                    <t>/ GLOBAL_INFO
5671                    </t>
5672          </list>          </list>
5673  </t>  </t>
5674  <t>map_instruction =  <t>map_instruction =
5675          <list>          <list>
5676                  <t>MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value                  <t>MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value
5677                  </t>                  </t>
5678                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode
5679                  </t>                  </t>
5680                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP entry_name
5681                  </t>                  </t>
5682                  <t>/ MIDI_INSTRUMENT SP midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name                  <t>/ MIDI_INSTRUMENT SP modal_arg midi_map SP midi_bank SP midi_prog SP engine_name SP filename SP instrument_index SP volume_value SP instr_load_mode SP entry_name
5683                  </t>                  </t>
5684          </list>          </list>
5685  </t>  </t>
# Line 4871  Schoenebeck'> Line 5697  Schoenebeck'>
5697                  </t>                  </t>
5698                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
5699                  </t>                  </t>
5700                    <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
5701                    </t>
5702                    <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
5703                    </t>
5704                    <t>/ DB_INSTRUMENT SP pathname
5705                    </t>
5706          </list>          </list>
5707  </t>  </t>
5708  <t>get_instruction =  <t>get_instruction =
# Line 4941  Schoenebeck'> Line 5773  Schoenebeck'>
5773                  </t>                  </t>
5774                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
5775                  </t>                  </t>
5776                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
5777                    </t>
5778                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
5779                    </t>
5780                    <t>/ DB_INSTRUMENTS SP pathname
5781                    </t>
5782                    <t>/ DB_INSTRUMENT SP INFO SP pathname
5783                    </t>
5784                  <t>/ VOLUME                  <t>/ VOLUME
5785                  </t>                  </t>
5786          </list>          </list>
# Line 4959  Schoenebeck'> Line 5799  Schoenebeck'>
5799                  </t>                  </t>
5800                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
5801                  </t>                  </t>
5802                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
5803                    </t>
5804                  <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index                  <t>/ FX_SEND SP AUDIO_OUTPUT_CHANNEL SP sampler_channel SP fx_send_id SP audio_channel_index SP audio_channel_index
5805                  </t>                  </t>
5806                  <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl                  <t>/ FX_SEND SP MIDI_CONTROLLER SP sampler_channel SP fx_send_id SP midi_ctrl
5807                  </t>                  </t>
5808                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value                  <t>/ FX_SEND SP LEVEL SP sampler_channel SP fx_send_id SP volume_value
5809                  </t>                  </t>
5810                    <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
5811                    </t>
5812                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
5813                    </t>
5814                    <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
5815                    </t>
5816                    <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
5817                    </t>
5818                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
5819                  </t>                  </t>
5820                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
# Line 5001  Schoenebeck'> Line 5851  Schoenebeck'>
5851                  </t>                  </t>
5852          </list>          </list>
5853  </t>  </t>
5854    <t>move_instruction =
5855            <list>
5856                    <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
5857                    </t>
5858                    <t>/ DB_INSTRUMENT SP pathname SP pathname
5859                    </t>
5860            </list>
5861    </t>
5862  <t>destroy_instruction =  <t>destroy_instruction =
5863          <list>          <list>
5864                  <t>AUDIO_OUTPUT_DEVICE SP number                  <t>AUDIO_OUTPUT_DEVICE SP number
# Line 5051  Schoenebeck'> Line 5909  Schoenebeck'>
5909                  </t>                  </t>
5910          </list>          </list>
5911  </t>  </t>
5912    <t>modal_arg =
5913            <list>
5914                    <t>/* epsilon (empty argument) */
5915                    </t>
5916                    <t>/ NON_MODAL SP
5917                    </t>
5918            </list>
5919    </t>
5920  <t>key_val_list =  <t>key_val_list =
5921          <list>          <list>
5922                  <t>string '=' param_val_list                  <t>string '=' param_val_list
# Line 5089  Schoenebeck'> Line 5955  Schoenebeck'>
5955                  </t>                  </t>
5956                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
5957                  </t>                  </t>
5958                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
5959                    </t>
5960                    <t>/ DB_INSTRUMENTS SP pathname
5961                    </t>
5962          </list>          </list>
5963  </t>  </t>
5964  <t>load_instr_args =  <t>load_instr_args =
# Line 5209  Schoenebeck'> Line 6079  Schoenebeck'>
6079                  </t>                  </t>
6080          </list>          </list>
6081  </t>  </t>
6082    <t>pathname =
6083            <list>
6084                    <t>stringval
6085                    </t>
6086            </list>
6087    </t>
6088    <t>dirname =
6089            <list>
6090                    <t>stringval
6091                    </t>
6092            </list>
6093    </t>
6094  <t>filename =  <t>filename =
6095          <list>          <list>
6096                  <t>stringval                  <t>stringval
# Line 5369  Schoenebeck'> Line 6251  Schoenebeck'>
6251                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
6252                  <t>                  <t>
6253                      <list>                      <list>
6254                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;</t>                          <t>"NOTIFY:VOICE_COUNT:&lt;sampler-channel&gt; &lt;voices&gt;"</t>
6255                      </list>                      </list>
6256                  </t>                  </t>
6257                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the                  <t>where &lt;sampler-channel&gt; will be replaced by the sampler channel the
# Line 5439  Schoenebeck'> Line 6321  Schoenebeck'>
6321                  message is sufficient here.</t>                  message is sufficient here.</t>
6322              </section>              </section>
6323    
6324                <section title="Number of effect sends changed" anchor="SUBSCRIBE FX_SEND_COUNT">
6325                    <t>Client may want to be notified when the number of effect sends on
6326                    a particular sampler channel is changed by issuing the following command:</t>
6327                    <t>
6328                        <list>
6329                            <t>SUBSCRIBE FX_SEND_COUNT</t>
6330                        </list>
6331                    </t>
6332                    <t>Server will start sending the following notification messages:</t>
6333                    <t>
6334                        <list>
6335                            <t>"NOTIFY:FX_SEND_COUNT:&lt;channel-id&gt; &lt;fx-sends&gt;"</t>
6336                        </list>
6337                    </t>
6338                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
6339                    channel, on which the effect sends number is changed and &lt;fx-sends&gt; will
6340                    be replaced by the new number of effect sends on that channel.</t>
6341                </section>
6342    
6343                <section title="Effect send information changed" anchor="SUBSCRIBE FX_SEND_INFO">
6344                    <t>Client may want to be notified when changes were made to effect sends on a
6345                    a particular sampler channel by issuing the following command:</t>
6346                    <t>
6347                        <list>
6348                            <t>SUBSCRIBE FX_SEND_INFO</t>
6349                        </list>
6350                    </t>
6351                    <t>Server will start sending the following notification messages:</t>
6352                    <t>
6353                        <list>
6354                            <t>"NOTIFY:FX_SEND_INFO:&lt;channel-id&gt; &lt;fx-send-id&gt;"</t>
6355                        </list>
6356                    </t>
6357                    <t>where &lt;channel-id&gt; will be replaced by the numerical ID of the sampler
6358                    channel, on which an effect send entity is changed and &lt;fx-send-id&gt; will
6359                    be replaced by the numerical ID of the changed effect send.</t>
6360                </section>
6361    
6362              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">              <section title="Total number of active voices changed" anchor="SUBSCRIBE TOTAL_VOICE_COUNT">
6363                  <t>Client may want to be notified when the total number of voices on the                  <t>Client may want to be notified when the total number of voices on the
6364                  back-end changes by issuing the following command:</t>                  back-end changes by issuing the following command:</t>
# Line 5450  Schoenebeck'> Line 6370  Schoenebeck'>
6370                  <t>Server will start sending the following notification messages:</t>                  <t>Server will start sending the following notification messages:</t>
6371                  <t>                  <t>
6372                      <list>                      <list>
6373                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;</t>                          <t>"NOTIFY:TOTAL_VOICE_COUNT:&lt;voices&gt;"</t>
6374                      </list>                      </list>
6375                  </t>                  </t>
6376                  <t>where &lt;voices&gt; will be replaced by the new number of                  <t>where &lt;voices&gt; will be replaced by the new number of
# Line 5539  Schoenebeck'> Line 6459  Schoenebeck'>
6459                  message is sufficient here.</t>                  message is sufficient here.</t>
6460              </section>              </section>
6461    
6462                <section title="Global settings changed" anchor="SUBSCRIBE GLOBAL_INFO">
6463                    <t>Client may want to be notified when changes to the global settings
6464                    of the sampler were made by issuing the following command:</t>
6465                    <t>
6466                        <list>
6467                            <t>SUBSCRIBE GLOBAL_INFO</t>
6468                        </list>
6469                    </t>
6470                    <t>Server will start sending the following types of notification messages:</t>
6471                    <t>
6472                        <list>
6473                            <t>"NOTIFY:GLOBAL_INFO:VOLUME &lt;volume&gt;" - Notifies that the
6474                            golbal volume of the sampler is changed, where &lt;volume&gt; will be
6475                            replaced by the optional dotted floating point value, reflecting the
6476                            new global volume parameter.</t>
6477                        </list>
6478                    </t>
6479                </section>
6480    
6481                <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
6482                    <t>Client may want to be notified when the number of instrument
6483                    directories in a particular directory in the instruments database
6484                    is changed by issuing the following command:</t>
6485                    <t>
6486                        <list>
6487                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
6488                        </list>
6489                    </t>
6490                    <t>Server will start sending the following notification messages:</t>
6491                    <t>
6492                        <list>
6493                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
6494                        </list>
6495                    </t>
6496                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
6497                    name of the directory in the instruments database,
6498                    in which the number of directories is changed.</t>
6499                    <t>Note that when a non-empty directory is removed, this event
6500                    is not sent for the subdirectories in that directory.</t>
6501                </section>
6502    
6503                <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
6504                    <t>Client may want to be notified when changes were made to directories
6505                    in the instruments database by issuing the following command:</t>
6506                    <t>
6507                        <list>
6508                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
6509                        </list>
6510                    </t>
6511                    <t>Server will start sending the following notification messages:</t>
6512                    <t>
6513                        <list>
6514                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
6515                        </list>
6516                    </t>
6517                    <t>where &lt;dir-path&gt; will be replaced by the absolute path name
6518                    of the directory, for which information changes occurred. The front-end will have to send
6519                    the respective command to actually get the updated directory info. Because these messages
6520                    will be triggered by LSCP commands issued by other clients rather than real
6521                    time events happening on the server, it is believed that an empty notification
6522                    message is sufficient here.</t>
6523                    <t>
6524                        <list>
6525                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
6526                        </list>
6527                    </t>
6528                    <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
6529                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
6530                    the new name of the directory, encapsulated into apostrophes.</t>
6531                </section>
6532    
6533                <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
6534                    <t>Client may want to be notified when the number of instruments
6535                    in a particular directory in the instruments database
6536                    is changed by issuing the following command:</t>
6537                    <t>
6538                        <list>
6539                            <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
6540                        </list>
6541                    </t>
6542                    <t>Server will start sending the following notification messages:</t>
6543                    <t>
6544                        <list>
6545                            <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
6546                        </list>
6547                    </t>
6548                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
6549                    name of the directory in the instruments database,
6550                    in which the number of instruments is changed.</t>
6551                    <t>Note that when a non-empty directory is removed, this event
6552                    is not sent for the instruments in that directory.</t>
6553                </section>
6554    
6555                <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
6556                    <t>Client may want to be notified when changes were made to instruments
6557                    in the instruments database by issuing the following command:</t>
6558                    <t>
6559                        <list>
6560                            <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
6561                        </list>
6562                    </t>
6563                    <t>Server will start sending the following notification messages:</t>
6564                    <t>
6565                        <list>
6566                            <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
6567                        </list>
6568                    </t>
6569                    <t>where &lt;instr-path&gt; will be replaced by the absolute path name
6570                    of the instrument, which settings are changed. The front-end will have to send
6571                    the respective command to actually get the updated directory info. Because these messages
6572                    will be triggered by LSCP commands issued by other clients rather than real
6573                    time events happening on the server, it is believed that an empty notification
6574                    message is sufficient here.</t>
6575                    <t>
6576                        <list>
6577                            <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
6578                        </list>
6579                    </t>
6580                    <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
6581                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
6582                    the new name of the instrument, encapsulated into apostrophes.</t>
6583                </section>
6584    
6585              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
6586                  <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
6587                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.1027  
changed lines
  Added in v.1161
  ViewVC Help
Powered by ViewVC