doc/gupnp-dlna/html/GUPnPDLNAImageInformation.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>GUPnPDLNAImageInformation</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="GUPnPDLNAContainerInformation.html" title="GUPnPDLNAContainerInformation">
  10 <link rel="next" href="GUPnPDLNAVideoInformation.html" title="GUPnPDLNAVideoInformation">
  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="GUPnPDLNAContainerInformation.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="GUPnPDLNAVideoInformation.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="#GUPnPDLNAImageInformation.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUPnPDLNAImageInformation.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUPnPDLNAImageInformation.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="GUPnPDLNAImageInformation"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="GUPnPDLNAImageInformation.top_of_page"></a>GUPnPDLNAImageInformation</span></h2>
  36 <p>GUPnPDLNAImageInformation — Base class representing image metadata needed
  37 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="GUPnPDLNAImageInformation.synopsis"></a><h2>Synopsis</h2>
  43 <pre class="synopsis">                    <a class="link" href="GUPnPDLNAImageInformation.html#GUPnPDLNAImageInformation-struct" title="GUPnPDLNAImageInformation">GUPnPDLNAImageInformation</a>;
  44                     <a class="link" href="GUPnPDLNAImageInformation.html#GUPnPDLNAImageInformationClass" title="GUPnPDLNAImageInformationClass">GUPnPDLNAImageInformationClass</a>;
  45 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   <a class="link" href="GUPnPDLNAImageInformation.html#gupnp-dlna-image-information-get-depth" title="gupnp_dlna_image_information_get_depth ()">gupnp_dlna_image_information_get_depth</a>
  46                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</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="GUPnPDLNAImageInformation.html#gupnp-dlna-image-information-get-height" title="gupnp_dlna_image_information_get_height ()">gupnp_dlna_image_information_get_height</a>
  48                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> *info</code></em>);
  49 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> <a class="link" href="GUPnPDLNAImageInformation.html#gupnp-dlna-image-information-get-mime" title="gupnp_dlna_image_information_get_mime ()">gupnp_dlna_image_information_get_mime</a>
  50                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> *info</code></em>);
  51 <a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   <a class="link" href="GUPnPDLNAImageInformation.html#gupnp-dlna-image-information-get-width" title="gupnp_dlna_image_information_get_width ()">gupnp_dlna_image_information_get_width</a>
  52                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> *info</code></em>);
  53 </pre>
  54 </div>
  55 <div class="refsect1">
  56 <a name="GUPnPDLNAImageInformation.object-hierarchy"></a><h2>Object Hierarchy</h2>
  57 <pre class="synopsis">
  58   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  59    +----GUPnPDLNAImageInformation
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="GUPnPDLNAImageInformation.description"></a><h2>Description</h2>
  64 <p>
  65 <a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> holds all image metadatas important for
  66 matching profiles. Note that it does not mean all data should be
  67 provided for every image file as in some cases it does not make
  68 sense.
  69 </p>
  70 <p>
  71 For metadata attributes that do not exist in current image file an
  72 unset value should be returned. For metadata attributes that do
  73 exist a set value with proper underlying value should be
  74 returned. In case metadata extractor has completely no clue how to
  75 extract some metadata attribute at all, an unsupported value should
  76 be returned. Note that unsupported values should be a temporary
  77 mean before fixing the multimedia framework to be able to extract
  78 such attribute.
  79 </p>
  80 <p>
  81 Note that <a class="link" href="GUPnPDLNAImageInformation.html#gupnp-dlna-image-information-get-mime" title="gupnp_dlna_image_information_get_mime ()"><code class="function">gupnp_dlna_image_information_get_mime()</code></a> should always
  82 return a set value. Otherwise it is highly probably that the file
  83 will not match against any DLNA profile.
  84 </p>
  85 </div>
  86 <div class="refsect1">
  87 <a name="GUPnPDLNAImageInformation.details"></a><h2>Details</h2>
  88 <div class="refsect2">
  89 <a name="GUPnPDLNAImageInformation-struct"></a><h3>GUPnPDLNAImageInformation</h3>
  90 <pre class="programlisting">typedef struct _GUPnPDLNAImageInformation GUPnPDLNAImageInformation;</pre>
  91 </div>
  92 <hr>
  93 <div class="refsect2">
  94 <a name="GUPnPDLNAImageInformationClass"></a><h3>GUPnPDLNAImageInformationClass</h3>
  95 <pre class="programlisting">typedef struct {
  96         GObjectClass parent_class;
  97
  98         GUPnPDLNAIntValue
  99         (* get_depth) (GUPnPDLNAImageInformation *info);
 100
 101         GUPnPDLNAIntValue
 102         (* get_height) (GUPnPDLNAImageInformation *info);
 103
 104         GUPnPDLNAIntValue
 105         (* get_width) (GUPnPDLNAImageInformation *info);
 106
 107         GUPnPDLNAStringValue
 108         (* get_mime) (GUPnPDLNAImageInformation *info);
 109
 110         gpointer _reserved[12];
 111 } GUPnPDLNAImageInformationClass;
 112 </pre>
 113 <div class="variablelist"><table border="0">
 114 <col align="left" valign="top">
 115 <tbody>
 116 <tr>
 117 <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="GUPnPDLNAImageInformationClass.parent-class"></a>parent_class</code></em>;</span></p></td>
 118 <td>Parent class.</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAImageInformationClass.get-depth"></a>get_depth</code></em> ()</span></p></td>
 122 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get a
 123 depth.</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAImageInformationClass.get-height"></a>get_height</code></em> ()</span></p></td>
 127 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get a
 128 height.</td>
 129 </tr>
 130 <tr>
 131 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAImageInformationClass.get-width"></a>get_width</code></em> ()</span></p></td>
 132 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get a
 133 width.</td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term"><em class="structfield"><code><a name="GUPnPDLNAImageInformationClass.get-mime"></a>get_mime</code></em> ()</span></p></td>
 137 <td>This is called by <a class="link" href="GUPnPDLNAProfileGuesser.html" title="GUPnPDLNAProfileGuesser"><span class="type">GUPnPDLNAProfileGuesser</span></a> to get a MIME
 138 type.</td>
 139 </tr>
 140 <tr>
 141 <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="GUPnPDLNAImageInformationClass.-reserved"></a>_reserved</code></em>[12];</span></p></td>
 142 <td>Padding. Ignore it.</td>
 143 </tr>
 144 </tbody>
 145 </table></div>
 146 </div>
 147 <hr>
 148 <div class="refsect2">
 149 <a name="gupnp-dlna-image-information-get-depth"></a><h3>gupnp_dlna_image_information_get_depth ()</h3>
 150 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   gupnp_dlna_image_information_get_depth
 151                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> *info</code></em>);</pre>
 152 <div class="variablelist"><table border="0">
 153 <col align="left" valign="top">
 154 <tbody>
 155 <tr>
 156 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 157 <td>A <a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> object.</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 161 <td>A depth of an image.</td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="gupnp-dlna-image-information-get-height"></a><h3>gupnp_dlna_image_information_get_height ()</h3>
 169 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   gupnp_dlna_image_information_get_height
 170                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> *info</code></em>);</pre>
 171 <div class="variablelist"><table border="0">
 172 <col align="left" valign="top">
 173 <tbody>
 174 <tr>
 175 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 176 <td>A <a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> object.</td>
 177 </tr>
 178 <tr>
 179 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 180 <td>A height of an image.</td>
 181 </tr>
 182 </tbody>
 183 </table></div>
 184 </div>
 185 <hr>
 186 <div class="refsect2">
 187 <a name="gupnp-dlna-image-information-get-mime"></a><h3>gupnp_dlna_image_information_get_mime ()</h3>
 188 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAStringValue" title="GUPnPDLNAStringValue"><span class="returnvalue">GUPnPDLNAStringValue</span></a> gupnp_dlna_image_information_get_mime
 189                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> *info</code></em>);</pre>
 190 <div class="variablelist"><table border="0">
 191 <col align="left" valign="top">
 192 <tbody>
 193 <tr>
 194 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 195 <td>A <a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> object.</td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 199 <td>A MIME type of an image.</td>
 200 </tr>
 201 </tbody>
 202 </table></div>
 203 </div>
 204 <hr>
 205 <div class="refsect2">
 206 <a name="gupnp-dlna-image-information-get-width"></a><h3>gupnp_dlna_image_information_get_width ()</h3>
 207 <pre class="programlisting"><a class="link" href="gupnp-dlna-GUPnP-DLNA-Values.html#GUPnPDLNAIntValue" title="GUPnPDLNAIntValue"><span class="returnvalue">GUPnPDLNAIntValue</span></a>   gupnp_dlna_image_information_get_width
 208                                                         (<em class="parameter"><code><a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> *info</code></em>);</pre>
 209 <div class="variablelist"><table border="0">
 210 <col align="left" valign="top">
 211 <tbody>
 212 <tr>
 213 <td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
 214 <td>A <a class="link" href="GUPnPDLNAImageInformation.html" title="GUPnPDLNAImageInformation"><span class="type">GUPnPDLNAImageInformation</span></a> object.</td>
 215 </tr>
 216 <tr>
 217 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 218 <td>A width of an image.</td>
 219 </tr>
 220 </tbody>
 221 </table></div>
 222 </div>
 223 </div>
 224 <div class="refsect1">
 225 <a name="GUPnPDLNAImageInformation.see-also"></a><h2>See Also</h2>
 226 <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>,
 227 <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>
 228 </div>
 229 </div>
 230 <div class="footer">
 231 <hr>
 232           Generated by GTK-Doc V1.18</div>
 233 </body>
 234 </html>