summaryrefslogtreecommitdiff
path: root/doc/html/GUPnPDIDLLiteParser.html
blob: 15ef2d35faa03dfdd7e75a61536d6ddf8ad9375c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GUPnPDIDLLiteParser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GUPnP A/V Reference Manual">
<link rel="up" href="ch01.html" title="GUPnP A/V">
<link rel="prev" href="ch01.html" title="GUPnP A/V">
<link rel="next" href="GUPnPDIDLLiteObject.html" title="GUPnPDIDLLiteObject">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GUPnP A/V Reference Manual</th>
<td><a accesskey="n" href="GUPnPDIDLLiteObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GUPnPDIDLLiteParser.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GUPnPDIDLLiteParser.description" class="shortcut">Description</a>
                   | 
                  <a href="#GUPnPDIDLLiteParser.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GUPnPDIDLLiteParser.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="GUPnPDIDLLiteParser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GUPnPDIDLLiteParser.top_of_page"></a>GUPnPDIDLLiteParser</span></h2>
<p>GUPnPDIDLLiteParser — A/V DIDL-Lite XML parser</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GUPnPDIDLLiteParser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-struct" title="GUPnPDIDLLiteParser">GUPnPDIDLLiteParser</a>;
<a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="returnvalue">GUPnPDIDLLiteParser</span></a> * <a class="link" href="GUPnPDIDLLiteParser.html#gupnp-didl-lite-parser-new" title="gupnp_didl_lite_parser_new ()">gupnp_didl_lite_parser_new</a>        (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="GUPnPDIDLLiteParser.html#gupnp-didl-lite-parser-parse-didl" title="gupnp_didl_lite_parser_parse_didl ()">gupnp_didl_lite_parser_parse_didl</a>   (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> *parser</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *didl</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GUPnPDIDLLiteParser
</pre>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.signals"></a><h2>Signals</h2>
<pre class="synopsis">
  "<a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-container-available" title='The "container-available" signal'>container-available</a>"                            : <code class="literal">Run Last</code>
  "<a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-item-available" title='The "item-available" signal'>item-available</a>"                                 : <code class="literal">Run Last</code>
  "<a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-object-available" title='The "object-available" signal'>object-available</a>"                               : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.description"></a><h2>Description</h2>
<p>
<a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> parses DIDL-Lite XML strings.
</p>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GUPnPDIDLLiteParser-struct"></a><h3>GUPnPDIDLLiteParser</h3>
<pre class="programlisting">typedef struct _GUPnPDIDLLiteParser GUPnPDIDLLiteParser;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gupnp-didl-lite-parser-new"></a><h3>gupnp_didl_lite_parser_new ()</h3>
<pre class="programlisting"><a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="returnvalue">GUPnPDIDLLiteParser</span></a> * gupnp_didl_lite_parser_new        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gupnp-didl-lite-parser-parse-didl"></a><h3>gupnp_didl_lite_parser_parse_didl ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gupnp_didl_lite_parser_parse_didl   (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> *parser</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *didl</code></em>,
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Parses DIDL-Lite XML string <em class="parameter"><code>didl</code></em>, emitting the ::object-available,
::item-available and ::container-available signals appropriately during the
process.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>A <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>didl</code></em> :</span></p></td>
<td>The DIDL-Lite XML string to be parsed</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>The location where to store any error, or NULL</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GUPnPDIDLLiteParser-container-available"></a><h3>The <code class="literal">"container-available"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a>    *parser,
                                                        <a class="link" href="GUPnPDIDLLiteContainer.html" title="GUPnPDIDLLiteContainer"><span class="type">GUPnPDIDLLiteContainer</span></a> *container,
                                                        <span class="type">gpointer</span>                user_data)      : <code class="literal">Run Last</code></pre>
<p>
The ::container-available signal is emitted each time a container is
found in the DIDL-Lite XML being parsed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>The <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> that received the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>container</code></em> :</span></p></td>
<td>The now available <a class="link" href="GUPnPDIDLLiteContainer.html" title="GUPnPDIDLLiteContainer"><span class="type">GUPnPDIDLLiteContainer</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GUPnPDIDLLiteParser-item-available"></a><h3>The <code class="literal">"item-available"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> *parser,
                                                        <a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a>   *item,
                                                        <span class="type">gpointer</span>             user_data)      : <code class="literal">Run Last</code></pre>
<p>
The ::item-available signal is emitted each time an item is found in
the DIDL-Lite XML being parsed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>The <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> that received the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>The now available <a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GUPnPDIDLLiteParser-object-available"></a><h3>The <code class="literal">"object-available"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> *parser,
                                                        <a class="link" href="GUPnPDIDLLiteObject.html" title="GUPnPDIDLLiteObject"><span class="type">GUPnPDIDLLiteObject</span></a> *object,
                                                        <span class="type">gpointer</span>             user_data)      : <code class="literal">Run Last</code></pre>
<p>
The ::object-available signal is emitted each time an object is
found in the DIDL-Lite XML being parsed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>parser</code></em> :</span></p></td>
<td>The <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> that received the signal</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>The now available <a class="link" href="GUPnPDIDLLiteObject.html" title="GUPnPDIDLLiteObject"><span class="type">GUPnPDIDLLiteObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>