/[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 1109 by iliev, Thu Mar 22 20:55:17 2007 UTC revision 1200 by iliev, Thu May 24 14:04: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="March" year="2007"/>          <date month="May" 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 4686  Schoenebeck'> Line 4740  Schoenebeck'>
4740                  </section>                  </section>
4741              </section>              </section>
4742    
4743    
4744                <section title="Managing Instruments Database" anchor="Managing Instruments Database">
4745                    <t>The following commands describe how to use and manage
4746                    the instruments database.</t>
4747    
4748                    <section title="Creating a new instrument directory" anchor="ADD DB_INSTRUMENT_DIRECTORY">
4749                        <t>The front-end can add a new instrument directory to the
4750                        instruments database by sending the following command:</t>
4751                        <t>
4752                            <list>
4753                                <t>ADD DB_INSTRUMENT_DIRECTORY &lt;dir&gt;</t>
4754                            </list>
4755                        </t>
4756                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4757                        to be created (encapsulated into apostrophes).</t>
4758    
4759                        <t>Possible Answers:</t>
4760                        <t>
4761                            <list>
4762                                <t>"OK" -
4763                                    <list>
4764                                        <t>on success</t>
4765                                    </list>
4766                                </t>
4767                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4768                                    <list>
4769                                        <t>when the directory could not be created, which
4770                                        can happen if the directory already exists or the
4771                                        name contains not allowed symbols</t>
4772                                    </list>
4773                                </t>
4774                            </list>
4775                        </t>
4776    
4777                        <t>Examples:</t>
4778                        <t>
4779                            <list>
4780                                <t>C: "ADD DB_INSTRUMENT_DIRECTORY '/Piano Collection'"</t>
4781                                <t>S: "OK"</t>
4782                            </list>
4783                        </t>
4784                    </section>
4785    
4786                    <section title="Deleting an instrument directory" anchor="REMOVE DB_INSTRUMENT_DIRECTORY">
4787                        <t>The front-end can delete a particular instrument directory
4788                        from the instruments database by sending the following command:</t>
4789                        <t>
4790                            <list>
4791                                <t>REMOVE DB_INSTRUMENT_DIRECTORY [FORCE] &lt;dir&gt;</t>
4792                            </list>
4793                        </t>
4794                        <t>Where &lt;dir&gt; is the absolute path name of the directory
4795                        to delete. The optional FORCE argument can be used to
4796                        force the deletion of a non-empty directory and all its content.</t>
4797    
4798                        <t>Possible Answers:</t>
4799                        <t>
4800                            <list>
4801                                <t>"OK" -
4802                                    <list>
4803                                        <t>if the directory is deleted successfully</t>
4804                                    </list>
4805                                </t>
4806                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4807                                    <list>
4808                                        <t>if the given directory does not exist, or
4809                                        if trying to delete a non-empty directory,
4810                                        without using the FORCE argument.</t>
4811                                    </list>
4812                                </t>
4813                            </list>
4814                        </t>
4815    
4816                        <t>Examples:</t>
4817                        <t>
4818                            <list>
4819                                <t>C: "REMOVE DB_INSTRUMENT_DIRECTORY FORCE '/Piano Collection'"</t>
4820                                <t>S: "OK"</t>
4821                            </list>
4822                        </t>
4823                    </section>
4824    
4825                    <section title="Getting amount of instrument directories" anchor="GET DB_INSTRUMENT_DIRECTORIES">
4826                        <t>The front-end can retrieve the current amount of
4827                        directories in a specific directory by sending the following command:</t>
4828                        <t>
4829                            <list>
4830                                <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4831                            </list>
4832                        </t>
4833                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4834                        name of the directory. If RECURSIVE is specified, the number of
4835                        all directories, including those located in subdirectories of the
4836                        specified directory, will be returned.</t>
4837    
4838                        <t>Possible Answers:</t>
4839                        <t>
4840                            <list>
4841                                <t>The current number of instrument directories
4842                                in the specified directory.</t>
4843                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4844                                    <list>
4845                                        <t>if the given directory does not exist.</t>
4846                                    </list>
4847                                </t>
4848                            </list>
4849                        </t>
4850    
4851                        <t>Example:</t>
4852                        <t>
4853                            <list>
4854                                <t>C: "GET DB_INSTRUMENT_DIRECTORIES '/'"</t>
4855                                <t>S: "2"</t>
4856                            </list>
4857                        </t>
4858                    </section>
4859    
4860                    <section title="Listing all directories in specific directory" anchor="LIST DB_INSTRUMENT_DIRECTORIES">
4861                        <t>The front-end can retrieve the current list of directories
4862                        in specific directory by sending the following command:</t>
4863                        <t>
4864                            <list>
4865                                <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4866                            </list>
4867                        </t>
4868                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4869                        name of the directory. If RECURSIVE is specified, the absolute path names
4870                        of all directories, including those located in subdirectories of the
4871                        specified directory, will be returned.</t>
4872    
4873                        <t>Possible Answers:</t>
4874                        <t>
4875                            <list>
4876                                <t>A comma separated list of all instrument directories
4877                                (encapsulated into apostrophes) in the specified directory.</t>
4878                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4879                                    <list>
4880                                        <t>if the given directory does not exist.</t>
4881                                    </list>
4882                                </t>
4883                            </list>
4884                        </t>
4885                        <t>Example:</t>
4886                        <t>
4887                            <list>
4888                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES '/'"</t>
4889                                <t>S: "'Piano Collection','Percussion Collection'"</t>
4890                            </list>
4891                        </t>
4892                        <t>
4893                            <list>
4894                                <t>C: "LIST DB_INSTRUMENT_DIRECTORIES RECURSIVE '/'"</t>
4895                                <t>S: "'/Piano Collection','/Piano Collection/Acoustic','/Piano Collection/Acoustic/New','/Percussion Collection'"</t>
4896                            </list>
4897                        </t>
4898                    </section>
4899    
4900                    <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
4901                        <t>The front-end can ask for the current settings of an
4902                        instrument directory by sending the following command:</t>
4903                        <t>
4904                            <list>
4905                                <t>GET DB_INSTRUMENT_DIRECTORY INFO &lt;dir&gt;</t>
4906                            </list>
4907                        </t>
4908                        <t>Where &lt;dir&gt; should be replaced by the absolute path
4909                        name of the directory the front-end is interested in.</t>
4910    
4911                        <t>Possible Answers:</t>
4912                        <t>
4913                            <list>
4914                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
4915                                Each answer line begins with the settings category name
4916                                followed by a colon and then a space character &lt;SP&gt; and finally
4917                                the info character string to that setting category. At the
4918                                moment the following categories are defined:</t>
4919    
4920                                <t>
4921                                    <list>
4922                                        <t>DESCRIPTION -
4923                                            <list>
4924                                                <t>A brief description of the directory content</t>
4925                                            </list>
4926                                        </t>
4927                                        <t>CREATED -
4928                                            <list>
4929                                                <t>The creation date and time of the directory,
4930                                                represented in "YYYY-MM-DD HH:MM:SS" format</t>
4931                                            </list>
4932                                        </t>
4933                                        <t>MODIFIED -
4934                                            <list>
4935                                                <t>The date and time of the last modification of the
4936                                                directory, represented in "YYYY-MM-DD HH:MM:SS" format</t>
4937                                            </list>
4938                                        </t>
4939                                    </list>
4940                                </t>
4941                            </list>
4942                        </t>
4943                        <t>The mentioned fields above don't have to be in particular order.</t>
4944    
4945                        <t>Example:</t>
4946                        <t>
4947                            <list>
4948                                <t>C: "GET DB_INSTRUMENT_DIRECTORY INFO '/Piano Collection'"</t>
4949                                <t>S: "DESCRIPTION: Piano collection of instruments in GigaSampler format."</t>
4950                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
4951                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
4952                                <t>&nbsp;&nbsp;&nbsp;"."</t>
4953                            </list>
4954                        </t>
4955                    </section>
4956    
4957                    <section title="Renaming an instrument directory" anchor="SET DB_INSTRUMENT_DIRECTORY NAME">
4958                        <t>The front-end can alter the name of a specific
4959                        instrument directory by sending the following command:</t>
4960                        <t>
4961                            <list>
4962                                <t>SET DB_INSTRUMENT_DIRECTORY NAME &lt;dir&gt; &lt;name&gt;</t>
4963                            </list>
4964                        </t>
4965                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
4966                        &lt;name&gt; is the new name for that directory.</t>
4967    
4968                        <t>Possible Answers:</t>
4969                        <t>
4970                            <list>
4971                                <t>"OK" -
4972                                    <list>
4973                                        <t>on success</t>
4974                                    </list>
4975                                </t>
4976                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
4977                                    <list>
4978                                        <t>in case the given directory does not exists,
4979                                        or if a directory with name equal to the new
4980                                        name already exists.</t>
4981                                    </list>
4982                                </t>
4983                            </list>
4984                        </t>
4985    
4986                        <t>Example:</t>
4987                        <t>
4988                            <list>
4989                                <t>C: "SET DB_INSTRUMENT_DIRECTORY NAME '/Piano Collection/Acustic' 'Acoustic'"</t>
4990                                <t>S: "OK"</t>
4991                            </list>
4992                        </t>
4993                    </section>
4994    
4995                    <section title="Moving an instrument directory" anchor="MOVE DB_INSTRUMENT_DIRECTORY">
4996                        <t>The front-end can move a specific
4997                        instrument directory by sending the following command:</t>
4998                        <t>
4999                            <list>
5000                                <t>MOVE DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5001                            </list>
5002                        </t>
5003                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5004                        to move and &lt;dst&gt; is the location where the directory will
5005                        be moved to.</t>
5006    
5007                        <t>Possible Answers:</t>
5008                        <t>
5009                            <list>
5010                                <t>"OK" -
5011                                    <list>
5012                                        <t>on success</t>
5013                                    </list>
5014                                </t>
5015                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5016                                    <list>
5017                                        <t>in case a given directory does not exists,
5018                                        or if a directory with name equal to the name
5019                                        of the specified directory already exists in
5020                                        the destination directory. Error is also thrown
5021                                        when trying to move a directory to a subdirectory
5022                                        of itself.</t>
5023                                    </list>
5024                                </t>
5025                            </list>
5026                        </t>
5027    
5028                        <t>Example:</t>
5029                        <t>
5030                            <list>
5031                                <t>C: "MOVE DB_INSTRUMENT_DIRECTORY '/Acoustic' '/Piano Collection/Acoustic'"</t>
5032                                <t>S: "OK"</t>
5033                            </list>
5034                        </t>
5035                    </section>
5036    
5037                    <section title="Copying instrument directories" anchor="COPY DB_INSTRUMENT_DIRECTORY">
5038                        <t>The front-end can copy a specific
5039                        instrument directory by sending the following command:</t>
5040                        <t>
5041                            <list>
5042                                <t>COPY DB_INSTRUMENT_DIRECTORY &lt;dir&gt; &lt;dst&gt;</t>
5043                            </list>
5044                        </t>
5045                        <t>Where &lt;dir&gt; is the absolute path name of the directory
5046                        to copy and &lt;dst&gt; is the location where the directory will
5047                        be copied to.</t>
5048    
5049                        <t>Possible Answers:</t>
5050                        <t>
5051                            <list>
5052                                <t>"OK" -
5053                                    <list>
5054                                        <t>on success</t>
5055                                    </list>
5056                                </t>
5057                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5058                                    <list>
5059                                        <t>in case a given directory does not exists,
5060                                        or if a directory with name equal to the name
5061                                        of the specified directory already exists in
5062                                        the destination directory. Error is also thrown
5063                                        when trying to copy a directory to a subdirectory
5064                                        of itself.</t>
5065                                    </list>
5066                                </t>
5067                            </list>
5068                        </t>
5069    
5070                        <t>Example:</t>
5071                        <t>
5072                            <list>
5073                                <t>C: "COPY DB_INSTRUMENT_DIRECTORY '/Piano Collection/Acoustic' '/Acoustic/Pianos'"</t>
5074                                <t>S: "OK"</t>
5075                            </list>
5076                        </t>
5077                    </section>
5078    
5079                    <section title="Changing the description of directory" anchor="SET DB_INSTRUMENT_DIRECTORY DESCRIPTION">
5080                        <t>The front-end can alter the description of a specific
5081                        instrument directory by sending the following command:</t>
5082                        <t>
5083                            <list>
5084                                <t>SET DB_INSTRUMENT_DIRECTORY DESCRIPTION &lt;dir&gt; &lt;desc&gt;</t>
5085                            </list>
5086                        </t>
5087                        <t>Where &lt;dir&gt; is the absolute path name of the directory and
5088                        &lt;desc&gt; is the new description for the directory.</t>
5089    
5090                        <t>Possible Answers:</t>
5091                        <t>
5092                            <list>
5093                                <t>"OK" -
5094                                    <list>
5095                                        <t>on success</t>
5096                                    </list>
5097                                </t>
5098                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5099                                    <list>
5100                                        <t>in case the given directory does not exists.</t>
5101                                    </list>
5102                                </t>
5103                            </list>
5104                        </t>
5105    
5106                        <t>Example:</t>
5107                        <t>
5108                            <list>
5109                                <t>C: "SET DB_INSTRUMENT_DIRECTORY DESCRIPTION '/Piano Collection' 'A collection of piano instruments in various format.'"</t>
5110                                <t>S: "OK"</t>
5111                            </list>
5112                        </t>
5113                    </section>
5114    
5115                    <section title="Finding directories" anchor="FIND DB_INSTRUMENT_DIRECTORIES">
5116                        <t>The front-end can search for directories
5117                        in specific directory by sending the following command:</t>
5118                        <t>
5119                            <list>
5120                                <t>FIND DB_INSTRUMENT_DIRECTORIES [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5121                            </list>
5122                        </t>
5123                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5124                        name of the directory to search in. If NON_RECURSIVE is specified, the
5125                        directories located in subdirectories of the specified directory will not
5126                        be searched. &lt;criteria-list&gt; is a list of search criterias
5127                        in form of "key1=val1 key2=val2 ...". The following criterias are
5128                        allowed:</t>
5129                        <t>
5130                          <t>NAME='&lt;search-string&gt;'
5131                              <list>
5132                                  <t>Restricts the search to directories, which names
5133                                  satisfy the supplied search string.</t>
5134                              </list>
5135                          </t>
5136    
5137                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5138                              <list>
5139                                  <t>Restricts the search to directories, which creation
5140                                  date satisfies the specified period, where &lt;date-after&gt;
5141                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5142                                  If &lt;date-after&gt; is omitted the search is restricted to
5143                                  directories created before &lt;date-before&gt;. If
5144                                  &lt;date-before&gt; is omitted, the search is restricted
5145                                  to directories created after &lt;date-after&gt;.</t>
5146                              </list>
5147                          </t>
5148    
5149                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5150                              <list>
5151                                  <t>Restricts the search to directories, which
5152                                  date of last modification satisfies the specified period, where
5153                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5154                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5155                                  directories, which are last modified before &lt;date-before&gt;. If
5156                                  &lt;date-before&gt; is omitted, the search is restricted to directories,
5157                                  which are last modified after &lt;date-after&gt;.</t>
5158                              </list>
5159                          </t>
5160    
5161                          <t>DESCRIPTION='&lt;search-string&gt;'
5162                              <list>
5163                                  <t>Restricts the search to directories with description
5164                                  that satisfies the supplied search string.</t>
5165                              </list>
5166                          </t>
5167                        </t>
5168    
5169                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5170                        word list separated with spaces for OR search and with '+' for AND search.</t>
5171    
5172                        <t>Possible Answers:</t>
5173                        <t>
5174                            <list>
5175                                <t>A comma separated list with the absolute path names (encapsulated into
5176                                apostrophes) of all directories in the specified directory that satisfy
5177                                the supplied search criterias.</t>
5178                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5179                                    <list>
5180                                        <t>if the given directory does not exist.</t>
5181                                    </list>
5182                                </t>
5183                            </list>
5184                        </t>
5185                        <t>Example:</t>
5186                        <t>
5187                            <list>
5188                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' NAME='Piano'"</t>
5189                                <t>S: "'/Piano Collection'"</t>
5190                            </list>
5191                        </t>
5192                        <t>
5193                            <list>
5194                                <t>C: "FIND DB_INSTRUMENT_DIRECTORIES '/' CREATED='..2007-04-01 09:30:13'"</t>
5195                                <t>S: "'/Piano Collection','/Percussions'"</t>
5196                            </list>
5197                        </t>
5198                    </section>
5199    
5200                    <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5201                        <t>The front-end can add one or more instruments
5202                        to the instruments database by sending the following command:</t>
5203                        <t>
5204                            <list>
5205                                <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5206                            </list>
5207                        </t>
5208                        <t>Where &lt;db_dir&gt; is the absolute path name of a directory
5209                        (encapsulated into apostrophes) in the instruments database in which
5210                        only the new instruments (that are not already in the database) will
5211                        be added, &lt;file_path&gt; is the absolute path name of a file or
5212                        directory in the file system (encapsulated into apostrophes). In case
5213                        an instrument file is supplied, only the instruments in the specified
5214                        file will be added to the instruments database. If the optional
5215                        &lt;instr_index&gt; (the index of the instrument within the given file)
5216                        is supplied too, then only the specified instrument will be added.
5217                        In case a directory is supplied, the instruments in that directory
5218                        will be added. The OPTIONAL &lt;mode&gt; argument is only applied
5219                        when a directory is provided as &lt;file_path&gt; and specifies how the
5220                        scanning will be done and has exactly the following possibilities:</t>
5221                        <t>
5222                            <list>
5223                                <t>"RECURSIVE" -
5224                                    <list>
5225                                        <t>All instruments will be processed, including those
5226                                        in the subdirectories, and the respective subdirectory
5227                                        tree structure will be recreated in the instruments
5228                                        database</t>
5229                                    </list>
5230                                </t>
5231                                <t>"NON_RECURSIVE" -
5232                                    <list>
5233                                        <t>Only the instruments in the specified directory
5234                                        will be added, the instruments in the subdirectories
5235                                        will not be processed.</t>
5236                                    </list>
5237                                </t>
5238                                <t>"FLAT" -
5239                                    <list>
5240                                        <t>All instruments will be processed, including those
5241                                        in the subdirectories, but the respective subdirectory
5242                                        structure will not be recreated in the instruments
5243                                        database. All instruments will be added directly in
5244                                        the specified database directory.</t>
5245                                    </list>
5246                                </t>
5247                            </list>
5248                        </t>
5249    
5250                     <t>The difference between regular and NON_MODAL versions of the command
5251                        is that the regular command returns when the scanning is finished
5252                        while NON_MODAL version returns immediately and a background process is launched.
5253                        The <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5254                        command can be used to monitor the scanning progress.</t>
5255    
5256                        <t>Possible Answers:</t>
5257                        <t>
5258                            <list>
5259                                <t>"OK" -
5260                                    <list>
5261                                        <t>on success when NON_MODAL is not supplied</t>
5262                                    </list>
5263                                </t>
5264                                <t>"OK[&lt;job-id&gt;]" -
5265                                    <list>
5266                                        <t>on success when NON_MODAL is supplied, where &lt;job-id&gt;
5267                                        is a numerical ID used to obtain status information about the job progress.
5268                                        See <xref target="GET DB_INSTRUMENTS_JOB INFO">GET DB_INSTRUMENTS_JOB INFO</xref>
5269                                        </t>
5270                                    </list>
5271                                </t>
5272                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5273                                    <list>
5274                                        <t>if an invalid path is specified.</t>
5275                                    </list>
5276                                </t>
5277                            </list>
5278                        </t>
5279    
5280                        <t>Examples:</t>
5281                        <t>
5282                            <list>
5283                                <t>C: "ADD DB_INSTRUMENTS '/Piano Collection' '/home/me/gigs/PMI Bosendorfer 290.gig' 0"</t>
5284                                <t>S: "OK"</t>
5285                            </list>
5286                        </t>
5287                    </section>
5288    
5289                    <section title="Removing an instrument" anchor="REMOVE DB_INSTRUMENT">
5290                        <t>The front-end can remove a particular instrument
5291                        from the instruments database by sending the following command:</t>
5292                        <t>
5293                            <list>
5294                                <t>REMOVE DB_INSTRUMENT &lt;instr_path&gt;</t>
5295                            </list>
5296                        </t>
5297                        <t>Where &lt;instr_path&gt; is the absolute path name
5298                        (in the instruments database) of the instrument to remove.</t>
5299    
5300                        <t>Possible Answers:</t>
5301                        <t>
5302                            <list>
5303                                <t>"OK" -
5304                                    <list>
5305                                        <t>if the instrument is removed successfully</t>
5306                                    </list>
5307                                </t>
5308                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5309                                    <list>
5310                                        <t>if the given path does not exist or
5311                                        is a directory.</t>
5312                                    </list>
5313                                </t>
5314                            </list>
5315                        </t>
5316    
5317                        <t>Examples:</t>
5318                        <t>
5319                            <list>
5320                                <t>C: "REMOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290'"</t>
5321                                <t>S: "OK"</t>
5322                            </list>
5323                        </t>
5324                    </section>
5325    
5326                    <section title="Getting amount of instruments" anchor="GET DB_INSTRUMENTS">
5327                        <t>The front-end can retrieve the current amount of
5328                        instruments in a specific directory by sending the following command:</t>
5329                        <t>
5330                            <list>
5331                                <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5332                            </list>
5333                        </t>
5334                        <t>Where &lt;dir&gt; should be replaced by the absolute path name
5335                        of the directory. If RECURSIVE is specified, the number of all
5336                        instruments, including those located in subdirectories of the
5337                        specified directory, will be returned.</t>
5338    
5339                        <t>Possible Answers:</t>
5340                        <t>
5341                            <list>
5342                                <t>The current number of instruments
5343                                in the specified directory.</t>
5344                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5345                                    <list>
5346                                        <t>if the given directory does not exist.</t>
5347                                    </list>
5348                                </t>
5349                            </list>
5350                        </t>
5351    
5352                        <t>Example:</t>
5353                        <t>
5354                            <list>
5355                                <t>C: "GET DB_INSTRUMENTS '/Piano Collection'"</t>
5356                                <t>S: "2"</t>
5357                            </list>
5358                        </t>
5359                    </section>
5360    
5361                    <section title="Listing all instruments in specific directory" anchor="LIST DB_INSTRUMENTS">
5362                        <t>The front-end can retrieve the current list of instruments
5363                        in specific directory by sending the following command:</t>
5364                        <t>
5365                            <list>
5366                                <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5367                            </list>
5368                        </t>
5369                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5370                        name of the directory. If RECURSIVE is specified, the absolute path
5371                        names of all instruments, including those located in subdirectories
5372                        of the specified directory, will be returned.</t>
5373    
5374                        <t>Possible Answers:</t>
5375                        <t>
5376                            <list>
5377                                <t>A comma separated list of all instruments
5378                                (encapsulated into apostrophes) in the specified directory.</t>
5379                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5380                                    <list>
5381                                        <t>if the given directory does not exist.</t>
5382                                    </list>
5383                                </t>
5384                            </list>
5385                        </t>
5386                        <t>Example:</t>
5387                        <t>
5388                            <list>
5389                                <t>C: "LIST DB_INSTRUMENTS '/Piano Collection'"</t>
5390                                <t>S: "'Bosendorfer 290','Steinway D'"</t>
5391                            </list>
5392                        </t>
5393                        <t>
5394                            <list>
5395                                <t>C: "LIST DB_INSTRUMENTS RECURSIVE '/Piano Collection'"</t>
5396                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D','/Piano Collection/Lite/Free Piano'"</t>
5397                            </list>
5398                        </t>
5399                    </section>
5400    
5401                    <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
5402                        <t>The front-end can ask for the current settings of an
5403                        instrument by sending the following command:</t>
5404                        <t>
5405                            <list>
5406                                <t>GET DB_INSTRUMENT INFO &lt;instr_path&gt;</t>
5407                            </list>
5408                        </t>
5409                        <t>Where &lt;instr_path&gt; should be replaced by the absolute path
5410                        name of the instrument the front-end is interested in.</t>
5411    
5412                        <t>Possible Answers:</t>
5413                        <t>
5414                            <list>
5415                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5416                                Each answer line begins with the settings category name
5417                                followed by a colon and then a space character &lt;SP&gt; and finally
5418                                the info character string to that setting category. At the
5419                                moment the following categories are defined:</t>
5420    
5421                                <t>
5422                                    <list>
5423                                        <t>INSTRUMENT_FILE -
5424                                            <list>
5425                                                <t>File name of the instrument.</t>
5426                                            </list>
5427                                        </t>
5428                                        <t>INSTRUMENT_NR -
5429                                            <list>
5430                                                <t>Index of the instrument within the file.</t>
5431                                            </list>
5432                                        </t>
5433                                        <t>FORMAT_FAMILY -
5434                                            <list>
5435                                                <t>The format family of the instrument.</t>
5436                                            </list>
5437                                        </t>
5438                                        <t>FORMAT_VERSION -
5439                                            <list>
5440                                                <t>The format version of the instrument.</t>
5441                                            </list>
5442                                        </t>
5443                                        <t>SIZE -
5444                                            <list>
5445                                                <t>The size of the instrument in bytes.</t>
5446                                            </list>
5447                                        </t>
5448                                        <t>CREATED -
5449                                            <list>
5450                                                <t>The date and time when the instrument is added
5451                                                in the instruments database, represented in
5452                                               "YYYY-MM-DD HH:MM:SS" format</t>
5453                                            </list>
5454                                        </t>
5455                                        <t>MODIFIED -
5456                                            <list>
5457                                                <t>The date and time of the last modification of the
5458                                                instrument's database settings, represented in
5459                                                "YYYY-MM-DD HH:MM:SS" format</t>
5460                                            </list>
5461                                        </t>
5462                                        <t>DESCRIPTION -
5463                                            <list>
5464                                                <t>A brief description of the instrument</t>
5465                                            </list>
5466                                        </t>
5467                                        <t>IS_DRUM -
5468                                            <list>
5469                                                <t>either true or false, determines whether the
5470                                                instrument is a drumkit or a chromatic instrument</t>
5471                                            </list>
5472                                        </t>
5473                                        <t>PRODUCT -
5474                                            <list>
5475                                                <t>The product title of the instrument</t>
5476                                            </list>
5477                                        </t>
5478                                        <t>ARTISTS -
5479                                            <list>
5480                                                <t>Lists the artist names</t>
5481                                            </list>
5482                                        </t>
5483                                        <t>KEYWORDS -
5484                                            <list>
5485                                                <t>Provides a list of keywords that refer to the instrument.
5486                                                Keywords are separated with semicolon and blank.</t>
5487                                            </list>
5488                                        </t>
5489                                    </list>
5490                                </t>
5491                            </list>
5492                        </t>
5493                        <t>The mentioned fields above don't have to be in particular order.</t>
5494    
5495                        <t>Example:</t>
5496                        <t>
5497                            <list>
5498                                <t>C: "GET DB_INSTRUMENT INFO '/Piano Collection/Bosendorfer 290'"</t>
5499                                <t>S: "INSTRUMENT_FILE: /home/me/gigs/Bosendorfer 290.gig"</t>
5500                                <t>&nbsp;&nbsp;&nbsp;"INSTRUMENT_NR: 0"</t>
5501                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_FAMILY: GIG"</t>
5502                                <t>&nbsp;&nbsp;&nbsp;"FORMAT_VERSION: 2"</t>
5503                                <t>&nbsp;&nbsp;&nbsp;"SIZE: 2050871870"</t>
5504                                <t>&nbsp;&nbsp;&nbsp;"CREATED: 2007-02-05 10:23:12"</t>
5505                                <t>&nbsp;&nbsp;&nbsp;"MODIFIED: 2007-04-07 12:50:21"</t>
5506                                <t>&nbsp;&nbsp;&nbsp;"DESCRIPTION: "</t>
5507                                <t>&nbsp;&nbsp;&nbsp;"IS_DRUM: false"</t>
5508                                <t>&nbsp;&nbsp;&nbsp;"PRODUCT: GRANDIOSO Bosendorfer 290"</t>
5509                                <t>&nbsp;&nbsp;&nbsp;"ARTISTS: Post Musical Instruments"</t>
5510                                <t>&nbsp;&nbsp;&nbsp;"KEYWORDS: Bosendorfer"</t>
5511                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5512                            </list>
5513                        </t>
5514                    </section>
5515    
5516                    <section title="Renaming an instrument" anchor="SET DB_INSTRUMENT NAME">
5517                        <t>The front-end can alter the name of a specific
5518                        instrument by sending the following command:</t>
5519                        <t>
5520                            <list>
5521                                <t>SET DB_INSTRUMENT NAME &lt;instr&gt; &lt;name&gt;</t>
5522                            </list>
5523                        </t>
5524                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5525                        &lt;name&gt; is the new name for that instrument.</t>
5526    
5527                        <t>Possible Answers:</t>
5528                        <t>
5529                            <list>
5530                                <t>"OK" -
5531                                    <list>
5532                                        <t>on success</t>
5533                                    </list>
5534                                </t>
5535                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5536                                    <list>
5537                                        <t>in case the given instrument does not exists,
5538                                        or if an instrument with name equal to the new
5539                                        name already exists.</t>
5540                                    </list>
5541                                </t>
5542                            </list>
5543                        </t>
5544    
5545                        <t>Example:</t>
5546                        <t>
5547                            <list>
5548                                <t>C: "SET DB_INSTRUMENT NAME '/Piano Collection/Bosendorfer' 'Bosendorfer 290'"</t>
5549                                <t>S: "OK"</t>
5550                            </list>
5551                        </t>
5552                    </section>
5553    
5554                    <section title="Moving an instrument" anchor="MOVE DB_INSTRUMENT">
5555                        <t>The front-end can move a specific instrument to another directory by
5556                        sending the following command:</t>
5557                        <t>
5558                            <list>
5559                                <t>MOVE DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5560                            </list>
5561                        </t>
5562                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5563                        to move and &lt;dst&gt; is the directory where the instrument will
5564                        be moved to.</t>
5565    
5566                        <t>Possible Answers:</t>
5567                        <t>
5568                            <list>
5569                                <t>"OK" -
5570                                    <list>
5571                                        <t>on success</t>
5572                                    </list>
5573                                </t>
5574                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5575                                    <list>
5576                                        <t>in case the given instrument does not exists,
5577                                        or if an instrument with name equal to the name of the
5578                                        specified instrument already exists in the destination
5579                                        directory.</t>
5580                                    </list>
5581                                </t>
5582                            </list>
5583                        </t>
5584    
5585                        <t>Example:</t>
5586                        <t>
5587                            <list>
5588                                <t>C: "MOVE DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Piano Collection/Acoustic'"</t>
5589                                <t>S: "OK"</t>
5590                            </list>
5591                        </t>
5592                    </section>
5593    
5594                    <section title="Copying instruments" anchor="COPY DB_INSTRUMENT">
5595                        <t>The front-end can copy a specific instrument to another directory by
5596                        sending the following command:</t>
5597                        <t>
5598                            <list>
5599                                <t>COPY DB_INSTRUMENT &lt;instr&gt; &lt;dst&gt;</t>
5600                            </list>
5601                        </t>
5602                        <t>Where &lt;instr&gt; is the absolute path name of the instrument
5603                        to copy and &lt;dst&gt; is the directory where the instrument will
5604                        be copied to.</t>
5605    
5606                        <t>Possible Answers:</t>
5607                        <t>
5608                            <list>
5609                                <t>"OK" -
5610                                    <list>
5611                                        <t>on success</t>
5612                                    </list>
5613                                </t>
5614                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5615                                    <list>
5616                                        <t>in case the given instrument does not exists,
5617                                        or if an instrument with name equal to the name of the
5618                                        specified instrument already exists in the destination
5619                                        directory.</t>
5620                                    </list>
5621                                </t>
5622                            </list>
5623                        </t>
5624    
5625                        <t>Example:</t>
5626                        <t>
5627                            <list>
5628                                <t>C: "COPY DB_INSTRUMENT '/Piano Collection/Bosendorfer 290' '/Acoustic/Pianos/'"</t>
5629                                <t>S: "OK"</t>
5630                            </list>
5631                        </t>
5632                    </section>
5633    
5634                    <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5635                        <t>The front-end can alter the description of a specific
5636                        instrument by sending the following command:</t>
5637                        <t>
5638                            <list>
5639                                <t>SET DB_INSTRUMENT DESCRIPTION &lt;instr&gt; &lt;desc&gt;</t>
5640                            </list>
5641                        </t>
5642                        <t>Where &lt;instr&gt; is the absolute path name of the instrument and
5643                        &lt;desc&gt; is the new description for the instrument.</t>
5644    
5645                        <t>Possible Answers:</t>
5646                        <t>
5647                            <list>
5648                                <t>"OK" -
5649                                    <list>
5650                                        <t>on success</t>
5651                                    </list>
5652                                </t>
5653                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5654                                    <list>
5655                                        <t>in case the given instrument does not exists.</t>
5656                                    </list>
5657                                </t>
5658                            </list>
5659                        </t>
5660    
5661                        <t>Example:</t>
5662                        <t>
5663                            <list>
5664                                <t>C: "SET DB_INSTRUMENT DESCRIPTION '/Piano Collection/Acoustic/Bosendorfer 290' 'No comment :)'"</t>
5665                                <t>S: "OK"</t>
5666                            </list>
5667                        </t>
5668                    </section>
5669    
5670                    <section title="Finding instruments" anchor="FIND DB_INSTRUMENTS">
5671                        <t>The front-end can search for instruments
5672                        in specific directory by sending the following command:</t>
5673                        <t>
5674                            <list>
5675                                <t>FIND DB_INSTRUMENTS [NON_RECURSIVE] &lt;dir&gt; &lt;criteria-list&gt;</t>
5676                            </list>
5677                        </t>
5678                        <t>Where &lt;dir&gt; should be replaced by the absolute path
5679                        name of the directory to search in. If NON_RECURSIVE is specified, the
5680                        directories located in subdirectories of the specified directory will not
5681                        be searched. &lt;criteria-list&gt; is a list of search criterias
5682                        in form of "key1=val1 key2=val2 ...". The following criterias are
5683                        allowed:</t>
5684                        <t>
5685                          <t>NAME='&lt;search-string&gt;'
5686                              <list>
5687                                  <t>Restricts the search to instruments, which names
5688                                  satisfy the supplied search string.</t>
5689                              </list>
5690                          </t>
5691    
5692                          <t>SIZE=[&lt;min&gt;]..[&lt;max&gt;]
5693                              <list>
5694                                  <t>Restricts the search to instruments, which
5695                                  size is in the specified range. If &lt;min&gt; is omitted,
5696                                  the search results are restricted to instruments with size less then
5697                                  or equal to &lt;max&gt;. If &lt;max&gt; is omitted, the
5698                                  search is restricted to instruments with size greater then
5699                                  or equal to &lt;min&gt;.</t>
5700                              </list>
5701                          </t>
5702    
5703                          <t>CREATED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5704                              <list>
5705                                  <t>Restricts the search to instruments, which creation
5706                                  date satisfies the specified period, where &lt;date-after&gt;
5707                                  and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS" format.
5708                                  If &lt;date-after&gt; is omitted the search is restricted to
5709                                  instruments created before &lt;date-before&gt;. If
5710                                  &lt;date-before&gt; is omitted, the search is restricted
5711                                  to instruments created after &lt;date-after&gt;.</t>
5712                              </list>
5713                          </t>
5714    
5715                          <t>MODIFIED='[&lt;date-after&gt;]..[&lt;date-before&gt;]'
5716                              <list>
5717                                  <t>Restricts the search to instruments, which
5718                                  date of last modification satisfies the specified period, where
5719                                  &lt;date-after&gt; and &lt;date-before&gt; are in "YYYY-MM-DD HH:MM:SS"
5720                                  format. If &lt;date-after&gt; is omitted the search is restricted to
5721                                  instruments, which are last modified before &lt;date-before&gt;. If
5722                                  &lt;date-before&gt; is omitted, the search is restricted to instruments,
5723                                  which are last modified after &lt;date-after&gt;.</t>
5724                              </list>
5725                          </t>
5726    
5727                          <t>DESCRIPTION='&lt;search-string&gt;'
5728                              <list>
5729                                  <t>Restricts the search to instruments with description
5730                                  that satisfies the supplied search string.</t>
5731                              </list>
5732                          </t>
5733    
5734                          <t>PRODUCT='&lt;search-string&gt;'
5735                              <list>
5736                                  <t>Restricts the search to instruments with product info
5737                                  that satisfies the supplied search string.</t>
5738                              </list>
5739                          </t>
5740    
5741                          <t>ARTISTS='&lt;search-string&gt;'
5742                              <list>
5743                                  <t>Restricts the search to instruments with artists info
5744                                  that satisfies the supplied search string.</t>
5745                              </list>
5746                          </t>
5747    
5748                          <t>KEYWORDS='&lt;search-string&gt;'
5749                              <list>
5750                                  <t>Restricts the search to instruments with keyword list
5751                                  that satisfies the supplied search string.</t>
5752                              </list>
5753                          </t>
5754    
5755                          <t>IS_DRUM=true | false
5756                              <list>
5757                                  <t>Either true or false. Restricts the search to
5758                                  drum kits or chromatic instruments.</t>
5759                              </list>
5760                          </t>
5761    
5762                          <t>FORMAT_FAMILIES='&lt;format-list&gt;'
5763                              <list>
5764                                  <t>Restricts the search to instruments of the supplied format families,
5765                                  where &lt;format-list&gt; is a comma separated list of format families.</t>
5766                              </list>
5767                          </t>
5768                        </t>
5769    
5770                        <t>Where &lt;search-string&gt; is either a regular expression, or a
5771                        word list separated with spaces for OR search and with '+' for AND search.</t>
5772    
5773                        <t>Possible Answers:</t>
5774                        <t>
5775                            <list>
5776                                <t>A comma separated list with the absolute path names (encapsulated into
5777                                apostrophes) of all instruments in the specified directory that satisfy
5778                                the supplied search criterias.</t>
5779                                <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
5780                                    <list>
5781                                        <t>if the given directory does not exist.</t>
5782                                    </list>
5783                                </t>
5784                            </list>
5785                        </t>
5786                        <t>Example:</t>
5787                        <t>
5788                            <list>
5789                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' NAME='bosendorfer+290'"</t>
5790                                <t>S: "'/Piano Collection/Bosendorfer 290'"</t>
5791                            </list>
5792                        </t>
5793                        <t>
5794                            <list>
5795                                <t>C: "FIND DB_INSTRUMENTS '/Piano Collection' CREATED='2007-04-01 09:30:13..'"</t>
5796                                <t>S: "'/Piano Collection/Bosendorfer 290','/Piano Collection/Steinway D'"</t>
5797                            </list>
5798                        </t>
5799                    </section>
5800    
5801                    <section title="Getting job status information" anchor="GET DB_INSTRUMENTS_JOB INFO">
5802                        <t>The front-end can ask for the current status of a
5803                        particular database instruments job by sending the following command:</t>
5804                        <t>
5805                            <list>
5806                                <t>GET DB_INSTRUMENTS_JOB INFO &lt;job-id&gt;</t>
5807                            </list>
5808                        </t>
5809                        <t>Where &lt;job-id&gt; should be replaced by the numerical ID
5810                        of the job the front-end is interested in.</t>
5811    
5812                        <t>Possible Answers:</t>
5813                        <t>
5814                            <list>
5815                                <t>LinuxSampler will answer by sending a &lt;CRLF&gt; separated list.
5816                                Each answer line begins with the settings category name
5817                                followed by a colon and then a space character &lt;SP&gt; and finally
5818                                the info character string to that setting category. At the
5819                                moment the following categories are defined:</t>
5820    
5821                                <t>
5822                                    <list>
5823                                        <t>FILES_TOTAL -
5824                                            <list>
5825                                                <t>The total number of files scheduled for scanning</t>
5826                                            </list>
5827                                        </t>
5828                                        <t>FILES_SCANNED -
5829                                            <list>
5830                                                <t>The current number of scanned files</t>
5831                                            </list>
5832                                        </t>
5833                                        <t>SCANNING -
5834                                            <list>
5835                                                <t>The absolute path name of the file which is currently
5836                                                being scanned</t>
5837                                            </list>
5838                                        </t>
5839                                        <t>STATUS -
5840                                            <list>
5841                                                <t>An integer value between 0 and 100 indicating the
5842                                                scanning progress percentage of the file which is
5843                                                currently being scanned</t>
5844                                            </list>
5845                                        </t>
5846                                    </list>
5847                                </t>
5848                            </list>
5849                        </t>
5850                        <t>The mentioned fields above don't have to be in particular order.</t>
5851    
5852                        <t>Example:</t>
5853                        <t>
5854                            <list>
5855                                <t>C: "GET DB_INSTRUMENTS_JOB INFO 2"</t>
5856                                <t>S: "FILES_TOTAL: 12"</t>
5857                                <t>&nbsp;&nbsp;&nbsp;"FILES_SCANNED: 7"</t>
5858                                <t>&nbsp;&nbsp;&nbsp;"SCANNING: /home/me/gigs/Bosendorfer 290.gig"</t>
5859                                <t>&nbsp;&nbsp;&nbsp;"STATUS: 42"</t>
5860                                <t>&nbsp;&nbsp;&nbsp;"."</t>
5861                            </list>
5862                        </t>
5863                    </section>
5864    
5865                </section>
5866    
5867          </section>          </section>
5868    
5869    
# Line 4761  Schoenebeck'> Line 5939  Schoenebeck'>
5939                  </t>                  </t>
5940                  <t>/ UNSUBSCRIBE SP unsubscribe_event                  <t>/ UNSUBSCRIBE SP unsubscribe_event
5941                  </t>                  </t>
                 <t>/ SELECT SP text  
                 </t>  
5942                  <t>/ RESET SP reset_instruction                  <t>/ RESET SP reset_instruction
5943                  </t>                  </t>
5944                  <t>/ CLEAR SP clear_instruction                  <t>/ CLEAR SP clear_instruction
5945                  </t>                  </t>
5946                    <t>/ FIND SP find_instruction
5947                    </t>
5948                    <t>/ MOVE SP move_instruction
5949                    </t>
5950                    <t>/ COPY SP copy_instruction
5951                    </t>
5952                  <t>/ RESET                  <t>/ RESET
5953                  </t>                  </t>
5954                  <t>/ QUIT                  <t>/ QUIT
# Line 4777  Schoenebeck'> Line 5959  Schoenebeck'>
5959          <list>          <list>
5960                  <t>CHANNEL                  <t>CHANNEL
5961                  </t>                  </t>
5962                    <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
5963                    </t>
5964                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP scan_mode SP pathname SP pathname
5965                    </t>
5966                    <t>/ DB_INSTRUMENTS SP scan_mode SP pathname SP pathname
5967                    </t>
5968                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname
5969                    </t>
5970                    <t>/ DB_INSTRUMENTS SP NON_MODAL SP pathname SP pathname SP instrument_index
5971                    </t>
5972                    <t>/ DB_INSTRUMENTS SP pathname SP pathname
5973                    </t>
5974                    <t>/ DB_INSTRUMENTS SP pathname SP pathname SP instrument_index
5975                    </t>
5976                  <t>/ MIDI_INSTRUMENT_MAP                  <t>/ MIDI_INSTRUMENT_MAP
5977                  </t>                  </t>
5978                  <t>/ MIDI_INSTRUMENT_MAP SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP map_name
# Line 4815  Schoenebeck'> Line 6011  Schoenebeck'>
6011                  </t>                  </t>
6012                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
6013                  </t>                  </t>
6014                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6015                    </t>
6016                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6017                    </t>
6018                    <t>/ DB_INSTRUMENT_COUNT
6019                    </t>
6020                    <t>/ DB_INSTRUMENT_INFO
6021                    </t>
6022                    <t>/ DB_INSTRUMENTS_JOB_INFO
6023                    </t>
6024                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6025                  </t>                  </t>
6026                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 4855  Schoenebeck'> Line 6061  Schoenebeck'>
6061                  </t>                  </t>
6062                  <t>/ MIDI_INSTRUMENT_INFO                  <t>/ MIDI_INSTRUMENT_INFO
6063                  </t>                  </t>
6064                    <t>/ DB_INSTRUMENT_DIRECTORY_COUNT
6065                    </t>
6066                    <t>/ DB_INSTRUMENT_DIRECTORY_INFO
6067                    </t>
6068                    <t>/ DB_INSTRUMENT_COUNT
6069                    </t>
6070                    <t>/ DB_INSTRUMENT_INFO
6071                    </t>
6072                    <t>/ DB_INSTRUMENTS_JOB_INFO
6073                    </t>
6074                  <t>/ MISCELLANEOUS                  <t>/ MISCELLANEOUS
6075                  </t>                  </t>
6076                  <t>/ TOTAL_VOICE_COUNT                  <t>/ TOTAL_VOICE_COUNT
# Line 4889  Schoenebeck'> Line 6105  Schoenebeck'>
6105                  </t>                  </t>
6106                  <t>/ MIDI_INSTRUMENT_MAP SP ALL                  <t>/ MIDI_INSTRUMENT_MAP SP ALL
6107                  </t>                  </t>
6108                    <t>/ DB_INSTRUMENT_DIRECTORY SP FORCE SP pathname
6109                    </t>
6110                    <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
6111                    </t>
6112                    <t>/ DB_INSTRUMENT SP pathname
6113                    </t>
6114          </list>          </list>
6115  </t>  </t>
6116  <t>get_instruction =  <t>get_instruction =
# Line 4959  Schoenebeck'> Line 6181  Schoenebeck'>
6181                  </t>                  </t>
6182                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id                  <t>/ FX_SEND SP INFO SP sampler_channel SP fx_send_id
6183                  </t>                  </t>
6184                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6185                    </t>
6186                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6187                    </t>
6188                    <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6189                    </t>
6190                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6191                    </t>
6192                    <t>/ DB_INSTRUMENTS SP pathname
6193                    </t>
6194                    <t>/ DB_INSTRUMENT SP INFO SP pathname
6195                    </t>
6196                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6197                    </t>
6198                  <t>/ VOLUME                  <t>/ VOLUME
6199                  </t>                  </t>
6200          </list>          </list>
# Line 4977  Schoenebeck'> Line 6213  Schoenebeck'>
6213                  </t>                  </t>
6214                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name                  <t>/ MIDI_INSTRUMENT_MAP SP NAME SP midi_map SP map_name
6215                  </t>                  </t>
6216                    <t>/ FX_SEND SP NAME SP sampler_channel SP fx_send_id SP fx_send_name
6217                    </t>
6218                  <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
6219                  </t>                  </t>
6220                  <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
6221                  </t>                  </t>
6222                  <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
6223                  </t>                  </t>
6224                    <t>/ DB_INSTRUMENT_DIRECTORY SP NAME SP pathname SP dirname
6225                    </t>
6226                    <t>/ DB_INSTRUMENT_DIRECTORY SP DESCRIPTION SP pathname SP stringval
6227                    </t>
6228                    <t>/ DB_INSTRUMENT SP NAME SP pathname SP dirname
6229                    </t>
6230                    <t>/ DB_INSTRUMENT SP DESCRIPTION SP pathname SP stringval
6231                    </t>
6232                  <t>/ ECHO SP boolean                  <t>/ ECHO SP boolean
6233                  </t>                  </t>
6234                  <t>/ VOLUME SP volume_value                  <t>/ VOLUME SP volume_value
# Line 5019  Schoenebeck'> Line 6265  Schoenebeck'>
6265                  </t>                  </t>
6266          </list>          </list>
6267  </t>  </t>
6268    <t>find_instruction =
6269            <list>
6270                    <t>DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP query_val_list
6271                    </t>
6272                    <t>/ DB_INSTRUMENTS SP pathname SP query_val_list
6273                    </t>
6274                    <t>/ DB_INSTRUMENT_DIRECTORIES SP NON_RECURSIVE SP pathname SP query_val_list
6275                    </t>
6276                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname SP query_val_list
6277                    </t>
6278            </list>
6279    </t>
6280    <t>move_instruction =
6281            <list>
6282                    <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6283                    </t>
6284                    <t>/ DB_INSTRUMENT SP pathname SP pathname
6285                    </t>
6286            </list>
6287    </t>
6288    <t>copy_instruction =
6289            <list>
6290                    <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
6291                    </t>
6292                    <t>/ DB_INSTRUMENT SP pathname SP pathname
6293                    </t>
6294            </list>
6295    </t>
6296  <t>destroy_instruction =  <t>destroy_instruction =
6297          <list>          <list>
6298                  <t>AUDIO_OUTPUT_DEVICE SP number                  <t>AUDIO_OUTPUT_DEVICE SP number
# Line 5115  Schoenebeck'> Line 6389  Schoenebeck'>
6389                  </t>                  </t>
6390                  <t>/ FX_SENDS SP sampler_channel                  <t>/ FX_SENDS SP sampler_channel
6391                  </t>                  </t>
6392                    <t>/ DB_INSTRUMENT_DIRECTORIES SP RECURSIVE SP pathname
6393                    </t>
6394                    <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6395                    </t>
6396                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6397                    </t>
6398                    <t>/ DB_INSTRUMENTS SP pathname
6399                    </t>
6400          </list>          </list>
6401  </t>  </t>
6402  <t>load_instr_args =  <t>load_instr_args =
# Line 5235  Schoenebeck'> Line 6517  Schoenebeck'>
6517                  </t>                  </t>
6518          </list>          </list>
6519  </t>  </t>
6520    <t>pathname =
6521            <list>
6522                    <t>stringval
6523                    </t>
6524            </list>
6525    </t>
6526    <t>dirname =
6527            <list>
6528                    <t>stringval
6529                    </t>
6530            </list>
6531    </t>
6532  <t>filename =  <t>filename =
6533          <list>          <list>
6534                  <t>stringval                  <t>stringval
# Line 5279  Schoenebeck'> Line 6573  Schoenebeck'>
6573                  </t>                  </t>
6574          </list>          </list>
6575  </t>  </t>
6576    <t>query_val_list =
6577            <list>
6578                    <t>string '=' query_val
6579                    </t>
6580                    <t>/ query_val_list SP string '=' query_val
6581                    </t>
6582            </list>
6583    </t>
6584    <t>query_val =
6585            <list>
6586                    <t>string
6587                    </t>
6588                    <t>/ stringval
6589                    </t>
6590            </list>
6591    </t>
6592    <t>scan_mode =
6593            <list>
6594                    <t>RECURSIVE
6595                    </t>
6596                    <t>/ NON_RECURSIVE
6597                    </t>
6598                    <t>/ FLAT
6599                    </t>
6600            </list>
6601    </t>
6602    
6603              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->              <!-- GRAMMAR_BNF_END - do NOT delete or modify this line !!! -->
6604          </section>          </section>
# Line 5622  Schoenebeck'> Line 6942  Schoenebeck'>
6942                  </t>                  </t>
6943              </section>              </section>
6944    
6945                <section title="Number of database instrument directories changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT">
6946                    <t>Client may want to be notified when the number of instrument
6947                    directories in a particular directory in the instruments database
6948                    is changed by issuing the following command:</t>
6949                    <t>
6950                        <list>
6951                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_COUNT</t>
6952                        </list>
6953                    </t>
6954                    <t>Server will start sending the following notification messages:</t>
6955                    <t>
6956                        <list>
6957                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_COUNT:&lt;dir-path&gt;"</t>
6958                        </list>
6959                    </t>
6960                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
6961                    name of the directory in the instruments database,
6962                    in which the number of directories is changed.</t>
6963                    <t>Note that when a non-empty directory is removed, this event
6964                    is not sent for the subdirectories in that directory.</t>
6965                </section>
6966    
6967                <section title="Database instrument directory information changed" anchor="SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO">
6968                    <t>Client may want to be notified when changes were made to directories
6969                    in the instruments database by issuing the following command:</t>
6970                    <t>
6971                        <list>
6972                            <t>SUBSCRIBE DB_INSTRUMENT_DIRECTORY_INFO</t>
6973                        </list>
6974                    </t>
6975                    <t>Server will start sending the following notification messages:</t>
6976                    <t>
6977                        <list>
6978                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:&lt;dir-path&gt;"</t>
6979                        </list>
6980                    </t>
6981                    <t>where &lt;dir-path&gt; will be replaced by the absolute path name
6982                    of the directory, for which information changes occurred. The front-end will have to send
6983                    the respective command to actually get the updated directory info. Because these messages
6984                    will be triggered by LSCP commands issued by other clients rather than real
6985                    time events happening on the server, it is believed that an empty notification
6986                    message is sufficient here.</t>
6987                    <t>
6988                        <list>
6989                            <t>"NOTIFY:DB_INSTRUMENT_DIRECTORY_INFO:NAME &lt;old-dir-path&gt; &lt;new-name&gt;"</t>
6990                        </list>
6991                    </t>
6992                    <t>where &lt;old-dir-path&gt; is the old absolute path name of the directory
6993                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
6994                    the new name of the directory, encapsulated into apostrophes.</t>
6995                </section>
6996    
6997                <section title="Number of database instruments changed" anchor="SUBSCRIBE DB_INSTRUMENT_COUNT">
6998                    <t>Client may want to be notified when the number of instruments
6999                    in a particular directory in the instruments database
7000                    is changed by issuing the following command:</t>
7001                    <t>
7002                        <list>
7003                            <t>SUBSCRIBE DB_INSTRUMENT_COUNT</t>
7004                        </list>
7005                    </t>
7006                    <t>Server will start sending the following notification messages:</t>
7007                    <t>
7008                        <list>
7009                            <t>"NOTIFY:DB_INSTRUMENT_COUNT:&lt;dir-path&gt;"</t>
7010                        </list>
7011                    </t>
7012                    <t>where &lt;dir-path&gt; will be replaced by the absolute path
7013                    name of the directory in the instruments database,
7014                    in which the number of instruments is changed.</t>
7015                    <t>Note that when a non-empty directory is removed, this event
7016                    is not sent for the instruments in that directory.</t>
7017                </section>
7018    
7019                <section title="Database instrument information changed" anchor="SUBSCRIBE DB_INSTRUMENT_INFO">
7020                    <t>Client may want to be notified when changes were made to instruments
7021                    in the instruments database by issuing the following command:</t>
7022                    <t>
7023                        <list>
7024                            <t>SUBSCRIBE DB_INSTRUMENT_INFO</t>
7025                        </list>
7026                    </t>
7027                    <t>Server will start sending the following notification messages:</t>
7028                    <t>
7029                        <list>
7030                            <t>"NOTIFY:DB_INSTRUMENT_INFO:&lt;instr-path&gt;"</t>
7031                        </list>
7032                    </t>
7033                    <t>where &lt;instr-path&gt; will be replaced by the absolute path name
7034                    of the instrument, which settings are changed. The front-end will have to send
7035                    the respective command to actually get the updated directory info. Because these messages
7036                    will be triggered by LSCP commands issued by other clients rather than real
7037                    time events happening on the server, it is believed that an empty notification
7038                    message is sufficient here.</t>
7039                    <t>
7040                        <list>
7041                            <t>"NOTIFY:DB_INSTRUMENT_INFO:NAME &lt;old-instr-path&gt; &lt;new-name&gt;"</t>
7042                        </list>
7043                    </t>
7044                    <t>where &lt;old-instr-path&gt; is the old absolute path name of the instrument
7045                    (encapsulated into apostrophes), which name is changes and &lt;new-name&gt; is
7046                    the new name of the instrument, encapsulated into apostrophes.</t>
7047                </section>
7048    
7049                <section title="Database job status information changed" anchor="SUBSCRIBE DB_INSTRUMENTS_JOB_INFO">
7050                    <t>Client may want to be notified when the status of particular database
7051                    instruments job is changed by issuing the following command:</t>
7052                    <t>
7053                        <list>
7054                            <t>SUBSCRIBE DB_INSTRUMENTS_JOB_INFO</t>
7055                        </list>
7056                    </t>
7057                    <t>Server will start sending the following notification messages:</t>
7058                    <t>
7059                        <list>
7060                            <t>"NOTIFY:DB_INSTRUMENTS_JOB_INFO:&lt;job-id&gt;"</t>
7061                        </list>
7062                    </t>
7063                    <t>where &lt;job-id&gt; will be replaced by the numerical ID of the job,
7064                    which status is changed. The front-end will have to send the respective
7065                    command to actually get the status info. Because these messages
7066                    will be triggered by LSCP commands issued by other clients rather than real
7067                    time events happening on the server, it is believed that an empty notification
7068                    message is sufficient here.</t>
7069                </section>
7070    
7071              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">              <section title="Miscellaneous and debugging events" anchor="SUBSCRIBE MISCELLANEOUS">
7072                  <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
7073                  the server by issuing the following command:</t>                  the server by issuing the following command:</t>
Legend:
Removed from v.1109  
changed lines
  Added in v.1200
  ViewVC Help
Powered by ViewVC