/[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 1161 by iliev, Mon Apr 16 15:51:18 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="April" 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 4827  Schoenebeck'> Line 4827  Schoenebeck'>
4827                      directories in a specific directory by sending the following command:</t>                      directories in a specific directory by sending the following command:</t>
4828                      <t>                      <t>
4829                          <list>                          <list>
4830                              <t>GET DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>                              <t>GET DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4831                          </list>                          </list>
4832                      </t>                      </t>
4833                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
4834                      name of the directory.</t>                      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>                      <t>Possible Answers:</t>
4839                      <t>                      <t>
# Line 4860  Schoenebeck'> Line 4862  Schoenebeck'>
4862                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
4863                      <t>                      <t>
4864                          <list>                          <list>
4865                              <t>LIST DB_INSTRUMENT_DIRECTORIES &lt;dir&gt;</t>                              <t>LIST DB_INSTRUMENT_DIRECTORIES [RECURSIVE] &lt;dir&gt;</t>
4866                          </list>                          </list>
4867                      </t>                      </t>
4868                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
4869                      name of the directory.</t>                      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>                      <t>Possible Answers:</t>
4874                      <t>                      <t>
# Line 4885  Schoenebeck'> Line 4889  Schoenebeck'>
4889                              <t>S: "'Piano Collection','Percussion Collection'"</t>                              <t>S: "'Piano Collection','Percussion Collection'"</t>
4890                          </list>                          </list>
4891                      </t>                      </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>                  </section>
4899    
4900                  <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">                  <section title="Getting instrument directory information" anchor="GET DB_INSTRUMENT_DIRECTORY INFO">
# Line 5024  Schoenebeck'> Line 5034  Schoenebeck'>
5034                      </t>                      </t>
5035                  </section>                  </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">                  <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                      <t>The front-end can alter the description of a specific
5081                      instrument directory by sending the following command:</t>                      instrument directory by sending the following command:</t>
# Line 5060  Schoenebeck'> Line 5112  Schoenebeck'>
5112                      </t>                      </t>
5113                  </section>                  </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">                  <section title="Adding instruments to the instruments database" anchor="ADD DB_INSTRUMENTS">
5201                      <t>The front-end can add one or more instruments                      <t>The front-end can add one or more instruments
5202                      to the instruments database by sending the following command:</t>                      to the instruments database by sending the following command:</t>
5203                      <t>                      <t>
5204                          <list>                          <list>
5205                              <t>ADD DB_INSTRUMENTS [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>                              <t>ADD DB_INSTRUMENTS [NON_MODAL] [&lt;mode&gt;] &lt;db_dir&gt; &lt;file_path&gt; [&lt;instr_index&gt;]</t>
5206                          </list>                          </list>
5207                      </t>                      </t>
5208                      <t>Where &lt;db_dir&gt; is the absolute path name of a directory                      <t>Where &lt;db_dir&gt; is the absolute path name of a directory
# Line 5083  Schoenebeck'> Line 5220  Schoenebeck'>
5220                      scanning will be done and has exactly the following possibilities:</t>                      scanning will be done and has exactly the following possibilities:</t>
5221                      <t>                      <t>
5222                          <list>                          <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" -                              <t>"NON_RECURSIVE" -
5232                                  <list>                                  <list>
5233                                      <t>Only the instruments in the specified directory                                      <t>Only the instruments in the specified directory
# Line 5099  Schoenebeck'> Line 5244  Schoenebeck'>
5244                                      the specified database directory.</t>                                      the specified database directory.</t>
5245                                  </list>                                  </list>
5246                              </t>                              </t>
                             <t>not supplied -  
                                 <list>  
                                     <t>The subdirectory tree structure will be recreated  
                                     in the instruments database and all instruments will be  
                                     processed and added to the respective subdirectory  
                                     in the instruments database.</t>  
                                 </list>  
                             </t>  
5247                          </list>                          </list>
5248                      </t>                      </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>                      <t>Possible Answers:</t>
5257                      <t>                      <t>
5258                          <list>                          <list>
5259                              <t>"OK" -                              <t>"OK" -
5260                                  <list>                                  <list>
5261                                      <t>on success</t>                                      <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>                                  </list>
5271                              </t>                              </t>
5272                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -                              <t>"ERR:&lt;error-code&gt;:&lt;error-message&gt;" -
# Line 5177  Schoenebeck'> Line 5328  Schoenebeck'>
5328                      instruments in a specific directory by sending the following command:</t>                      instruments in a specific directory by sending the following command:</t>
5329                      <t>                      <t>
5330                          <list>                          <list>
5331                              <t>GET DB_INSTRUMENTS &lt;dir&gt;</t>                              <t>GET DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5332                          </list>                          </list>
5333                      </t>                      </t>
5334                      <t>Where &lt;dir&gt; should be replaced by the absolute path name                      <t>Where &lt;dir&gt; should be replaced by the absolute path name
5335                      of the directory.</t>                      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>                      <t>Possible Answers:</t>
5340                      <t>                      <t>
# Line 5210  Schoenebeck'> Line 5363  Schoenebeck'>
5363                      in specific directory by sending the following command:</t>                      in specific directory by sending the following command:</t>
5364                      <t>                      <t>
5365                          <list>                          <list>
5366                              <t>LIST DB_INSTRUMENTS &lt;dir&gt;</t>                              <t>LIST DB_INSTRUMENTS [RECURSIVE] &lt;dir&gt;</t>
5367                          </list>                          </list>
5368                      </t>                      </t>
5369                      <t>Where &lt;dir&gt; should be replaced by the absolute path                      <t>Where &lt;dir&gt; should be replaced by the absolute path
5370                      name of the directory.</t>                      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>                      <t>Possible Answers:</t>
5375                      <t>                      <t>
# Line 5235  Schoenebeck'> Line 5390  Schoenebeck'>
5390                              <t>S: "'Bosendorfer 290','Steinway D'"</t>                              <t>S: "'Bosendorfer 290','Steinway D'"</t>
5391                          </list>                          </list>
5392                      </t>                      </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>                  </section>
5400    
5401                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">                  <section title="Getting instrument information" anchor="GET DB_INSTRUMENT INFO">
# Line 5430  Schoenebeck'> Line 5591  Schoenebeck'>
5591                      </t>                      </t>
5592                  </section>                  </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">                  <section title="Changing the description of instrument" anchor="SET DB_INSTRUMENT DESCRIPTION">
5635                      <t>The front-end can alter the description of a specific                      <t>The front-end can alter the description of a specific
5636                      instrument by sending the following command:</t>                      instrument by sending the following command:</t>
# Line 5466  Schoenebeck'> Line 5667  Schoenebeck'>
5667                      </t>                      </t>
5668                  </section>                  </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>              </section>
5866    
5867          </section>          </section>
# Line 5547  Schoenebeck'> Line 5943  Schoenebeck'>
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                  <t>/ MOVE SP move_instruction
5949                  </t>                  </t>
5950                    <t>/ COPY SP copy_instruction
5951                    </t>
5952                  <t>/ RESET                  <t>/ RESET
5953                  </t>                  </t>
5954                  <t>/ QUIT                  <t>/ QUIT
# Line 5561  Schoenebeck'> Line 5961  Schoenebeck'>
5961                  </t>                  </t>
5962                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP pathname
5963                  </t>                  </t>
5964                  <t>/ DB_INSTRUMENTS SP FLAT SP pathname SP pathname                  <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>                  </t>
5968                  <t>/ DB_INSTRUMENTS SP NON_RECURSIVE SP pathname SP pathname                  <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>                  </t>
5972                  <t>/ DB_INSTRUMENTS SP pathname SP pathname                  <t>/ DB_INSTRUMENTS SP pathname SP pathname
5973                  </t>                  </t>
# Line 5615  Schoenebeck'> Line 6019  Schoenebeck'>
6019                  </t>                  </t>
6020                  <t>/ DB_INSTRUMENT_INFO                  <t>/ DB_INSTRUMENT_INFO
6021                  </t>                  </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 5663  Schoenebeck'> Line 6069  Schoenebeck'>
6069                  </t>                  </t>
6070                  <t>/ DB_INSTRUMENT_INFO                  <t>/ DB_INSTRUMENT_INFO
6071                  </t>                  </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 5773  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                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6187                  </t>                  </t>
6188                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname                  <t>/ DB_INSTRUMENT_DIRECTORY SP INFO SP pathname
6189                  </t>                  </t>
6190                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6191                    </t>
6192                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP pathname
6193                  </t>                  </t>
6194                  <t>/ DB_INSTRUMENT SP INFO SP pathname                  <t>/ DB_INSTRUMENT SP INFO SP pathname
6195                  </t>                  </t>
6196                    <t>/ DB_INSTRUMENTS_JOB SP INFO SP number
6197                    </t>
6198                  <t>/ VOLUME                  <t>/ VOLUME
6199                  </t>                  </t>
6200          </list>          </list>
# Line 5851  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 =  <t>move_instruction =
6281          <list>          <list>
6282                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname                  <t>DB_INSTRUMENT_DIRECTORY SP pathname SP pathname
# Line 5859  Schoenebeck'> Line 6285  Schoenebeck'>
6285                  </t>                  </t>
6286          </list>          </list>
6287  </t>  </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 5955  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                  <t>/ DB_INSTRUMENT_DIRECTORIES SP pathname
6395                  </t>                  </t>
6396                    <t>/ DB_INSTRUMENTS SP RECURSIVE SP pathname
6397                    </t>
6398                  <t>/ DB_INSTRUMENTS SP pathname                  <t>/ DB_INSTRUMENTS SP pathname
6399                  </t>                  </t>
6400          </list>          </list>
# Line 6135  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 6582  Schoenebeck'> Line 7046  Schoenebeck'>
7046                  the new name of the instrument, encapsulated into apostrophes.</t>                  the new name of the instrument, encapsulated into apostrophes.</t>
7047              </section>              </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.1161  
changed lines
  Added in v.1200
  ViewVC Help
Powered by ViewVC