add new api docs.
[lms] / www / python-api / lightmediascanner-pysrc.html
1 <?xml version="1.0" encoding="ascii"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3           "DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6   <title>lightmediascanner</title>
7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
8   <script type="text/javascript" src="epydoc.js"></script>
9 </head>
10
11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
12       alink="#204080">
13 <!-- ==================== NAVIGATION BAR ==================== -->
14 <table class="navbar" border="0" width="100%" cellpadding="0"
15        bgcolor="#a0c0ff" cellspacing="0">
16   <tr valign="middle">
17   <!-- Home link -->
18       <th bgcolor="#70b0f0" class="navbar-select"
19           >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
20
21   <!-- Tree link -->
22       <th>&nbsp;&nbsp;&nbsp;<a
23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25   <!-- Index link -->
26       <th>&nbsp;&nbsp;&nbsp;<a
27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29   <!-- Help link -->
30       <th>&nbsp;&nbsp;&nbsp;<a
31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33   <!-- Project homepage -->
34       <th class="navbar" align="right" width="100%">
35         <table border="0" cellpadding="0" cellspacing="0">
36           <tr><th class="navbar" align="center"
37             >Python-LightMediaScanner API</th>
38           </tr></table></th>
39   </tr>
40 </table>
41 <table width="100%" cellpadding="0" cellspacing="0">
42   <tr valign="top">
43     <td width="100%">
44       <span class="breadcrumbs">
45         Package&nbsp;lightmediascanner
46       </span>
47     </td>
48     <td>
49       <table cellpadding="0" cellspacing="0">
50         <!-- hide/show private -->
51         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
52     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
53         <tr><td align="right"><span class="options"
54             >[<a href="frames.html" target="_top">frames</a
55             >]&nbsp;|&nbsp;<a href="lightmediascanner-pysrc.html"
56             target="_top">no&nbsp;frames</a>]</span></td></tr>
57       </table>
58     </td>
59   </tr>
60 </table>
61 <h1 class="epydoc">Source Code for <a href="lightmediascanner-module.html">Package lightmediascanner</a></h1>
62 <pre class="py-src">
63 <a name="L1"></a><tt class="py-lineno"> 1</tt>  <tt class="py-line"><tt class="py-comment"># Copyright (C) 2007 by INdT</tt> </tt>
64 <a name="L2"></a><tt class="py-lineno"> 2</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
65 <a name="L3"></a><tt class="py-lineno"> 3</tt>  <tt class="py-line"><tt class="py-comment"># This program is free software; you can redistribute it and/or</tt> </tt>
66 <a name="L4"></a><tt class="py-lineno"> 4</tt>  <tt class="py-line"><tt class="py-comment"># modify it under the terms of the GNU Lesser General Public License</tt> </tt>
67 <a name="L5"></a><tt class="py-lineno"> 5</tt>  <tt class="py-line"><tt class="py-comment"># as published by the Free Software Foundation; either version 2</tt> </tt>
68 <a name="L6"></a><tt class="py-lineno"> 6</tt>  <tt class="py-line"><tt class="py-comment"># of the License, or (at your option) any later version.</tt> </tt>
69 <a name="L7"></a><tt class="py-lineno"> 7</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
70 <a name="L8"></a><tt class="py-lineno"> 8</tt>  <tt class="py-line"><tt class="py-comment"># This program is distributed in the hope that it will be useful,</tt> </tt>
71 <a name="L9"></a><tt class="py-lineno"> 9</tt>  <tt class="py-line"><tt class="py-comment"># but WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
72 <a name="L10"></a><tt class="py-lineno">10</tt>  <tt class="py-line"><tt class="py-comment"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</tt> </tt>
73 <a name="L11"></a><tt class="py-lineno">11</tt>  <tt class="py-line"><tt class="py-comment"># GNU General Public License for more details.</tt> </tt>
74 <a name="L12"></a><tt class="py-lineno">12</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
75 <a name="L13"></a><tt class="py-lineno">13</tt>  <tt class="py-line"><tt class="py-comment"># You should have received a copy of the GNU Lesser General Public License</tt> </tt>
76 <a name="L14"></a><tt class="py-lineno">14</tt>  <tt class="py-line"><tt class="py-comment"># along with this program; if not, write to the Free Software</tt> </tt>
77 <a name="L15"></a><tt class="py-lineno">15</tt>  <tt class="py-line"><tt class="py-comment"># Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</tt> </tt>
78 <a name="L16"></a><tt class="py-lineno">16</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
79 <a name="L17"></a><tt class="py-lineno">17</tt>  <tt class="py-line"><tt class="py-comment"># @author Gustavo Sverzut Barbieri &lt;gustavo.barbieri@openbossa.org&gt;</tt> </tt>
80 <a name="L18"></a><tt class="py-lineno">18</tt>  <tt class="py-line"> </tt>
81 <a name="L19"></a><tt class="py-lineno">19</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module lightmediascanner.c_lightmediascanner=lightmediascanner.c_lightmediascanner-module.html"><a title="lightmediascanner.c_lightmediascanner" class="py-name" href="#" onclick="return doclink('link-0', 'c_lightmediascanner', 'link-0');">c_lightmediascanner</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name" targets="Class lightmediascanner.c_lightmediascanner.LightMediaScanner=lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html"><a title="lightmediascanner.c_lightmediascanner.LightMediaScanner" class="py-name" href="#" onclick="return doclink('link-1', 'LightMediaScanner', 'link-1');">LightMediaScanner</a></tt><tt class="py-op">,</tt> \ </tt>
82 <a name="L20"></a><tt class="py-lineno">20</tt>  <tt class="py-line">     <tt id="link-2" class="py-name" targets="Function lightmediascanner.c_lightmediascanner.parser_info()=lightmediascanner.c_lightmediascanner-module.html#parser_info"><a title="lightmediascanner.c_lightmediascanner.parser_info" class="py-name" href="#" onclick="return doclink('link-2', 'parser_info', 'link-2');">parser_info</a></tt><tt class="py-op">,</tt> <tt id="link-3" class="py-name" targets="Function lightmediascanner.c_lightmediascanner.parser_info_find()=lightmediascanner.c_lightmediascanner-module.html#parser_info_find"><a title="lightmediascanner.c_lightmediascanner.parser_info_find" class="py-name" href="#" onclick="return doclink('link-3', 'parser_info_find', 'link-3');">parser_info_find</a></tt><tt class="py-op">,</tt> \ </tt>
83 <a name="L21"></a><tt class="py-lineno">21</tt>  <tt class="py-line">     <tt id="link-4" class="py-name" targets="Function lightmediascanner.c_lightmediascanner.parsers_list()=lightmediascanner.c_lightmediascanner-module.html#parsers_list"><a title="lightmediascanner.c_lightmediascanner.parsers_list" class="py-name" href="#" onclick="return doclink('link-4', 'parsers_list', 'link-4');">parsers_list</a></tt><tt class="py-op">,</tt> <tt id="link-5" class="py-name" targets="Function lightmediascanner.c_lightmediascanner.parsers_list_by_category()=lightmediascanner.c_lightmediascanner-module.html#parsers_list_by_category"><a title="lightmediascanner.c_lightmediascanner.parsers_list_by_category" class="py-name" href="#" onclick="return doclink('link-5', 'parsers_list_by_category', 'link-5');">parsers_list_by_category</a></tt> </tt>
84 <a name="L22"></a><tt class="py-lineno">22</tt>  <tt class="py-line"> </tt>
85 <a name="L23"></a><tt class="py-lineno">23</tt>  <tt class="py-line"><tt id="link-6" class="py-name" targets="Variable lightmediascanner.LMS_PROGRESS_STATUS_UP_TO_DATE=lightmediascanner-module.html#LMS_PROGRESS_STATUS_UP_TO_DATE"><a title="lightmediascanner.LMS_PROGRESS_STATUS_UP_TO_DATE" class="py-name" href="#" onclick="return doclink('link-6', 'LMS_PROGRESS_STATUS_UP_TO_DATE', 'link-6');">LMS_PROGRESS_STATUS_UP_TO_DATE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
86 <a name="L24"></a><tt class="py-lineno">24</tt>  <tt class="py-line"><tt id="link-7" class="py-name" targets="Variable lightmediascanner.LMS_PROGRESS_STATUS_PROCESSED=lightmediascanner-module.html#LMS_PROGRESS_STATUS_PROCESSED"><a title="lightmediascanner.LMS_PROGRESS_STATUS_PROCESSED" class="py-name" href="#" onclick="return doclink('link-7', 'LMS_PROGRESS_STATUS_PROCESSED', 'link-7');">LMS_PROGRESS_STATUS_PROCESSED</a></tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
87 <a name="L25"></a><tt class="py-lineno">25</tt>  <tt class="py-line"><tt id="link-8" class="py-name" targets="Variable lightmediascanner.LMS_PROGRESS_STATUS_DELETED=lightmediascanner-module.html#LMS_PROGRESS_STATUS_DELETED"><a title="lightmediascanner.LMS_PROGRESS_STATUS_DELETED" class="py-name" href="#" onclick="return doclink('link-8', 'LMS_PROGRESS_STATUS_DELETED', 'link-8');">LMS_PROGRESS_STATUS_DELETED</a></tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> </tt>
88 <a name="L26"></a><tt class="py-lineno">26</tt>  <tt class="py-line"><tt id="link-9" class="py-name" targets="Variable lightmediascanner.LMS_PROGRESS_STATUS_KILLED=lightmediascanner-module.html#LMS_PROGRESS_STATUS_KILLED"><a title="lightmediascanner.LMS_PROGRESS_STATUS_KILLED" class="py-name" href="#" onclick="return doclink('link-9', 'LMS_PROGRESS_STATUS_KILLED', 'link-9');">LMS_PROGRESS_STATUS_KILLED</a></tt> <tt class="py-op">=</tt> <tt class="py-number">3</tt> </tt>
89 <a name="L27"></a><tt class="py-lineno">27</tt>  <tt class="py-line"><tt id="link-10" class="py-name" targets="Variable lightmediascanner.LMS_PROGRESS_STATUS_ERROR_PARSE=lightmediascanner-module.html#LMS_PROGRESS_STATUS_ERROR_PARSE"><a title="lightmediascanner.LMS_PROGRESS_STATUS_ERROR_PARSE" class="py-name" href="#" onclick="return doclink('link-10', 'LMS_PROGRESS_STATUS_ERROR_PARSE', 'link-10');">LMS_PROGRESS_STATUS_ERROR_PARSE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">4</tt> </tt>
90 <a name="L28"></a><tt class="py-lineno">28</tt>  <tt class="py-line"><tt id="link-11" class="py-name" targets="Variable lightmediascanner.LMS_PROGRESS_STATUS_ERROR_COMM=lightmediascanner-module.html#LMS_PROGRESS_STATUS_ERROR_COMM"><a title="lightmediascanner.LMS_PROGRESS_STATUS_ERROR_COMM" class="py-name" href="#" onclick="return doclink('link-11', 'LMS_PROGRESS_STATUS_ERROR_COMM', 'link-11');">LMS_PROGRESS_STATUS_ERROR_COMM</a></tt> <tt class="py-op">=</tt> <tt class="py-number">5</tt> </tt>
91 <a name="L29"></a><tt class="py-lineno">29</tt>  <tt class="py-line"><tt id="link-12" class="py-name" targets="Variable lightmediascanner.LMS_PROGRESS_STATUS_SKIPPED=lightmediascanner-module.html#LMS_PROGRESS_STATUS_SKIPPED"><a title="lightmediascanner.LMS_PROGRESS_STATUS_SKIPPED" class="py-name" href="#" onclick="return doclink('link-12', 'LMS_PROGRESS_STATUS_SKIPPED', 'link-12');">LMS_PROGRESS_STATUS_SKIPPED</a></tt> <tt class="py-op">=</tt> <tt class="py-number">6</tt> </tt>
92 <a name="L30"></a><tt class="py-lineno">30</tt>  <tt class="py-line"> </tt><script type="text/javascript">
93 <!--
94 expandto(location.href);
95 // -->
96 </script>
97 </pre>
98 <br />
99 <!-- ==================== NAVIGATION BAR ==================== -->
100 <table class="navbar" border="0" width="100%" cellpadding="0"
101        bgcolor="#a0c0ff" cellspacing="0">
102   <tr valign="middle">
103   <!-- Home link -->
104       <th bgcolor="#70b0f0" class="navbar-select"
105           >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>
106
107   <!-- Tree link -->
108       <th>&nbsp;&nbsp;&nbsp;<a
109         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
110
111   <!-- Index link -->
112       <th>&nbsp;&nbsp;&nbsp;<a
113         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
114
115   <!-- Help link -->
116       <th>&nbsp;&nbsp;&nbsp;<a
117         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
118
119   <!-- Project homepage -->
120       <th class="navbar" align="right" width="100%">
121         <table border="0" cellpadding="0" cellspacing="0">
122           <tr><th class="navbar" align="center"
123             >Python-LightMediaScanner API</th>
124           </tr></table></th>
125   </tr>
126 </table>
127 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
128   <tr>
129     <td align="left" class="footer">
130     Generated by Epydoc 3.0.1 on Thu Apr 23 00:00:40 2009
131     </td>
132     <td align="right" class="footer">
133       <a target="mainFrame" href="http://epydoc.sourceforge.net"
134         >http://epydoc.sourceforge.net</a>
135     </td>
136   </tr>
137 </table>
138
139 <script type="text/javascript">
140   <!--
141   // Private objects are initially displayed (because if
142   // javascript is turned off then we want them to be
143   // visible); but by default, we want to hide them.  So hide
144   // them unless we have a cookie that says to show them.
145   checkCookie();
146   // -->
147 </script>
148 </body>
149 </html>