git.maemo.org Git - lms/blob - www/python-api/lightmediascanner.c_lightmediascanner.LightMediaScanner-class.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.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.c_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         Package&nbsp;lightmediascanner ::
  46         <a href="lightmediascanner.c_lightmediascanner-module.html">Module&nbsp;c_lightmediascanner</a> ::
  47         Class&nbsp;LightMediaScanner
  48       </span>
  49     </td>
  50     <td>
  51       <table cellpadding="0" cellspacing="0">
  52         <!-- hide/show private -->
  53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  55         <tr><td align="right"><span class="options"
  56             >[<a href="frames.html" target="_top">frames</a
  57             >]&nbsp;|&nbsp;<a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== CLASS DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Class LightMediaScanner</h1><p class="nomargin-top"><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner">source&nbsp;code</a></span></p>
  65 <pre class="base-tree">
  66 object --+
  67          |
  68         <strong class="uidshort">LightMediaScanner</strong>
  69 </pre>
  70
  71 <hr />
  72 <!-- ==================== INSTANCE METHODS ==================== -->
  73 <a name="section-InstanceMethods"></a>
  74 <table class="summary" border="1" cellpadding="3"
  75        cellspacing="0" width="100%" bgcolor="white">
  76 <tr bgcolor="#70b0f0" class="table-header">
  77   <td colspan="2" class="table-header">
  78     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  79       <tr valign="top">
  80         <td align="left"><span class="table-header">Instance Methods</span></td>
  81         <td align="right" valign="top"
  82          ><span class="options">[<a href="#section-InstanceMethods"
  83          class="privatelink" onclick="toggle_private();"
  84          >hide private</a>]</span></td>
  85       </tr>
  86     </table>
  87   </td>
  88 </tr>
  89 <tr>
  90     <td width="15%" align="right" valign="top" class="summary">
  91       <span class="summary-type">&nbsp;</span>
  92     </td><td class="summary">
  93       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  94         <tr>
  95           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">...</span>)</span><br />
  96       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
  97           <td align="right" valign="top">
  98             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__init__">source&nbsp;code</a></span>
  99
 100           </td>
 101         </tr>
 102       </table>
 103
 104     </td>
 105   </tr>
 106 <tr>
 107     <td width="15%" align="right" valign="top" class="summary">
 108       <span class="summary-type">a new object with type S, a subtype of T</span>
 109     </td><td class="summary">
 110       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 111         <tr>
 112           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#__new__" class="summary-sig-name">__new__</a>(<span class="summary-sig-arg">T</span>,
 113         <span class="summary-sig-arg">S</span>,
 114         <span class="summary-sig-arg">...</span>)</span></td>
 115           <td align="right" valign="top">
 116             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__new__">source&nbsp;code</a></span>
 117
 118           </td>
 119         </tr>
 120       </table>
 121
 122     </td>
 123   </tr>
 124 <tr>
 125     <td width="15%" align="right" valign="top" class="summary">
 126       <span class="summary-type">&nbsp;</span>
 127     </td><td class="summary">
 128       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 129         <tr>
 130           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">...</span>)</span><br />
 131       repr(x)</td>
 132           <td align="right" valign="top">
 133             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__repr__">source&nbsp;code</a></span>
 134
 135           </td>
 136         </tr>
 137       </table>
 138
 139     </td>
 140   </tr>
 141 <tr>
 142     <td width="15%" align="right" valign="top" class="summary">
 143       <span class="summary-type">&nbsp;</span>
 144     </td><td class="summary">
 145       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 146         <tr>
 147           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">...</span>)</span><br />
 148       str(x)</td>
 149           <td align="right" valign="top">
 150             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__str__">source&nbsp;code</a></span>
 151
 152           </td>
 153         </tr>
 154       </table>
 155
 156     </td>
 157   </tr>
 158 <tr>
 159     <td width="15%" align="right" valign="top" class="summary">
 160       <span class="summary-type">&nbsp;</span>
 161     </td><td class="summary">
 162       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 163         <tr>
 164           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#charset_add" class="summary-sig-name">charset_add</a>(<span class="summary-sig-arg">...</span>)</span><br />
 165       Add charset to list of supported input charsets/encoding.</td>
 166           <td align="right" valign="top">
 167             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.charset_add">source&nbsp;code</a></span>
 168
 169           </td>
 170         </tr>
 171       </table>
 172
 173     </td>
 174   </tr>
 175 <tr>
 176     <td width="15%" align="right" valign="top" class="summary">
 177       <span class="summary-type">&nbsp;</span>
 178     </td><td class="summary">
 179       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 180         <tr>
 181           <td><span class="summary-sig"><a name="charset_del"></a><span class="summary-sig-name">charset_del</span>(<span class="summary-sig-arg">...</span>)</span><br />
 182       Del charset from list of supported input charsets/encoding.</td>
 183           <td align="right" valign="top">
 184             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.charset_del">source&nbsp;code</a></span>
 185
 186           </td>
 187         </tr>
 188       </table>
 189
 190     </td>
 191   </tr>
 192 <tr>
 193     <td width="15%" align="right" valign="top" class="summary">
 194       <span class="summary-type">&nbsp;</span>
 195     </td><td class="summary">
 196       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 197         <tr>
 198           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#check" class="summary-sig-name">check</a>(<span class="summary-sig-arg">...</span>)</span><br />
 199       Check (and update) files under directory.</td>
 200           <td align="right" valign="top">
 201             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.check">source&nbsp;code</a></span>
 202
 203           </td>
 204         </tr>
 205       </table>
 206
 207     </td>
 208   </tr>
 209 <tr>
 210     <td width="15%" align="right" valign="top" class="summary">
 211       <span class="summary-type">&nbsp;</span>
 212     </td><td class="summary">
 213       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 214         <tr>
 215           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#check_single_process" class="summary-sig-name">check_single_process</a>(<span class="summary-sig-arg">...</span>)</span><br />
 216       Check (and update) files under directory *without fork()-ing into
 217       child process*.</td>
 218           <td align="right" valign="top">
 219             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.check_single_process">source&nbsp;code</a></span>
 220
 221           </td>
 222         </tr>
 223       </table>
 224
 225     </td>
 226   </tr>
 227 <tr>
 228     <td width="15%" align="right" valign="top" class="summary">
 229       <span class="summary-type">&nbsp;</span>
 230     </td><td class="summary">
 231       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 232         <tr>
 233           <td><span class="summary-sig"><a name="delete"></a><span class="summary-sig-name">delete</span>(<span class="summary-sig-arg">...</span>)</span><br />
 234       Delete all parsers and force wrapped object deletion</td>
 235           <td align="right" valign="top">
 236             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.delete">source&nbsp;code</a></span>
 237
 238           </td>
 239         </tr>
 240       </table>
 241
 242     </td>
 243   </tr>
 244 <tr>
 245     <td width="15%" align="right" valign="top" class="summary">
 246       <span class="summary-type">int</span>
 247     </td><td class="summary">
 248       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 249         <tr>
 250           <td><span class="summary-sig"><a name="get_commit_interval"></a><span class="summary-sig-name">get_commit_interval</span>(<span class="summary-sig-arg">...</span>)</span></td>
 251           <td align="right" valign="top">
 252             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.get_commit_interval">source&nbsp;code</a></span>
 253
 254           </td>
 255         </tr>
 256       </table>
 257
 258     </td>
 259   </tr>
 260 <tr>
 261     <td width="15%" align="right" valign="top" class="summary">
 262       <span class="summary-type">int</span>
 263     </td><td class="summary">
 264       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 265         <tr>
 266           <td><span class="summary-sig"><a name="get_slave_timeout"></a><span class="summary-sig-name">get_slave_timeout</span>(<span class="summary-sig-arg">...</span>)</span></td>
 267           <td align="right" valign="top">
 268             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.get_slave_timeout">source&nbsp;code</a></span>
 269
 270           </td>
 271         </tr>
 272       </table>
 273
 274     </td>
 275   </tr>
 276 <tr>
 277     <td width="15%" align="right" valign="top" class="summary">
 278       <span class="summary-type">bool</span>
 279     </td><td class="summary">
 280       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 281         <tr>
 282           <td><span class="summary-sig"><a name="is_processing"></a><span class="summary-sig-name">is_processing</span>(<span class="summary-sig-arg">...</span>)</span></td>
 283           <td align="right" valign="top">
 284             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.is_processing">source&nbsp;code</a></span>
 285
 286           </td>
 287         </tr>
 288       </table>
 289
 290     </td>
 291   </tr>
 292 <tr>
 293     <td width="15%" align="right" valign="top" class="summary">
 294       <span class="summary-type"><a href="lightmediascanner.c_lightmediascanner.Parser-class.html"
 295       class="link">Parser</a></span>
 296     </td><td class="summary">
 297       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 298         <tr>
 299           <td><span class="summary-sig"><a name="parser_add"></a><span class="summary-sig-name">parser_add</span>(<span class="summary-sig-arg">...</span>)</span><br />
 300       Add a new plugin/parser based on it's whole path to shared object.</td>
 301           <td align="right" valign="top">
 302             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.parser_add">source&nbsp;code</a></span>
 303
 304           </td>
 305         </tr>
 306       </table>
 307
 308     </td>
 309   </tr>
 310 <tr>
 311     <td width="15%" align="right" valign="top" class="summary">
 312       <span class="summary-type">&nbsp;</span>
 313     </td><td class="summary">
 314       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 315         <tr>
 316           <td><span class="summary-sig"><a name="parser_del"></a><span class="summary-sig-name">parser_del</span>(<span class="summary-sig-arg">...</span>)</span><br />
 317       Delete a plugin/parser.</td>
 318           <td align="right" valign="top">
 319             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.parser_del">source&nbsp;code</a></span>
 320
 321           </td>
 322         </tr>
 323       </table>
 324
 325     </td>
 326   </tr>
 327 <tr>
 328     <td width="15%" align="right" valign="top" class="summary">
 329       <span class="summary-type"><a href="lightmediascanner.c_lightmediascanner.Parser-class.html"
 330       class="link">Parser</a></span>
 331     </td><td class="summary">
 332       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 333         <tr>
 334           <td><span class="summary-sig"><a name="parser_find_and_add"></a><span class="summary-sig-name">parser_find_and_add</span>(<span class="summary-sig-arg">...</span>)</span><br />
 335       Add a new plugin/parser based on it's name.</td>
 336           <td align="right" valign="top">
 337             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.parser_find_and_add">source&nbsp;code</a></span>
 338
 339           </td>
 340         </tr>
 341       </table>
 342
 343     </td>
 344   </tr>
 345 <tr>
 346     <td width="15%" align="right" valign="top" class="summary">
 347       <span class="summary-type">&nbsp;</span>
 348     </td><td class="summary">
 349       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 350         <tr>
 351           <td><span class="summary-sig"><a name="parsers_clear"></a><span class="summary-sig-name">parsers_clear</span>(<span class="summary-sig-arg">...</span>)</span><br />
 352       Delete all plugins/parsers</td>
 353           <td align="right" valign="top">
 354             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.parsers_clear">source&nbsp;code</a></span>
 355
 356           </td>
 357         </tr>
 358       </table>
 359
 360     </td>
 361   </tr>
 362 <tr>
 363     <td width="15%" align="right" valign="top" class="summary">
 364       <span class="summary-type">&nbsp;</span>
 365     </td><td class="summary">
 366       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 367         <tr>
 368           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#process" class="summary-sig-name">process</a>(<span class="summary-sig-arg">...</span>)</span><br />
 369       Process directory recursively.</td>
 370           <td align="right" valign="top">
 371             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.process">source&nbsp;code</a></span>
 372
 373           </td>
 374         </tr>
 375       </table>
 376
 377     </td>
 378   </tr>
 379 <tr>
 380     <td width="15%" align="right" valign="top" class="summary">
 381       <span class="summary-type">&nbsp;</span>
 382     </td><td class="summary">
 383       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 384         <tr>
 385           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#process_single_process" class="summary-sig-name">process_single_process</a>(<span class="summary-sig-arg">...</span>)</span><br />
 386       Process directory recursively *without fork()-ing into child
 387       process*.</td>
 388           <td align="right" valign="top">
 389             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.process_single_process">source&nbsp;code</a></span>
 390
 391           </td>
 392         </tr>
 393       </table>
 394
 395     </td>
 396   </tr>
 397 <tr>
 398     <td width="15%" align="right" valign="top" class="summary">
 399       <span class="summary-type">&nbsp;</span>
 400     </td><td class="summary">
 401       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 402         <tr>
 403           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#set_commit_interval" class="summary-sig-name">set_commit_interval</a>(<span class="summary-sig-arg">...</span>)</span><br />
 404       Set the number of transactions between commits.</td>
 405           <td align="right" valign="top">
 406             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.set_commit_interval">source&nbsp;code</a></span>
 407
 408           </td>
 409         </tr>
 410       </table>
 411
 412     </td>
 413   </tr>
 414 <tr>
 415     <td width="15%" align="right" valign="top" class="summary">
 416       <span class="summary-type">&nbsp;</span>
 417     </td><td class="summary">
 418       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 419         <tr>
 420           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#set_progress_callback" class="summary-sig-name">set_progress_callback</a>(<span class="summary-sig-arg">...</span>)</span><br />
 421       Set new progress callback.</td>
 422           <td align="right" valign="top">
 423             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.set_progress_callback">source&nbsp;code</a></span>
 424
 425           </td>
 426         </tr>
 427       </table>
 428
 429     </td>
 430   </tr>
 431 <tr>
 432     <td width="15%" align="right" valign="top" class="summary">
 433       <span class="summary-type">&nbsp;</span>
 434     </td><td class="summary">
 435       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 436         <tr>
 437           <td><span class="summary-sig"><a href="lightmediascanner.c_lightmediascanner.LightMediaScanner-class.html#set_slave_timeout" class="summary-sig-name">set_slave_timeout</a>(<span class="summary-sig-arg">...</span>)</span><br />
 438       Set maximum time a parser may use.</td>
 439           <td align="right" valign="top">
 440             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.set_slave_timeout">source&nbsp;code</a></span>
 441
 442           </td>
 443         </tr>
 444       </table>
 445
 446     </td>
 447   </tr>
 448 <tr>
 449     <td width="15%" align="right" valign="top" class="summary">
 450       <span class="summary-type">&nbsp;</span>
 451     </td><td class="summary">
 452       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 453         <tr>
 454           <td><span class="summary-sig"><a name="stop_processing"></a><span class="summary-sig-name">stop_processing</span>(<span class="summary-sig-arg">...</span>)</span><br />
 455       Stop process/check</td>
 456           <td align="right" valign="top">
 457             <span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.stop_processing">source&nbsp;code</a></span>
 458
 459           </td>
 460         </tr>
 461       </table>
 462
 463     </td>
 464   </tr>
 465   <tr>
 466     <td colspan="2" class="summary">
 467     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 468       <code>__delattr__</code>,
 469       <code>__getattribute__</code>,
 470       <code>__hash__</code>,
 471       <code>__reduce__</code>,
 472       <code>__reduce_ex__</code>,
 473       <code>__setattr__</code>
 474       </p>
 475     </td>
 476   </tr>
 477 </table>
 478 <!-- ==================== PROPERTIES ==================== -->
 479 <a name="section-Properties"></a>
 480 <table class="summary" border="1" cellpadding="3"
 481        cellspacing="0" width="100%" bgcolor="white">
 482 <tr bgcolor="#70b0f0" class="table-header">
 483   <td colspan="2" class="table-header">
 484     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 485       <tr valign="top">
 486         <td align="left"><span class="table-header">Properties</span></td>
 487         <td align="right" valign="top"
 488          ><span class="options">[<a href="#section-Properties"
 489          class="privatelink" onclick="toggle_private();"
 490          >hide private</a>]</span></td>
 491       </tr>
 492     </table>
 493   </td>
 494 </tr>
 495 <tr>
 496     <td width="15%" align="right" valign="top" class="summary">
 497       <span class="summary-type">&nbsp;</span>
 498     </td><td class="summary">
 499         <a name="commit_interval"></a><span class="summary-name">commit_interval</span>
 500     </td>
 501   </tr>
 502 <tr>
 503     <td width="15%" align="right" valign="top" class="summary">
 504       <span class="summary-type">&nbsp;</span>
 505     </td><td class="summary">
 506         <a name="db_path"></a><span class="summary-name">db_path</span>
 507     </td>
 508   </tr>
 509 <tr>
 510     <td width="15%" align="right" valign="top" class="summary">
 511       <span class="summary-type">&nbsp;</span>
 512     </td><td class="summary">
 513         <a name="parsers"></a><span class="summary-name">parsers</span>
 514     </td>
 515   </tr>
 516 <tr>
 517     <td width="15%" align="right" valign="top" class="summary">
 518       <span class="summary-type">&nbsp;</span>
 519     </td><td class="summary">
 520         <a name="slave_timeout"></a><span class="summary-name">slave_timeout</span>
 521     </td>
 522   </tr>
 523   <tr>
 524     <td colspan="2" class="summary">
 525     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 526       <code>__class__</code>
 527       </p>
 528     </td>
 529   </tr>
 530 </table>
 531 <!-- ==================== METHOD DETAILS ==================== -->
 532 <a name="section-MethodDetails"></a>
 533 <table class="details" border="1" cellpadding="3"
 534        cellspacing="0" width="100%" bgcolor="white">
 535 <tr bgcolor="#70b0f0" class="table-header">
 536   <td colspan="2" class="table-header">
 537     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 538       <tr valign="top">
 539         <td align="left"><span class="table-header">Method Details</span></td>
 540         <td align="right" valign="top"
 541          ><span class="options">[<a href="#section-MethodDetails"
 542          class="privatelink" onclick="toggle_private();"
 543          >hide private</a>]</span></td>
 544       </tr>
 545     </table>
 546   </td>
 547 </tr>
 548 </table>
 549 <a name="__init__"></a>
 550 <div>
 551 <table class="details" border="1" cellpadding="3"
 552        cellspacing="0" width="100%" bgcolor="white">
 553 <tr><td>
 554   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 555   <tr valign="top"><td>
 556   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">...</span>)</span>
 557     <br /><em class="fname">(Constructor)</em>
 558   </h3>
 559   </td><td align="right" valign="top"
 560     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__init__">source&nbsp;code</a></span>&nbsp;
 561     </td>
 562   </tr></table>
 563
 564   <p>x.__init__(...) initializes x; see x.__class__.__doc__ for
 565   signature</p>
 566   <dl class="fields">
 567     <dt>Overrides:
 568         object.__init__
 569     </dt>
 570   </dl>
 571 </td></tr></table>
 572 </div>
 573 <a name="__new__"></a>
 574 <div>
 575 <table class="details" border="1" cellpadding="3"
 576        cellspacing="0" width="100%" bgcolor="white">
 577 <tr><td>
 578   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 579   <tr valign="top"><td>
 580   <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span class="sig-arg">T</span>,
 581         <span class="sig-arg">S</span>,
 582         <span class="sig-arg">...</span>)</span>
 583   </h3>
 584   </td><td align="right" valign="top"
 585     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__new__">source&nbsp;code</a></span>&nbsp;
 586     </td>
 587   </tr></table>
 588
 589
 590   <dl class="fields">
 591     <dt>Returns: a new object with type S, a subtype of T</dt>
 592     <dt>Overrides:
 593         object.__new__
 594     </dt>
 595   </dl>
 596 </td></tr></table>
 597 </div>
 598 <a name="__repr__"></a>
 599 <div>
 600 <table class="details" border="1" cellpadding="3"
 601        cellspacing="0" width="100%" bgcolor="white">
 602 <tr><td>
 603   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 604   <tr valign="top"><td>
 605   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">...</span>)</span>
 606     <br /><em class="fname">(Representation operator)</em>
 607   </h3>
 608   </td><td align="right" valign="top"
 609     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__repr__">source&nbsp;code</a></span>&nbsp;
 610     </td>
 611   </tr></table>
 612
 613   <p>repr(x)</p>
 614   <dl class="fields">
 615     <dt>Overrides:
 616         object.__repr__
 617         <dd><em class="note">(inherited documentation)</em></dd>
 618     </dt>
 619   </dl>
 620 </td></tr></table>
 621 </div>
 622 <a name="__str__"></a>
 623 <div>
 624 <table class="details" border="1" cellpadding="3"
 625        cellspacing="0" width="100%" bgcolor="white">
 626 <tr><td>
 627   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 628   <tr valign="top"><td>
 629   <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">...</span>)</span>
 630     <br /><em class="fname">(Informal representation operator)</em>
 631   </h3>
 632   </td><td align="right" valign="top"
 633     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.__str__">source&nbsp;code</a></span>&nbsp;
 634     </td>
 635   </tr></table>
 636
 637   <p>str(x)</p>
 638   <dl class="fields">
 639     <dt>Overrides:
 640         object.__str__
 641         <dd><em class="note">(inherited documentation)</em></dd>
 642     </dt>
 643   </dl>
 644 </td></tr></table>
 645 </div>
 646 <a name="charset_add"></a>
 647 <div>
 648 <table class="details" border="1" cellpadding="3"
 649        cellspacing="0" width="100%" bgcolor="white">
 650 <tr><td>
 651   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 652   <tr valign="top"><td>
 653   <h3 class="epydoc"><span class="sig"><span class="sig-name">charset_add</span>(<span class="sig-arg">...</span>)</span>
 654   </h3>
 655   </td><td align="right" valign="top"
 656     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.charset_add">source&nbsp;code</a></span>&nbsp;
 657     </td>
 658   </tr></table>
 659
 660   <p>Add charset to list of supported input charsets/encoding.</p>
 661   <p>If some string in analysed/parsed files are not UTF-8, then it will
 662   try agains a list of charsets registered with this function.</p>
 663   <dl class="fields">
 664   </dl>
 665 </td></tr></table>
 666 </div>
 667 <a name="check"></a>
 668 <div>
 669 <table class="details" border="1" cellpadding="3"
 670        cellspacing="0" width="100%" bgcolor="white">
 671 <tr><td>
 672   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 673   <tr valign="top"><td>
 674   <h3 class="epydoc"><span class="sig"><span class="sig-name">check</span>(<span class="sig-arg">...</span>)</span>
 675   </h3>
 676   </td><td align="right" valign="top"
 677     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.check">source&nbsp;code</a></span>&nbsp;
 678     </td>
 679   </tr></table>
 680
 681   <p>Check (and update) files under directory.</p>
 682   <p>This operates on all files in all sub directories of top_path using
 683   the added parsers. If files are up to date, nothing is done, otherwise
 684   they can be marked as deleted or updated if they still exists, but with
 685   different size or modification time.</p>
 686   <dl class="fields">
 687   </dl>
 688 </td></tr></table>
 689 </div>
 690 <a name="check_single_process"></a>
 691 <div>
 692 <table class="details" border="1" cellpadding="3"
 693        cellspacing="0" width="100%" bgcolor="white">
 694 <tr><td>
 695   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 696   <tr valign="top"><td>
 697   <h3 class="epydoc"><span class="sig"><span class="sig-name">check_single_process</span>(<span class="sig-arg">...</span>)</span>
 698   </h3>
 699   </td><td align="right" valign="top"
 700     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.check_single_process">source&nbsp;code</a></span>&nbsp;
 701     </td>
 702   </tr></table>
 703
 704   <p>Check (and update) files under directory *without fork()-ing into
 705   child process*.</p>
 706   <p>This operates on all files in all sub directories of top_path using
 707   the added parsers. If files are up to date, nothing is done, otherwise
 708   they can be marked as deleted or updated if they still exists, but with
 709   different size or modification time.</p>
 710   <dl class="fields">
 711   </dl>
 712 </td></tr></table>
 713 </div>
 714 <a name="process"></a>
 715 <div>
 716 <table class="details" border="1" cellpadding="3"
 717        cellspacing="0" width="100%" bgcolor="white">
 718 <tr><td>
 719   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 720   <tr valign="top"><td>
 721   <h3 class="epydoc"><span class="sig"><span class="sig-name">process</span>(<span class="sig-arg">...</span>)</span>
 722   </h3>
 723   </td><td align="right" valign="top"
 724     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.process">source&nbsp;code</a></span>&nbsp;
 725     </td>
 726   </tr></table>
 727
 728   <p>Process directory recursively.</p>
 729   <p>This operates on all files in all sub directories of top_path using
 730   the added parsers.</p>
 731   <dl class="fields">
 732   </dl>
 733 </td></tr></table>
 734 </div>
 735 <a name="process_single_process"></a>
 736 <div>
 737 <table class="details" border="1" cellpadding="3"
 738        cellspacing="0" width="100%" bgcolor="white">
 739 <tr><td>
 740   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 741   <tr valign="top"><td>
 742   <h3 class="epydoc"><span class="sig"><span class="sig-name">process_single_process</span>(<span class="sig-arg">...</span>)</span>
 743   </h3>
 744   </td><td align="right" valign="top"
 745     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.process_single_process">source&nbsp;code</a></span>&nbsp;
 746     </td>
 747   </tr></table>
 748
 749   <p>Process directory recursively *without fork()-ing into child
 750   process*.</p>
 751   <p>This operates on all files in all sub directories of top_path using
 752   the added parsers.</p>
 753   <dl class="fields">
 754   </dl>
 755 </td></tr></table>
 756 </div>
 757 <a name="set_commit_interval"></a>
 758 <div>
 759 <table class="details" border="1" cellpadding="3"
 760        cellspacing="0" width="100%" bgcolor="white">
 761 <tr><td>
 762   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 763   <tr valign="top"><td>
 764   <h3 class="epydoc"><span class="sig"><span class="sig-name">set_commit_interval</span>(<span class="sig-arg">...</span>)</span>
 765   </h3>
 766   </td><td align="right" valign="top"
 767     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.set_commit_interval">source&nbsp;code</a></span>&nbsp;
 768     </td>
 769   </tr></table>
 770
 771   <p>Set the number of transactions between commits.</p>
 772   <p>Sets how many transactions/files to handle in one commit, the more the
 773   faster, but if one parser takes too long and it's killed due
 774   slave_timeout being exceeded, then at most this number of transactions
 775   will be lost.</p>
 776   <p>Note that transaction here is not a single SQL statement, but it is
 777   considered to be the processing of a file, which can be more than just
 778   one.</p>
 779   <dl class="fields">
 780   </dl>
 781 </td></tr></table>
 782 </div>
 783 <a name="set_progress_callback"></a>
 784 <div>
 785 <table class="details" border="1" cellpadding="3"
 786        cellspacing="0" width="100%" bgcolor="white">
 787 <tr><td>
 788   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 789   <tr valign="top"><td>
 790   <h3 class="epydoc"><span class="sig"><span class="sig-name">set_progress_callback</span>(<span class="sig-arg">...</span>)</span>
 791   </h3>
 792   </td><td align="right" valign="top"
 793     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.set_progress_callback">source&nbsp;code</a></span>&nbsp;
 794     </td>
 795   </tr></table>
 796
 797   <pre class="literalblock">
 798 Set new progress callback.
 799
 800 If you want to unset a callback, just use None.
 801
 802 Function signature is:
 803
 804     C{function(lms, path, status, *args, **kargs)}
 805
 806 with status being one of LMS_PROGRESS_STATUS_*.
 807
 808 @parm: B{cb} a callable object or None to unset previously set callback.
 809
 810 </pre>
 811   <dl class="fields">
 812   </dl>
 813 </td></tr></table>
 814 </div>
 815 <a name="set_slave_timeout"></a>
 816 <div>
 817 <table class="details" border="1" cellpadding="3"
 818        cellspacing="0" width="100%" bgcolor="white">
 819 <tr><td>
 820   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 821   <tr valign="top"><td>
 822   <h3 class="epydoc"><span class="sig"><span class="sig-name">set_slave_timeout</span>(<span class="sig-arg">...</span>)</span>
 823   </h3>
 824   </td><td align="right" valign="top"
 825     ><span class="codelink"><a href="lightmediascanner.c_lightmediascanner-pysrc.html#LightMediaScanner.set_slave_timeout">source&nbsp;code</a></span>&nbsp;
 826     </td>
 827   </tr></table>
 828
 829   <p>Set maximum time a parser may use.</p>
 830   <p>This will be the timeout before killing the slave process running some
 831   parser. If this happens, another slave process will be started to
 832   continue from next file.</p>
 833   <dl class="fields">
 834   </dl>
 835 </td></tr></table>
 836 </div>
 837 <br />
 838 <!-- ==================== NAVIGATION BAR ==================== -->
 839 <table class="navbar" border="0" width="100%" cellpadding="0"
 840        bgcolor="#a0c0ff" cellspacing="0">
 841   <tr valign="middle">
 842   <!-- Home link -->
 843       <th>&nbsp;&nbsp;&nbsp;<a
 844         href="lightmediascanner.c_lightmediascanner-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 845
 846   <!-- Tree link -->
 847       <th>&nbsp;&nbsp;&nbsp;<a
 848         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 849
 850   <!-- Index link -->
 851       <th>&nbsp;&nbsp;&nbsp;<a
 852         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 853
 854   <!-- Help link -->
 855       <th>&nbsp;&nbsp;&nbsp;<a
 856         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 857
 858   <!-- Project homepage -->
 859       <th class="navbar" align="right" width="100%">
 860         <table border="0" cellpadding="0" cellspacing="0">
 861           <tr><th class="navbar" align="center"
 862             >Python-LightMediaScanner API</th>
 863           </tr></table></th>
 864   </tr>
 865 </table>
 866 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 867   <tr>
 868     <td align="left" class="footer">
 869     Generated by Epydoc 3.0.1 on Sun Oct  5 12:29:12 2008
 870     </td>
 871     <td align="right" class="footer">
 872       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 873         >http://epydoc.sourceforge.net</a>
 874     </td>
 875   </tr>
 876 </table>
 877
 878 <script type="text/javascript">
 879   <!--
 880   // Private objects are initially displayed (because if
 881   // javascript is turned off then we want them to be
 882   // visible); but by default, we want to hide them.  So hide
 883   // them unless we have a cookie that says to show them.
 884   checkCookie();
 885   // -->
 886 </script>
 887 </body>
 888 </html>