Release and update docs.
[lms] / www / api / lightmediascanner__plugin_8h.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>Light Media Scanner: src/lib/lightmediascanner_plugin.h File Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top">
9   <div class="tabs">
10     <ul>
11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12       <li><a href="modules.html"><span>Modules</span></a></li>
13       <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
14       <li class="current"><a href="files.html"><span>Files</span></a></li>
15     </ul>
16   </div>
17 </div>
18 <div class="contents">
19 <h1>src/lib/lightmediascanner_plugin.h File Reference</h1><code>#include &lt;<a class="el" href="lightmediascanner_8h-source.html">lightmediascanner.h</a>&gt;</code><br>
20 <code>#include &lt;<a class="el" href="lightmediascanner__charset__conv_8h-source.html">lightmediascanner_charset_conv.h</a>&gt;</code><br>
21 <code>#include &lt;sqlite3.h&gt;</code><br>
22 <code>#include &lt;sys/types.h&gt;</code><br>
23
24 <p>
25 <div class="dynheader">
26 Include dependency graph for lightmediascanner_plugin.h:</div>
27 <div class="dynsection">
28 <p><center><img src="lightmediascanner__plugin_8h__incl.png" border="0" usemap="#src/lib/lightmediascanner_plugin.h_map" alt=""></center>
29 <map name="src/lib/lightmediascanner_plugin.h_map">
30 <area shape="rect" href="lightmediascanner_8h.html" title="lightmediascanner.h" alt="" coords="5,84,160,110"><area shape="rect" href="lightmediascanner__charset__conv_8h.html" title="lightmediascanner_charset_conv.h" alt="" coords="184,84,437,110"></map>
31 </div>
32
33 <p>
34 <div class="dynheader">
35 This graph shows which files directly or indirectly include this file:</div>
36 <div class="dynsection">
37 <p><center><img src="lightmediascanner__plugin_8h__dep__incl.png" border="0" usemap="#src/lib/lightmediascanner_plugin.hdep_map" alt=""></center>
38 <map name="src/lib/lightmediascanner_plugin.hdep_map">
39 <area shape="rect" href="lightmediascanner__private_8h.html" title="src/lib/lightmediascanner_private.h" alt="" coords="360,84,613,111"><area shape="rect" href="lightmediascanner_8c.html" title="src/lib/lightmediascanner.c" alt="" coords="5,162,203,188"><area shape="rect" href="lightmediascanner__db__private_8h.html" title="src/lib/lightmediascanner_db_private.h" alt="" coords="933,84,1208,111"><area shape="rect" href="lightmediascanner__db_8h.html" title="src/lib/lightmediascanner_db.h" alt="" coords="1405,84,1627,111"><area shape="rect" href="lightmediascanner__check_8c.html" title="src/lib/lightmediascanner_check.c" alt="" coords="227,162,472,188"><area shape="rect" href="lightmediascanner__process_8c.html" title="src/lib/lightmediascanner_process.c" alt="" coords="496,162,752,188"><area shape="rect" href="lightmediascanner__db__audio_8c.html" title="src/lib/lightmediascanner_db_audio.c" alt="" coords="1672,162,1936,188"><area shape="rect" href="lightmediascanner__db__common_8c.html" title="src/lib/lightmediascanner_db_common.c" alt="" coords="776,162,1061,188"><area shape="rect" href="lightmediascanner__db__image_8c.html" title="src/lib/lightmediascanner_db_image.c" alt="" coords="1960,162,2229,188"><area shape="rect" href="lightmediascanner__db__playlist_8c.html" title="src/lib/lightmediascanner_db_playlist.c" alt="" coords="1085,162,1360,188"><area shape="rect" href="lightmediascanner__db__video_8c.html" title="src/lib/lightmediascanner_db_video.c" alt="" coords="1384,162,1648,188"></map>
40 </div>
41
42 <p>
43 <a href="lightmediascanner__plugin_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
44 <tr><td></td></tr>
45 <tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
46 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms__file__info.html">lms_file_info</a></td></tr>
47
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms__context.html">lms_context</a></td></tr>
49
50 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structlms__plugin.html">lms_plugin</a></td></tr>
51
52 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
53 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__plugin_8h.html#25abdf2375defcfc83bf95ef930fc739">_LIGHTMEDIASCANNER_PLUGIN_H_</a>&nbsp;&nbsp;&nbsp;1</td></tr>
54
55 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
56 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void *(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__plugin_8h.html#558e8f031ecb3e6b8adf7d98f3e4fcd6">lms_plugin_match_fn_t</a> )(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, const char *path, int len, int base)</td></tr>
57
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__plugin_8h.html#649350fd7015fa63ca86c43906c3f175">lms_plugin_parse_fn_t</a> )(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt, const struct <a class="el" href="structlms__file__info.html">lms_file_info</a> *finfo, void *match)</td></tr>
59
60 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__plugin_8h.html#44576c68c208c78f34f41fcd6c7c2c4b">lms_plugin_close_fn_t</a> )(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p)</td></tr>
61
62 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__plugin_8h.html#6bfa82e6e83e85747048f41dfb334acd">lms_plugin_setup_fn_t</a> )(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt)</td></tr>
63
64 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__plugin_8h.html#875d300da41e72865452c6ae44687b77">lms_plugin_start_fn_t</a> )(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt)</td></tr>
65
66 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__plugin_8h.html#c72facc8d4fa98f660fd064c80d5b321">lms_plugin_finish_fn_t</a> )(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt)</td></tr>
67
68 </table>
69 <hr><h2>Define Documentation</h2>
70 <a class="anchor" name="25abdf2375defcfc83bf95ef930fc739"></a><!-- doxytag: member="lightmediascanner_plugin.h::_LIGHTMEDIASCANNER_PLUGIN_H_" ref="25abdf2375defcfc83bf95ef930fc739" args="" -->
71 <div class="memitem">
72 <div class="memproto">
73       <table class="memname">
74         <tr>
75           <td class="memname">#define _LIGHTMEDIASCANNER_PLUGIN_H_&nbsp;&nbsp;&nbsp;1          </td>
76         </tr>
77       </table>
78 </div>
79 <div class="memdoc">
80
81 <p>
82
83 <p>Definition at line <a class="el" href="lightmediascanner__plugin_8h-source.html#l00122">122</a> of file <a class="el" href="lightmediascanner__plugin_8h-source.html">lightmediascanner_plugin.h</a>.</p>
84
85 </div>
86 </div><p>
87 <hr><h2>Typedef Documentation</h2>
88 <a class="anchor" name="44576c68c208c78f34f41fcd6c7c2c4b"></a><!-- doxytag: member="lightmediascanner_plugin.h::lms_plugin_close_fn_t" ref="44576c68c208c78f34f41fcd6c7c2c4b" args=")(lms_plugin_t *p)" -->
89 <div class="memitem">
90 <div class="memproto">
91       <table class="memname">
92         <tr>
93           <td class="memname">typedef int(* <a class="el" href="lightmediascanner__plugin_8h.html#44576c68c208c78f34f41fcd6c7c2c4b">lms_plugin_close_fn_t</a>)(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p)          </td>
94         </tr>
95       </table>
96 </div>
97 <div class="memdoc">
98
99 <p>
100
101 <p>Definition at line <a class="el" href="lightmediascanner__plugin_8h-source.html#l00150">150</a> of file <a class="el" href="lightmediascanner__plugin_8h-source.html">lightmediascanner_plugin.h</a>.</p>
102
103 </div>
104 </div><p>
105 <a class="anchor" name="c72facc8d4fa98f660fd064c80d5b321"></a><!-- doxytag: member="lightmediascanner_plugin.h::lms_plugin_finish_fn_t" ref="c72facc8d4fa98f660fd064c80d5b321" args=")(lms_plugin_t *p, struct lms_context *ctxt)" -->
106 <div class="memitem">
107 <div class="memproto">
108       <table class="memname">
109         <tr>
110           <td class="memname">typedef int(* <a class="el" href="lightmediascanner__plugin_8h.html#c72facc8d4fa98f660fd064c80d5b321">lms_plugin_finish_fn_t</a>)(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt)          </td>
111         </tr>
112       </table>
113 </div>
114 <div class="memdoc">
115
116 <p>
117
118 <p>Definition at line <a class="el" href="lightmediascanner__plugin_8h-source.html#l00153">153</a> of file <a class="el" href="lightmediascanner__plugin_8h-source.html">lightmediascanner_plugin.h</a>.</p>
119
120 </div>
121 </div><p>
122 <a class="anchor" name="558e8f031ecb3e6b8adf7d98f3e4fcd6"></a><!-- doxytag: member="lightmediascanner_plugin.h::lms_plugin_match_fn_t" ref="558e8f031ecb3e6b8adf7d98f3e4fcd6" args=")(lms_plugin_t *p, const char *path, int len, int base)" -->
123 <div class="memitem">
124 <div class="memproto">
125       <table class="memname">
126         <tr>
127           <td class="memname">typedef void*(* <a class="el" href="lightmediascanner__plugin_8h.html#558e8f031ecb3e6b8adf7d98f3e4fcd6">lms_plugin_match_fn_t</a>)(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, const char *path, int len, int base)          </td>
128         </tr>
129       </table>
130 </div>
131 <div class="memdoc">
132
133 <p>
134
135 <p>Definition at line <a class="el" href="lightmediascanner__plugin_8h-source.html#l00148">148</a> of file <a class="el" href="lightmediascanner__plugin_8h-source.html">lightmediascanner_plugin.h</a>.</p>
136
137 </div>
138 </div><p>
139 <a class="anchor" name="649350fd7015fa63ca86c43906c3f175"></a><!-- doxytag: member="lightmediascanner_plugin.h::lms_plugin_parse_fn_t" ref="649350fd7015fa63ca86c43906c3f175" args=")(lms_plugin_t *p, struct lms_context *ctxt, const struct lms_file_info *finfo, void *match)" -->
140 <div class="memitem">
141 <div class="memproto">
142       <table class="memname">
143         <tr>
144           <td class="memname">typedef int(* <a class="el" href="lightmediascanner__plugin_8h.html#649350fd7015fa63ca86c43906c3f175">lms_plugin_parse_fn_t</a>)(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt, const struct <a class="el" href="structlms__file__info.html">lms_file_info</a> *finfo, void *match)          </td>
145         </tr>
146       </table>
147 </div>
148 <div class="memdoc">
149
150 <p>
151
152 <p>Definition at line <a class="el" href="lightmediascanner__plugin_8h-source.html#l00149">149</a> of file <a class="el" href="lightmediascanner__plugin_8h-source.html">lightmediascanner_plugin.h</a>.</p>
153
154 </div>
155 </div><p>
156 <a class="anchor" name="6bfa82e6e83e85747048f41dfb334acd"></a><!-- doxytag: member="lightmediascanner_plugin.h::lms_plugin_setup_fn_t" ref="6bfa82e6e83e85747048f41dfb334acd" args=")(lms_plugin_t *p, struct lms_context *ctxt)" -->
157 <div class="memitem">
158 <div class="memproto">
159       <table class="memname">
160         <tr>
161           <td class="memname">typedef int(* <a class="el" href="lightmediascanner__plugin_8h.html#6bfa82e6e83e85747048f41dfb334acd">lms_plugin_setup_fn_t</a>)(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt)          </td>
162         </tr>
163       </table>
164 </div>
165 <div class="memdoc">
166
167 <p>
168
169 <p>Definition at line <a class="el" href="lightmediascanner__plugin_8h-source.html#l00151">151</a> of file <a class="el" href="lightmediascanner__plugin_8h-source.html">lightmediascanner_plugin.h</a>.</p>
170
171 </div>
172 </div><p>
173 <a class="anchor" name="875d300da41e72865452c6ae44687b77"></a><!-- doxytag: member="lightmediascanner_plugin.h::lms_plugin_start_fn_t" ref="875d300da41e72865452c6ae44687b77" args=")(lms_plugin_t *p, struct lms_context *ctxt)" -->
174 <div class="memitem">
175 <div class="memproto">
176       <table class="memname">
177         <tr>
178           <td class="memname">typedef int(* <a class="el" href="lightmediascanner__plugin_8h.html#875d300da41e72865452c6ae44687b77">lms_plugin_start_fn_t</a>)(<a class="el" href="structlms__plugin.html">lms_plugin_t</a> *p, struct <a class="el" href="structlms__context.html">lms_context</a> *ctxt)          </td>
179         </tr>
180       </table>
181 </div>
182 <div class="memdoc">
183
184 <p>
185
186 <p>Definition at line <a class="el" href="lightmediascanner__plugin_8h-source.html#l00152">152</a> of file <a class="el" href="lightmediascanner__plugin_8h-source.html">lightmediascanner_plugin.h</a>.</p>
187
188 </div>
189 </div><p>
190 </div>
191 <hr size="1"><address style="text-align: right;"><small>Generated on Sun Oct 5 12:24:57 2008 for Light Media Scanner by&nbsp;
192 <a href="http://www.doxygen.org/index.html">
193 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
194 </body>
195 </html>