add new api docs.
[lms] / www / api / lightmediascanner__db__audio_8c.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_db_audio.c File Reference</title>
4 <link href="tabs.css" rel="stylesheet" type="text/css">
5 <link href="doxygen.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.8 -->
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="annotated.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 class="tabs">
18     <ul>
19       <li><a href="files.html"><span>File&nbsp;List</span></a></li>
20       <li><a href="globals.html"><span>Globals</span></a></li>
21     </ul>
22   </div>
23 </div>
24 <div class="contents">
25 <h1>src/lib/lightmediascanner_db_audio.c File Reference</h1><code>#include &lt;<a class="el" href="lightmediascanner__db_8h-source.html">lightmediascanner_db.h</a>&gt;</code><br>
26 <code>#include &quot;<a class="el" href="lightmediascanner__db__private_8h-source.html">lightmediascanner_db_private.h</a>&quot;</code><br>
27 <code>#include &lt;stdlib.h&gt;</code><br>
28 <code>#include &lt;stdio.h&gt;</code><br>
29
30 <p>
31 <div class="dynheader">
32 Include dependency graph for lightmediascanner_db_audio.c:</div>
33 <div class="dynsection">
34 </div>
35
36 <p>
37 <a href="lightmediascanner__db__audio_8c-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
38 <tr><td></td></tr>
39 <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
40 <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__db__audio_8c.html#d2a4e90aa49af7291552e6ac172aaa51">_DB_T_UPDATE</a>(db, name, array)&nbsp;&nbsp;&nbsp;lms_db_table_update_if_required(db, name, LMS_ARRAY_SIZE(array), array)</td></tr>
41
42 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
43 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__LMS__DB.html#ge13e30aaedfabd6f1eec256649d9bc98">lms_db_audio_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS__DB.html#g09c4349148be1bdf02f069f8acb191ee">lms_db_audio_new</a> (sqlite3 *db)</td></tr>
44
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS__DB.html#g39731623b0bc5436858820a94487fdc1">lms_db_audio_start</a> (<a class="el" href="group__LMS__DB.html#ge13e30aaedfabd6f1eec256649d9bc98">lms_db_audio_t</a> *lda)</td></tr>
46
47 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__LMS__DB.html#g7560f9dab2ecd309290d200ea809375d">lms_db_audio_free</a> (<a class="el" href="group__LMS__DB.html#ge13e30aaedfabd6f1eec256649d9bc98">lms_db_audio_t</a> *lda)</td></tr>
48
49 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="lightmediascanner__db__audio_8c.html#334b8c49f8dbf76024ee6b1d69f56c8c">lms_db_audio_add</a> (<a class="el" href="group__LMS__DB.html#ge13e30aaedfabd6f1eec256649d9bc98">lms_db_audio_t</a> *lda, struct <a class="el" href="structlms__audio__info.html">lms_audio_info</a> *info)</td></tr>
50
51 </table>
52 <hr><h2>Define Documentation</h2>
53 <a class="anchor" name="d2a4e90aa49af7291552e6ac172aaa51"></a><!-- doxytag: member="lightmediascanner_db_audio.c::_DB_T_UPDATE" ref="d2a4e90aa49af7291552e6ac172aaa51" args="(db, name, array)" -->
54 <div class="memitem">
55 <div class="memproto">
56       <table class="memname">
57         <tr>
58           <td class="memname">#define _DB_T_UPDATE          </td>
59           <td>(</td>
60           <td class="paramtype">db,         <tr>
61           <td class="paramkey"></td>
62           <td></td>
63           <td class="paramtype">name,         <tr>
64           <td class="paramkey"></td>
65           <td></td>
66           <td class="paramtype">array&nbsp;</td>
67           <td class="paramname">          </td>
68           <td>&nbsp;)&nbsp;</td>
69           <td>&nbsp;&nbsp;&nbsp;lms_db_table_update_if_required(db, name, LMS_ARRAY_SIZE(array), array)</td>
70         </tr>
71       </table>
72 </div>
73 <div class="memdoc">
74
75 <p>
76
77 <p>Definition at line <a class="el" href="lightmediascanner__db__audio_8c-source.html#l00254">254</a> of file <a class="el" href="lightmediascanner__db__audio_8c-source.html">lightmediascanner_db_audio.c</a>.</p>
78
79 </div>
80 </div><p>
81 <hr><h2>Function Documentation</h2>
82 <a class="anchor" name="334b8c49f8dbf76024ee6b1d69f56c8c"></a><!-- doxytag: member="lightmediascanner_db_audio.c::lms_db_audio_add" ref="334b8c49f8dbf76024ee6b1d69f56c8c" args="(lms_db_audio_t *lda, struct lms_audio_info *info)" -->
83 <div class="memitem">
84 <div class="memproto">
85       <table class="memname">
86         <tr>
87           <td class="memname">int lms_db_audio_add           </td>
88           <td>(</td>
89           <td class="paramtype"><a class="el" href="group__LMS__DB.html#ge13e30aaedfabd6f1eec256649d9bc98">lms_db_audio_t</a> *&nbsp;</td>
90           <td class="paramname"> <em>lda</em>, </td>
91         </tr>
92         <tr>
93           <td class="paramkey"></td>
94           <td></td>
95           <td class="paramtype">struct <a class="el" href="structlms__audio__info.html">lms_audio_info</a> *&nbsp;</td>
96           <td class="paramname"> <em>info</em></td><td>&nbsp;</td>
97         </tr>
98         <tr>
99           <td></td>
100           <td>)</td>
101           <td></td><td></td><td></td>
102         </tr>
103       </table>
104 </div>
105 <div class="memdoc">
106
107 <p>
108 Add audio file to DB.<p>
109 This is usually called from plugin's <b>parse()</b> callback.<p>
110 <dl compact><dt><b>Parameters:</b></dt><dd>
111   <table border="0" cellspacing="2" cellpadding="0">
112     <tr><td valign="top"></td><td valign="top"><em>lda</em>&nbsp;</td><td>handle returned by <a class="el" href="group__LMS__DB.html#g09c4349148be1bdf02f069f8acb191ee">lms_db_audio_new()</a>. </td></tr>
113     <tr><td valign="top"></td><td valign="top"><em>info</em>&nbsp;</td><td>audio information to store.</td></tr>
114   </table>
115 </dl>
116 <dl class="return" compact><dt><b>Returns:</b></dt><dd>On success 0 is returned. </dd></dl>
117
118 <p>Definition at line <a class="el" href="lightmediascanner__db__audio_8c-source.html#l00694">694</a> of file <a class="el" href="lightmediascanner__db__audio_8c-source.html">lightmediascanner_db_audio.c</a>.</p>
119
120 <p>References <a class="el" href="lightmediascanner__db_8h-source.html#l00087">lms_audio_info::id</a>.</p>
121
122 </div>
123 </div><p>
124 </div>
125 <hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 22 23:56:01 2009 for Light Media Scanner by&nbsp;
126 <a href="http://www.doxygen.org/index.html">
127 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
128 </body>
129 </html>