Blob Blame History Raw
<!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: GUPnP A/V Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GUPnPDIDLLiteParser.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GUPnPDIDLLiteParser.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GUPnPDIDLLiteParser.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GUPnPDIDLLiteObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="returnvalue">GUPnPDIDLLiteParser</span></a> *
</td>
<td class="function_name">
<a class="link" href="GUPnPDIDLLiteParser.html#gupnp-didl-lite-parser-new" title="gupnp_didl_lite_parser_new ()">gupnp_didl_lite_parser_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-container-available" title="The “container-available” signal">container-available</a></td>
<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-item-available" title="The “item-available” signal">item-available</a></td>
<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-object-available" title="The “object-available” signal">object-available</a></td>
<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GUPnPDIDLLiteParser.html#GUPnPDIDLLiteParser-struct" title="GUPnPDIDLLiteParser">GUPnPDIDLLiteParser</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GUPnPDIDLLiteParser
</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.functions_details"></a><h2>Functions</h2>
<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="refsect3">
<a name="gupnp-didl-lite-parser-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> object.</p>
</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"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
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><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **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="refsect3">
<a name="gupnp-didl-lite-parser-parse-didl.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>parser</p></td>
<td class="parameter_description"><p>A <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>didl</p></td>
<td class="parameter_description"><p>The DIDL-Lite XML string to be parsed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>The location where to store any error, or NULL</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gupnp-didl-lite-parser-parse-didl.returns"></a><h4>Returns</h4>
<p> TRUE on success.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GUPnPDIDLLiteParser.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GUPnPDIDLLiteParser-struct"></a><h3>GUPnPDIDLLiteParser</h3>
<pre class="programlisting">typedef struct _GUPnPDIDLLiteParser GUPnPDIDLLiteParser;</pre>
</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,
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                user_data)</pre>
<p>The ::container-available signal is emitted each time a container is
found in the DIDL-Lite XML being parsed.</p>
<div class="refsect3">
<a name="GUPnPDIDLLiteParser-container-available.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>parser</p></td>
<td class="parameter_description"><p>The <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>container</p></td>
<td class="parameter_description"><p>The now available <a class="link" href="GUPnPDIDLLiteContainer.html" title="GUPnPDIDLLiteContainer"><span class="type">GUPnPDIDLLiteContainer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</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,
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>             user_data)</pre>
<p>The ::item-available signal is emitted each time an item is found in
the DIDL-Lite XML being parsed.</p>
<div class="refsect3">
<a name="GUPnPDIDLLiteParser-item-available.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>parser</p></td>
<td class="parameter_description"><p>The <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>The now available <a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</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,
               <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>             user_data)</pre>
<p>The ::object-available signal is emitted each time an object is
found in the DIDL-Lite XML being parsed.</p>
<div class="refsect3">
<a name="GUPnPDIDLLiteParser-object-available.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>parser</p></td>
<td class="parameter_description"><p>The <a class="link" href="GUPnPDIDLLiteParser.html" title="GUPnPDIDLLiteParser"><span class="type">GUPnPDIDLLiteParser</span></a> that received the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>The now available <a class="link" href="GUPnPDIDLLiteObject.html" title="GUPnPDIDLLiteObject"><span class="type">GUPnPDIDLLiteObject</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>