/usr/share/gtk-doc/html/gdata/GDataMediaThumbnail.html is in libgdata-doc 0.14.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GData Reference Manual: GDataMediaThumbnail</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch11.html" title="Media RSS API">
<link rel="prev" href="GDataMediaCredit.html" title="GDataMediaCredit">
<link rel="next" href="ch12.html" title="YouTube API">
<meta name="generator" content="GTK-Doc V1.19.1 (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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#GDataMediaThumbnail.description" class="shortcut">Description</a>
|
<a href="#GDataMediaThumbnail.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GDataMediaThumbnail.properties" class="shortcut">Properties</a>
</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="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataMediaCredit.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch12.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataMediaThumbnail"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataMediaThumbnail.top_of_page"></a>GDataMediaThumbnail</span></h2>
<p>GDataMediaThumbnail — Media RSS thumbnail element</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataMediaThumbnail.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="GDataMediaThumbnail.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gdata/media/gdata-media-thumbnail.h>
<a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail-struct" title="GDataMediaThumbnail">GDataMediaThumbnail</a>;
<a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnailClass" title="GDataMediaThumbnailClass">GDataMediaThumbnailClass</a>;
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GDataMediaThumbnail.html#gdata-media-thumbnail-get-uri" title="gdata_media_thumbnail_get_uri ()">gdata_media_thumbnail_get_uri</a> (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="GDataMediaThumbnail.html#gdata-media-thumbnail-get-height" title="gdata_media_thumbnail_get_height ()">gdata_media_thumbnail_get_height</a> (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="GDataMediaThumbnail.html#gdata-media-thumbnail-get-width" title="gdata_media_thumbnail_get_width ()">gdata_media_thumbnail_get_width</a> (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> <a class="link" href="GDataMediaThumbnail.html#gdata-media-thumbnail-get-time" title="gdata_media_thumbnail_get_time ()">gdata_media_thumbnail_get_time</a> (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);
<a class="link" href="GDataDownloadStream.html" title="GDataDownloadStream"><span class="returnvalue">GDataDownloadStream</span></a> * <a class="link" href="GDataMediaThumbnail.html#gdata-media-thumbnail-download" title="gdata_media_thumbnail_download ()">gdata_media_thumbnail_download</a> (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GDataMediaThumbnail.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
+----GDataMediaThumbnail
</pre>
</div>
<div class="refsect1">
<a name="GDataMediaThumbnail.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--height" title='The "height" property'>height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
"<a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--time" title='The "time" property'>time</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read
"<a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--uri" title='The "uri" property'>uri</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
"<a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--width" title='The "width" property'>width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read
</pre>
</div>
<div class="refsect1">
<a name="GDataMediaThumbnail.description"></a><h2>Description</h2>
<p>
<a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> represents a "thumbnail" element from the
<a class="ulink" href="http://video.search.yahoo.com/mrss" target="_top">Media RSS specification</a>.
</p>
<p>
The class only implements parsing, not XML output, at the moment.
</p>
</div>
<div class="refsect1">
<a name="GDataMediaThumbnail.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GDataMediaThumbnail-struct"></a><h3>GDataMediaThumbnail</h3>
<pre class="programlisting">typedef struct _GDataMediaThumbnail GDataMediaThumbnail;</pre>
<p>
All the fields in the <a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> structure are private and should never be accessed directly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataMediaThumbnailClass"></a><h3>GDataMediaThumbnailClass</h3>
<pre class="programlisting">typedef struct {
} GDataMediaThumbnailClass;
</pre>
<p>
All the fields in the <a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnailClass" title="GDataMediaThumbnailClass"><span class="type">GDataMediaThumbnailClass</span></a> structure are private and should never be accessed directly.
</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-media-thumbnail-get-uri"></a><h3>gdata_media_thumbnail_get_uri ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gdata_media_thumbnail_get_uri (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--uri" title='The "uri" property'><span class="type">"uri"</span></a> property.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the thumbnail's URI</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-media-thumbnail-get-height"></a><h3>gdata_media_thumbnail_get_height ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gdata_media_thumbnail_get_height (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--height" title='The "height" property'><span class="type">"height"</span></a> property.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the thumbnail's height in pixels, or <code class="code">0</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-media-thumbnail-get-width"></a><h3>gdata_media_thumbnail_get_width ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> gdata_media_thumbnail_get_width (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--width" title='The "width" property'><span class="type">"width"</span></a> property.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the thumbnail's width in pixels, or <code class="code">0</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-media-thumbnail-get-time"></a><h3>gdata_media_thumbnail_get_time ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a> gdata_media_thumbnail_get_time (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataMediaThumbnail.html#GDataMediaThumbnail--time" title='The "time" property'><span class="type">"time"</span></a> property.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the thumbnail's time offset in the media, or <code class="code">-1</code>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-media-thumbnail-download"></a><h3>gdata_media_thumbnail_download ()</h3>
<pre class="programlisting"><a class="link" href="GDataDownloadStream.html" title="GDataDownloadStream"><span class="returnvalue">GDataDownloadStream</span></a> * gdata_media_thumbnail_download (<em class="parameter"><code><a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Downloads and returns a <a class="link" href="GDataDownloadStream.html" title="GDataDownloadStream"><span class="type">GDataDownloadStream</span></a> allowing the thumbnail data represented by <em class="parameter"><code>self</code></em> to be read.
</p>
<p>
To get the content type of the downloaded data, <a class="link" href="GDataDownloadStream.html#gdata-download-stream-get-content-type" title="gdata_download_stream_get_content_type ()"><code class="function">gdata_download_stream_get_content_type()</code></a> can be called on the returned <a class="link" href="GDataDownloadStream.html" title="GDataDownloadStream"><span class="type">GDataDownloadStream</span></a>.
Calling <a class="link" href="GDataDownloadStream.html#gdata-download-stream-get-content-length" title="gdata_download_stream_get_content_length ()"><code class="function">gdata_download_stream_get_content_length()</code></a> on the stream will not return a meaningful result, however, as the stream is encoded in chunks,
rather than by content length.
</p>
<p>
In order to cancel the download, a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> passed in to <em class="parameter"><code>cancellable</code></em> must be cancelled using <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html#g-cancellable-cancel"><code class="function">g_cancellable_cancel()</code></a>. Cancelling the individual
<a href="http://library.gnome.org/devel/gio/unstable/GInputStream.html"><span class="type">GInputStream</span></a> operations on the <a class="link" href="GDataDownloadStream.html" title="GDataDownloadStream"><span class="type">GDataDownloadStream</span></a> will not cancel the entire download; merely the read or close operation in question. See the
<a class="link" href="GDataDownloadStream.html#GDataDownloadStream--cancellable" title='The "cancellable" property'><span class="type">"cancellable"</span></a> for more details.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataMediaThumbnail.html" title="GDataMediaThumbnail"><span class="type">GDataMediaThumbnail</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>the <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> for the entire download stream, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <a class="link" href="GDataDownloadStream.html" title="GDataDownloadStream"><span class="type">GDataDownloadStream</span></a> to download the thumbnail with, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8.0</p>
</div>
</div>
<div class="refsect1">
<a name="GDataMediaThumbnail.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataMediaThumbnail--height"></a><h3>The <code class="literal">"height"</code> property</h3>
<pre class="programlisting"> "height" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre>
<p>
The height of the thumbnail, in pixels.
</p>
<p>
For more information, see the <a class="ulink" href="http://video.search.yahoo.com/mrss" target="_top">Media RSS specification</a>.
</p>
<p>Default value: 0</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataMediaThumbnail--time"></a><h3>The <code class="literal">"time"</code> property</h3>
<pre class="programlisting"> "time" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> : Read</pre>
<p>
The time offset of the thumbnail in relation to the media object, in milliseconds.
</p>
<p>
For more information, see the <a class="ulink" href="http://video.search.yahoo.com/mrss" target="_top">Media RSS specification</a>.
</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataMediaThumbnail--uri"></a><h3>The <code class="literal">"uri"</code> property</h3>
<pre class="programlisting"> "uri" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
The URI of the thumbnail.
</p>
<p>
For more information, see the <a class="ulink" href="http://video.search.yahoo.com/mrss" target="_top">Media RSS specification</a>.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.4.0</p>
</div>
<hr>
<div class="refsect2">
<a name="GDataMediaThumbnail--width"></a><h3>The <code class="literal">"width"</code> property</h3>
<pre class="programlisting"> "width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre>
<p>
The width of the thumbnail, in pixels.
</p>
<p>
For more information, see the <a class="ulink" href="http://video.search.yahoo.com/mrss" target="_top">Media RSS specification</a>.
</p>
<p>Default value: 0</p>
<p class="since">Since 0.4.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|