doc/gupnp-dlna/html/GUPnPDLNAContainerInformation.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>GUPnPDLNAContainerInformation</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GUPnP DLNA Reference Manual">
   8 <link rel="up" href="ch01.html" title="GUPnP DLNA">
   9 <link rel="prev" href="GUPnPDLNAAudioInformation.html" title="GUPnPDLNAAudioInformation">
  10 <link rel="next" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation">
  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="GUPnPDLNAAudioInformation.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 DLNA Reference Manual</th>
  21 <td><a accesskey="n" href="GUPnPDLNAImageInformation.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="#GUPnPDLNAContainerInformation.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUPnPDLNAContainerInformation.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUPnPDLNAContainerInformation.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GUPnPDLNAContainerInformation"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GUPnPDLNAContainerInformation.top_of_page"></a>GUPnPDLNAContainerInformation</span></h2>
  36 <p>GUPnPDLNAContainerInformation — Base class representing container metadata
  37 needed for DLNA profiles matching.</p>
  38 </td>
  39 <td valign="top" align="right"></td>
  40 </tr></table></div>
  41 <div class="refsynopsisdiv">
  42 <a name="GUPnPDLNAContainerInformation.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">                    <a class="link" href="GUPnPDLNAContainerInformation.html#GUPnPDLNAContainerInformation-struct" title="GUPnPDLNAContainerInformation">GUPnPDLNAContainerInformation</a>;
  44                     <a class="link" href="GUPnPDLNAContainerInformation.html#GUPnPDLNAContainerInformationClass" title="GUPnPDLNAContainerInformationClass">GUPnPDLNAContainerInformationClass</a>;
  45 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> <a class="link" href="GUPnPDLNAContainerInformation.html#gupnp-dlna-container-information-get-mime" title="gupnp_dlna_container_information_get_mime ()">gupnp_dlna_container_information_get_mime</a>
  46                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);
  47 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   <a class="link" href="GUPnPDLNAContainerInformation.html#gupnp-dlna-container-information-get-mpeg-version" title="gupnp_dlna_container_information_get_mpeg_version ()">gupnp_dlna_container_information_get_mpeg_version</a>
  48                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);
  49 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   <a class="link" href="GUPnPDLNAContainerInformation.html#gupnp-dlna-container-information-get-packet-size" title="gupnp_dlna_container_information_get_packet_size ()">gupnp_dlna_container_information_get_packet_size</a>
  50                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);
  51 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> <a class="link" href="GUPnPDLNAContainerInformation.html#gupnp-dlna-container-information-get-profile" title="gupnp_dlna_container_information_get_profile ()">gupnp_dlna_container_information_get_profile</a>
  52                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);
  53 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> <a class="link" href="GUPnPDLNAContainerInformation.html#gupnp-dlna-container-information-get-variant" title="gupnp_dlna_container_information_get_variant ()">gupnp_dlna_container_information_get_variant</a>
  54                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);
  55 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue"><span class="returnvalue">GUPnPDLNABoolValue</span></a>  <a class="link" href="GUPnPDLNAContainerInformation.html#gupnp-dlna-container-information-is-system-stream" title="gupnp_dlna_container_information_is_system_stream ()">gupnp_dlna_container_information_is_system_stream</a>
  56                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="GUPnPDLNAContainerInformation.object-hierarchy"></a><h2>Object Hierarchy</h2>
  61 <pre class="synopsis">
  62   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  63    +----GUPnPDLNAContainerInformation
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="GUPnPDLNAContainerInformation.description"></a><h2>Description</h2>
  68 <p>
  69 <a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> holds all container metadatas
  70 important for matching profiles. Note that it does not mean all
  71 data should be provided for every media file as in some cases it
  72 does not make sense (e.g. MPEG version does not make sense for WMA
  73 media files).
  74 </p>
  75 <p>
  76 For metadata attributes that do not exist in current media file an
  77 unset value should be returned. For metadata attributes that do
  78 exist a set value with proper underlying value should be
  79 returned. In case metadata extractor has completely no clue how to
  80 extract some metadata attribute at all, an unsupported value should
  81 be returned. Note that unsupported values should be a temporary
  82 mean before fixing the multimedia framework to be able to extract
  83 such attribute.
  84 </p>
  85 <p>
  86 Note that <a class="link" href="GUPnPDLNAContainerInformation.html#gupnp-dlna-container-information-get-mime" title="gupnp_dlna_container_information_get_mime ()"><code class="function">gupnp_dlna_container_information_get_mime()</code></a> should always
  87 return a set value. Otherwise it is highly probably that the file
  88 will not match against any DLNA profile.
  89 </p>
  90 </div>
  91 <div class="refsect1">
  92 <a name="GUPnPDLNAContainerInformation.details"></a><h2>Details</h2>
  93 <div class="refsect2">
  94 <a name="GUPnPDLNAContainerInformation-struct"></a><h3>GUPnPDLNAContainerInformation</h3>
  95 <pre class="programlisting">typedef struct _GUPnPDLNAContainerInformation GUPnPDLNAContainerInformation;</pre>
  96 </div>
  97 <hr>
  98 <div class="refsect2">
  99 <a name="GUPnPDLNAContainerInformationClass"></a><h3>GUPnPDLNAContainerInformationClass</h3>
 100 <pre class="programlisting">typedef struct {
 101         GObjectClass parent_class;
 102
 103         GUPnPDLNAIntValue
 104         (* get_mpeg_version) (GUPnPDLNAContainerInformation *info);
 105
 106         GUPnPDLNAIntValue
 107         (* get_packet_size) (GUPnPDLNAContainerInformation *info);
 108
 109         GUPnPDLNAStringValue
 110         (* get_profile) (GUPnPDLNAContainerInformation *info);
 111
 112         GUPnPDLNABoolValue
 113         (* is_system_stream) (GUPnPDLNAContainerInformation *info);
 114
 115         GUPnPDLNAStringValue
 116         (* get_variant) (GUPnPDLNAContainerInformation *info);
 117
 118         GUPnPDLNAStringValue
 119         (* get_mime) (GUPnPDLNAContainerInformation *info);
 120
 121         gpointer _reserved[12];
 122 } GUPnPDLNAContainerInformationClass;
 123 </pre>
 124 <div class="variablelist"><table border="0">
 125 <col align="left" valign="top">
 126 <tbody>
 127 <tr>
 128 <td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 129 <td>Parent class.</td>
 130 </tr>
 131 <tr>
 132 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.get-mpeg-version"></a>get_mpeg_version</code></em> ()</span></p></td>
 133 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to
 134 get an MPEG version.</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.get-packet-size"></a>get_packet_size</code></em> ()</span></p></td>
 138 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get
 139 a packet size.</td>
 140 </tr>
 141 <tr>
 142 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.get-profile"></a>get_profile</code></em> ()</span></p></td>
 143 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get a
 144 profile.</td>
 145 </tr>
 146 <tr>
 147 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.is-system-stream"></a>is_system_stream</code></em> ()</span></p></td>
 148 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to
 149 get whether it is a system stream</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.get-variant"></a>get_variant</code></em> ()</span></p></td>
 153 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get a
 154 variant.</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.get-mime"></a>get_mime</code></em> ()</span></p></td>
 158 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get a MIME
 159 type.</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> <em class="structfield"><code><a name="GUPnPDLNAContainerInformationClass.-reserved"></a>_reserved</code></em>[12];</span></p></td>
 163 <td>Padding. Ignore it.</td>
 164 </tr>
 165 </tbody>
 166 </table></div>
 167 </div>
 168 <hr>
 169 <div class="refsect2">
 170 <a name="gupnp-dlna-container-information-get-mime"></a><h3>gupnp_dlna_container_information_get_mime ()</h3>
 171 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> gupnp_dlna_container_information_get_mime
 172                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);</pre>
 173 <div class="variablelist"><table border="0">
 174 <col align="left" valign="top">
 175 <tbody>
 176 <tr>
 177 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 178 <td>A <a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> object.</td>
 179 </tr>
 180 <tr>
 181 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 182 <td>A MIME type.</td>
 183 </tr>
 184 </tbody>
 185 </table></div>
 186 </div>
 187 <hr>
 188 <div class="refsect2">
 189 <a name="gupnp-dlna-container-information-get-mpeg-version"></a><h3>gupnp_dlna_container_information_get_mpeg_version ()</h3>
 190 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   gupnp_dlna_container_information_get_mpeg_version
 191                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);</pre>
 192 <div class="variablelist"><table border="0">
 193 <col align="left" valign="top">
 194 <tbody>
 195 <tr>
 196 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 197 <td>A <a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> object.</td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 201 <td>An MPEG version.</td>
 202 </tr>
 203 </tbody>
 204 </table></div>
 205 </div>
 206 <hr>
 207 <div class="refsect2">
 208 <a name="gupnp-dlna-container-information-get-packet-size"></a><h3>gupnp_dlna_container_information_get_packet_size ()</h3>
 209 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   gupnp_dlna_container_information_get_packet_size
 210                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);</pre>
 211 <div class="variablelist"><table border="0">
 212 <col align="left" valign="top">
 213 <tbody>
 214 <tr>
 215 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 216 <td>A <a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> object.</td>
 217 </tr>
 218 <tr>
 219 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 220 <td>A packet size.</td>
 221 </tr>
 222 </tbody>
 223 </table></div>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="gupnp-dlna-container-information-get-profile"></a><h3>gupnp_dlna_container_information_get_profile ()</h3>
 228 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> gupnp_dlna_container_information_get_profile
 229                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);</pre>
 230 <div class="variablelist"><table border="0">
 231 <col align="left" valign="top">
 232 <tbody>
 233 <tr>
 234 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 235 <td>A <a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> object.</td>
 236 </tr>
 237 <tr>
 238 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 239 <td>A profile.</td>
 240 </tr>
 241 </tbody>
 242 </table></div>
 243 </div>
 244 <hr>
 245 <div class="refsect2">
 246 <a name="gupnp-dlna-container-information-get-variant"></a><h3>gupnp_dlna_container_information_get_variant ()</h3>
 247 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> gupnp_dlna_container_information_get_variant
 248                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);</pre>
 249 <div class="variablelist"><table border="0">
 250 <col align="left" valign="top">
 251 <tbody>
 252 <tr>
 253 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 254 <td>A <a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> object.</td>
 255 </tr>
 256 <tr>
 257 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 258 <td>A variant.</td>
 259 </tr>
 260 </tbody>
 261 </table></div>
 262 </div>
 263 <hr>
 264 <div class="refsect2">
 265 <a name="gupnp-dlna-container-information-is-system-stream"></a><h3>gupnp_dlna_container_information_is_system_stream ()</h3>
 266 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue"><span class="returnvalue">GUPnPDLNABoolValue</span></a>  gupnp_dlna_container_information_is_system_stream
 267                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> *info</code></em>);</pre>
 268 <div class="variablelist"><table border="0">
 269 <col align="left" valign="top">
 270 <tbody>
 271 <tr>
 272 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 273 <td>A <a class="link" href="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation"><span class="type">GUPnPDLNAContainerInformation</span></a> object.</td>
 274 </tr>
 275 <tr>
 276 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 277 <td>Whether it is system stream.</td>
 278 </tr>
 279 </tbody>
 280 </table></div>
 281 </div>
 282 </div>
 283 <div class="refsect1">
 284 <a name="GUPnPDLNAContainerInformation.see-also"></a><h2>See Also</h2>
 285 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNABoolValue" title="GUPnPDLNABoolValue"><span class="type">GUPnPDLNABoolValue</span></a>, <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAFractionValue" title="GUPnPDLNAFractionValue"><span class="type">GUPnPDLNAFractionValue</span></a>,
 286 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="type">GUPnPDLNAIntValue</span></a>, <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="type">GUPnPDLNAStringValue</span></a>
 287 </div>
 288 </div>
 289 <div class="footer">
 290 <hr>
 291           Generated by GTK-Doc V1.18</div>
 292 </body>
 293 </html>