doc/html/GUPnPDIDLLiteItem.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GUPnPDIDLLiteItem</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GUPnP A/V Reference Manual">
   8 <link rel="up" href="ch01.html" title="GUPnP A/V">
   9 <link rel="prev" href="GUPnPDIDLLiteContainer.html" title="GUPnPDIDLLiteContainer">
  10 <link rel="next" href="GUPnPDIDLLiteWriter.html" title="GUPnPDIDLLiteWriter">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GUPnPDIDLLiteContainer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GUPnP A/V Reference Manual</th>
  21 <td><a accesskey="n" href="GUPnPDIDLLiteWriter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GUPnPDIDLLiteItem.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUPnPDIDLLiteItem.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUPnPDIDLLiteItem.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GUPnPDIDLLiteItem.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="GUPnPDIDLLiteItem"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="GUPnPDIDLLiteItem.top_of_page"></a>GUPnPDIDLLiteItem</span></h2>
  38 <p>GUPnPDIDLLiteItem — DIDL-Lite Item</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="GUPnPDIDLLiteItem.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">                    <a class="link" href="GUPnPDIDLLiteItem.html#GUPnPDIDLLiteItem-struct" title="GUPnPDIDLLiteItem">GUPnPDIDLLiteItem</a>;
  45 const <span class="returnvalue">char</span> *        <a class="link" href="GUPnPDIDLLiteItem.html#gupnp-didl-lite-item-get-ref-id" title="gupnp_didl_lite_item_get_ref_id ()">gupnp_didl_lite_item_get_ref_id</a>     (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="GUPnPDIDLLiteItem.html#gupnp-didl-lite-item-set-ref-id" title="gupnp_didl_lite_item_set_ref_id ()">gupnp_didl_lite_item_set_ref_id</a>     (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>,
  47                                                          <em class="parameter"><code>const <span class="type">char</span> *ref_id</code></em>);
  48 <span class="returnvalue">glong</span>               <a class="link" href="GUPnPDIDLLiteItem.html#gupnp-didl-lite-item-get-lifetime" title="gupnp_didl_lite_item_get_lifetime ()">gupnp_didl_lite_item_get_lifetime</a>   (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>);
  49 <span class="returnvalue">void</span>                <a class="link" href="GUPnPDIDLLiteItem.html#gupnp-didl-lite-item-set-lifetime" title="gupnp_didl_lite_item_set_lifetime ()">gupnp_didl_lite_item_set_lifetime</a>   (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>,
  50                                                          <em class="parameter"><code><span class="type">glong</span> lifetime</code></em>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="GUPnPDIDLLiteItem.object-hierarchy"></a><h2>Object Hierarchy</h2>
  55 <pre class="synopsis">
  56   GObject
  57    +----<a class="link" href="GUPnPDIDLLiteObject.html" title="GUPnPDIDLLiteObject">GUPnPDIDLLiteObject</a>
  58          +----GUPnPDIDLLiteItem
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="GUPnPDIDLLiteItem.properties"></a><h2>Properties</h2>
  63 <pre class="synopsis">
  64   "<a class="link" href="GUPnPDIDLLiteItem.html#GUPnPDIDLLiteItem--lifetime" title='The "lifetime" property'>lifetime</a>"                 <span class="type">glong</span>                 : Read / Write
  65   "<a class="link" href="GUPnPDIDLLiteItem.html#GUPnPDIDLLiteItem--ref-id" title='The "ref-id" property'>ref-id</a>"                   <span class="type">gchar</span>*                : Read / Write
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="GUPnPDIDLLiteItem.description"></a><h2>Description</h2>
  70 <p>
  71 <a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> respresents a DIDL-Lite item element.
  72 </p>
  73 </div>
  74 <div class="refsect1">
  75 <a name="GUPnPDIDLLiteItem.details"></a><h2>Details</h2>
  76 <div class="refsect2">
  77 <a name="GUPnPDIDLLiteItem-struct"></a><h3>GUPnPDIDLLiteItem</h3>
  78 <pre class="programlisting">typedef struct _GUPnPDIDLLiteItem GUPnPDIDLLiteItem;</pre>
  79 </div>
  80 <hr>
  81 <div class="refsect2">
  82 <a name="gupnp-didl-lite-item-get-ref-id"></a><h3>gupnp_didl_lite_item_get_ref_id ()</h3>
  83 <pre class="programlisting">const <span class="returnvalue">char</span> *        gupnp_didl_lite_item_get_ref_id     (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>);</pre>
  84 <p>
  85 Get the ref ID of the <em class="parameter"><code>item</code></em>.
  86 </p>
  87 <div class="variablelist"><table border="0">
  88 <col align="left" valign="top">
  89 <tbody>
  90 <tr>
  91 <td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
  92 <td><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a></td>
  93 </tr>
  94 <tr>
  95 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  96 <td>The ref ID of the <em class="parameter"><code>item</code></em>, or <code class="literal">NULL</code>.</td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 </div>
 101 <hr>
 102 <div class="refsect2">
 103 <a name="gupnp-didl-lite-item-set-ref-id"></a><h3>gupnp_didl_lite_item_set_ref_id ()</h3>
 104 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_didl_lite_item_set_ref_id     (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>,
 105                                                          <em class="parameter"><code>const <span class="type">char</span> *ref_id</code></em>);</pre>
 106 <p>
 107 Set the ref ID of the <em class="parameter"><code>item</code></em>.
 108 </p>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 111 <tbody>
 112 <tr>
 113 <td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
 114 <td><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a></td>
 115 </tr>
 116 <tr>
 117 <td><p><span class="term"><em class="parameter"><code>ref_id</code></em> :</span></p></td>
 118 <td>The ref ID</td>
 119 </tr>
 120 </tbody>
 121 </table></div>
 122 </div>
 123 <hr>
 124 <div class="refsect2">
 125 <a name="gupnp-didl-lite-item-get-lifetime"></a><h3>gupnp_didl_lite_item_get_lifetime ()</h3>
 126 <pre class="programlisting"><span class="returnvalue">glong</span>               gupnp_didl_lite_item_get_lifetime   (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>);</pre>
 127 <div class="variablelist"><table border="0">
 128 <col align="left" valign="top">
 129 <tbody>
 130 <tr>
 131 <td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
 132 <td><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a></td>
 133 </tr>
 134 <tr>
 135 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 136 <td>-1 if unset or the lifetime (in seconds) of the current item.</td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <hr>
 142 <div class="refsect2">
 143 <a name="gupnp-didl-lite-item-set-lifetime"></a><h3>gupnp_didl_lite_item_set_lifetime ()</h3>
 144 <pre class="programlisting"><span class="returnvalue">void</span>                gupnp_didl_lite_item_set_lifetime   (<em class="parameter"><code><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a> *item</code></em>,
 145                                                          <em class="parameter"><code><span class="type">glong</span> lifetime</code></em>);</pre>
 146 <div class="variablelist"><table border="0">
 147 <col align="left" valign="top">
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
 151 <td><a class="link" href="GUPnPDIDLLiteItem.html" title="GUPnPDIDLLiteItem"><span class="type">GUPnPDIDLLiteItem</span></a></td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>lifetime</code></em> :</span></p></td>
 155 <td>The lifetime (in seconds) of this item in a media collection.</td>
 156 </tr>
 157 </tbody>
 158 </table></div>
 159 </div>
 160 </div>
 161 <div class="refsect1">
 162 <a name="GUPnPDIDLLiteItem.property-details"></a><h2>Property Details</h2>
 163 <div class="refsect2">
 164 <a name="GUPnPDIDLLiteItem--lifetime"></a><h3>The <code class="literal">"lifetime"</code> property</h3>
 165 <pre class="programlisting">  "lifetime"                 <span class="type">glong</span>                 : Read / Write</pre>
 166 <p>
 167 The lifetime in seconds of this DIDLLite item in a media collection.
 168 </p>
 169 <p>Allowed values: &gt;= -1</p>
 170 <p>Default value: -1</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="GUPnPDIDLLiteItem--ref-id"></a><h3>The <code class="literal">"ref-id"</code> property</h3>
 175 <pre class="programlisting">  "ref-id"                   <span class="type">gchar</span>*                : Read / Write</pre>
 176 <p>
 177 The ref ID of this item.
 178 </p>
 179 <p>Default value: NULL</p>
 180 </div>
 181 </div>
 182 </div>
 183 <div class="footer">
 184 <hr>
 185           Generated by GTK-Doc V1.18</div>
 186 </body>
 187 </html>