vcs.maemo.org Git - lms/blob - www/python-api/lightmediascanner.c_lightmediascanner-module.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.c_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>&nbsp;&nbsp;&nbsp;<a
  19         href="lightmediascanner-module.html">Home</a>&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         <a href="lightmediascanner-module.html">Package&nbsp;lightmediascanner</a> ::
  46         Module&nbsp;c_lightmediascanner
  47       </span>
  48     </td>
  49     <td>
  50       <table cellpadding="0" cellspacing="0">
  51         <!-- hide/show private -->
  52         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  53     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  54         <tr><td align="right"><span class="options"
  55             >[<a href="frames.html" target="_top">frames</a
  56             >]&nbsp;|&nbsp;<a href="lightmediascanner.c_lightmediascanner-module.html"
  57             target="_top">no&nbsp;frames</a>]</span></td></tr>
  58       </table>
  59     </td>
  60   </tr>
  61 </table>
  62 <!-- ==================== MODULE DESCRIPTION ==================== -->
  63 <h1 class="epydoc">Module c_lightmediascanner</h1><p class="nomargin-top"><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html">source&nbsp;code</a></span></p>
  64 <!-- ==================== CLASSES ==================== -->
  65 <a name="section-Classes"></a>
  66 <table class="summary" border="1" cellpadding="3"
  67        cellspacing="0" width="100%" bgcolor="white">
  68 <tr bgcolor="#70b0f0" class="table-header">
  69   <td colspan="2" class="table-header">
  70     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  71       <tr valign="top">
  72         <td align="left"><span class="table-header">Classes</span></td>
  73         <td align="right" valign="top"
  74          ><span class="options">[<a href="#section-Classes"
  75          class="privatelink" onclick="toggle_private();"
  76          >hide private</a>]</span></td>
  77       </tr>
  78     </table>
  79   </td>
  80 </tr>
  81 <tr>
  82     <td width="15%" align="right" valign="top" class="summary">
  83       <span class="summary-type">&nbsp;</span>
  84     </td><td class="summary">
  85         <a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html" class="summary-name">LightMediaScanner</a>
  86     </td>
  87   </tr>
  88 <tr>
  89     <td width="15%" align="right" valign="top" class="summary">
  90       <span class="summary-type">&nbsp;</span>
  91     </td><td class="summary">
  92         <a href="lightmediascanner.c_lightmediascanner.Parser-class.html" class="summary-name">Parser</a>
  93     </td>
  94   </tr>
  95 <tr>
  96     <td width="15%" align="right" valign="top" class="summary">
  97       <span class="summary-type">&nbsp;</span>
  98     </td><td class="summary">
  99         <a href="lightmediascanner.c_lightmediascanner.ParserInfo-class.html" class="summary-name">ParserInfo</a>
 100     </td>
 101   </tr>
 102 </table>
 103 <!-- ==================== FUNCTIONS ==================== -->
 104 <a name="section-Functions"></a>
 105 <table class="summary" border="1" cellpadding="3"
 106        cellspacing="0" width="100%" bgcolor="white">
 107 <tr bgcolor="#70b0f0" class="table-header">
 108   <td colspan="2" class="table-header">
 109     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 110       <tr valign="top">
 111         <td align="left"><span class="table-header">Functions</span></td>
 112         <td align="right" valign="top"
 113          ><span class="options">[<a href="#section-Functions"
 114          class="privatelink" onclick="toggle_private();"
 115          >hide private</a>]</span></td>
 116       </tr>
 117     </table>
 118   </td>
 119 </tr>
 120 <tr>
 121     <td width="15%" align="right" valign="top" class="summary">
 122       <span class="summary-type">&nbsp;</span>
 123     </td><td class="summary">
 124       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 125         <tr>
 126           <td><span class="summary-sig"><a name="__bootstrap__"></a><span class="summary-sig-name">__bootstrap__</span>()</span></td>
 127           <td align="right" valign="top">
 128             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#__bootstrap__">source&nbsp;code</a></span>
 129
 130           </td>
 131         </tr>
 132       </table>
 133
 134     </td>
 135   </tr>
 136 <tr>
 137     <td width="15%" align="right" valign="top" class="summary">
 138       <span class="summary-type">&nbsp;</span>
 139     </td><td class="summary">
 140       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 141         <tr>
 142           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner-module.html#parser_info" class="summary-sig-name">parser_info</a>(<span class="summary-sig-arg">...</span>)</span><br />
 143       Retrieve information of parser given its path.</td>
 144           <td align="right" valign="top">
 145             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#parser_info">source&nbsp;code</a></span>
 146
 147           </td>
 148         </tr>
 149       </table>
 150
 151     </td>
 152   </tr>
 153 <tr>
 154     <td width="15%" align="right" valign="top" class="summary">
 155       <span class="summary-type">&nbsp;</span>
 156     </td><td class="summary">
 157       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 158         <tr>
 159           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner-module.html#parser_info_find" class="summary-sig-name">parser_info_find</a>(<span class="summary-sig-arg">...</span>)</span><br />
 160       Retrieve information of parser given its name.</td>
 161           <td align="right" valign="top">
 162             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#parser_info_find">source&nbsp;code</a></span>
 163
 164           </td>
 165         </tr>
 166       </table>
 167
 168     </td>
 169   </tr>
 170 <tr>
 171     <td width="15%" align="right" valign="top" class="summary">
 172       <span class="summary-type">&nbsp;</span>
 173     </td><td class="summary">
 174       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 175         <tr>
 176           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner-module.html#parsers_list" class="summary-sig-name">parsers_list</a>(<span class="summary-sig-arg">...</span>)</span><br />
 177       Returns a list of paths to known parsers in this system.</td>
 178           <td align="right" valign="top">
 179             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#parsers_list">source&nbsp;code</a></span>
 180
 181           </td>
 182         </tr>
 183       </table>
 184
 185     </td>
 186   </tr>
 187 <tr>
 188     <td width="15%" align="right" valign="top" class="summary">
 189       <span class="summary-type">&nbsp;</span>
 190     </td><td class="summary">
 191       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 192         <tr>
 193           <td><span class="summary-sig"><a name="parsers_list_by_category"></a><span class="summary-sig-name">parsers_list_by_category</span>(<span class="summary-sig-arg">...</span>)</span></td>
 194           <td align="right" valign="top">
 195             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#parsers_list_by_category">source&nbsp;code</a></span>
 196
 197           </td>
 198         </tr>
 199       </table>
 200
 201     </td>
 202   </tr>
 203 </table>
 204 <!-- ==================== VARIABLES ==================== -->
 205 <a name="section-Variables"></a>
 206 <table class="summary" border="1" cellpadding="3"
 207        cellspacing="0" width="100%" bgcolor="white">
 208 <tr bgcolor="#70b0f0" class="table-header">
 209   <td colspan="2" class="table-header">
 210     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 211       <tr valign="top">
 212         <td align="left"><span class="table-header">Variables</span></td>
 213         <td align="right" valign="top"
 214          ><span class="options">[<a href="#section-Variables"
 215          class="privatelink" onclick="toggle_private();"
 216          >hide private</a>]</span></td>
 217       </tr>
 218     </table>
 219   </td>
 220 </tr>
 221 <tr>
 222     <td width="15%" align="right" valign="top" class="summary">
 223       <span class="summary-type">&nbsp;</span>
 224     </td><td class="summary">
 225         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
 226     </td>
 227   </tr>
 228 </table>
 229 <!-- ==================== FUNCTION DETAILS ==================== -->
 230 <a name="section-FunctionDetails"></a>
 231 <table class="details" border="1" cellpadding="3"
 232        cellspacing="0" width="100%" bgcolor="white">
 233 <tr bgcolor="#70b0f0" class="table-header">
 234   <td colspan="2" class="table-header">
 235     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 236       <tr valign="top">
 237         <td align="left"><span class="table-header">Function Details</span></td>
 238         <td align="right" valign="top"
 239          ><span class="options">[<a href="#section-FunctionDetails"
 240          class="privatelink" onclick="toggle_private();"
 241          >hide private</a>]</span></td>
 242       </tr>
 243     </table>
 244   </td>
 245 </tr>
 246 </table>
 247 <a name="parser_info"></a>
 248 <div>
 249 <table class="details" border="1" cellpadding="3"
 250        cellspacing="0" width="100%" bgcolor="white">
 251 <tr><td>
 252   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 253   <tr valign="top"><td>
 254   <h3 class="epydoc"><span class="sig"><span class="sig-name">parser_info</span>(<span class="sig-arg">...</span>)</span>
 255   </h3>
 256   </td><td align="right" valign="top"
 257     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#parser_info">source&nbsp;code</a></span>&nbsp;
 258     </td>
 259   </tr></table>
 260
 261   <p>Retrieve information of parser given its path.</p>
 262   <dl class="fields">
 263     <dt>Returns:</dt>
 264         <dd>None if failed or ParserInfo otherwise.</dd>
 265   </dl>
 266 </td></tr></table>
 267 </div>
 268 <a name="parser_info_find"></a>
 269 <div>
 270 <table class="details" border="1" cellpadding="3"
 271        cellspacing="0" width="100%" bgcolor="white">
 272 <tr><td>
 273   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 274   <tr valign="top"><td>
 275   <h3 class="epydoc"><span class="sig"><span class="sig-name">parser_info_find</span>(<span class="sig-arg">...</span>)</span>
 276   </h3>
 277   </td><td align="right" valign="top"
 278     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#parser_info_find">source&nbsp;code</a></span>&nbsp;
 279     </td>
 280   </tr></table>
 281
 282   <p>Retrieve information of parser given its name.</p>
 283   <dl class="fields">
 284     <dt>Returns:</dt>
 285         <dd>None if failed or ParserInfo otherwise.</dd>
 286   </dl>
 287 </td></tr></table>
 288 </div>
 289 <a name="parsers_list"></a>
 290 <div>
 291 <table class="details" border="1" cellpadding="3"
 292        cellspacing="0" width="100%" bgcolor="white">
 293 <tr><td>
 294   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 295   <tr valign="top"><td>
 296   <h3 class="epydoc"><span class="sig"><span class="sig-name">parsers_list</span>(<span class="sig-arg">...</span>)</span>
 297   </h3>
 298   </td><td align="right" valign="top"
 299     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#parsers_list">source&nbsp;code</a></span>&nbsp;
 300     </td>
 301   </tr></table>
 302
 303   <p>Returns a list of paths to known parsers in this system.</p>
 304   <p>@return list of str @see parser_info()</p>
 305   <dl class="fields">
 306   </dl>
 307 </td></tr></table>
 308 </div>
 309 <br />
 310 <!-- ==================== NAVIGATION BAR ==================== -->
 311 <table class="navbar" border="0" width="100%" cellpadding="0"
 312        bgcolor="#a0c0ff" cellspacing="0">
 313   <tr valign="middle">
 314   <!-- Home link -->
 315       <th>&nbsp;&nbsp;&nbsp;<a
 316         href="lightmediascanner-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 317
 318   <!-- Tree link -->
 319       <th>&nbsp;&nbsp;&nbsp;<a
 320         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 321
 322   <!-- Index link -->
 323       <th>&nbsp;&nbsp;&nbsp;<a
 324         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 325
 326   <!-- Help link -->
 327       <th>&nbsp;&nbsp;&nbsp;<a
 328         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 329
 330   <!-- Project homepage -->
 331       <th class="navbar" align="right" width="100%">
 332         <table border="0" cellpadding="0" cellspacing="0">
 333           <tr><th class="navbar" align="center"
 334             >Python-LightMediaScanner API</th>
 335           </tr></table></th>
 336   </tr>
 337 </table>
 338 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 339   <tr>
 340     <td align="left" class="footer">
 341     Generated by Epydoc 3.0.1 on Thu Apr 23 00:00:40 2009
 342     </td>
 343     <td align="right" class="footer">
 344       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 345         >http://epydoc.sourceforge.net</a>
 346     </td>
 347   </tr>
 348 </table>
 349
 350 <script type="text/javascript">
 351   <!--
 352   // Private objects are initially displayed (because if
 353   // javascript is turned off then we want them to be
 354   // visible); but by default, we want to hide them.  So hide
 355   // them unless we have a cookie that says to show them.
 356   checkCookie();
 357   // -->
 358 </script>
 359 </body>
 360 </html>