/usr/share/gtk-doc/html/libtracker-miner/libtracker-miner-TrackerThumbnailer.html is in libtracker-miner-doc 1.6.2-0ubuntu1.
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 331 332 333 334 335 336 337 338 339 340 341 342 343 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TrackerThumbnailer: Tracker Miner Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Tracker Miner Library Reference Manual">
<link rel="up" href="ch05.html" title="Utilities">
<link rel="prev" href="ch05.html" title="Utilities">
<link rel="next" href="libtracker-miner-Media-art-management.html" title="Media art management">
<meta name="generator" content="GTK-Doc V1.24 (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="#libtracker-miner-TrackerThumbnailer.description" class="shortcut">Description</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libtracker-miner-Media-art-management.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libtracker-miner-TrackerThumbnailer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libtracker-miner-TrackerThumbnailer.top_of_page"></a>TrackerThumbnailer</span></h2>
<p>TrackerThumbnailer — Request the thumbnailer service creates or
updates thumbnails.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libtracker-miner-TrackerThumbnailer.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="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer"><span class="returnvalue">TrackerThumbnailer</span></a> *
</td>
<td class="function_name">
<a class="link" href="libtracker-miner-TrackerThumbnailer.html#tracker-thumbnailer-new" title="tracker_thumbnailer_new ()">tracker_thumbnailer_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libtracker-miner-TrackerThumbnailer.html#tracker-thumbnailer-send" title="tracker_thumbnailer_send ()">tracker_thumbnailer_send</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libtracker-miner-TrackerThumbnailer.html#tracker-thumbnailer-move-add" title="tracker_thumbnailer_move_add ()">tracker_thumbnailer_move_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libtracker-miner-TrackerThumbnailer.html#tracker-thumbnailer-remove-add" title="tracker_thumbnailer_remove_add ()">tracker_thumbnailer_remove_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libtracker-miner-TrackerThumbnailer.html#tracker-thumbnailer-cleanup" title="tracker_thumbnailer_cleanup ()">tracker_thumbnailer_cleanup</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libtracker-miner-TrackerThumbnailer.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">struct</td>
<td class="function_name"><a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer">TrackerThumbnailer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailerClass" title="struct TrackerThumbnailerClass">TrackerThumbnailerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libtracker-miner-TrackerThumbnailer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libtracker-miner/tracker-miner.h>
</pre>
</div>
<div class="refsect1">
<a name="libtracker-miner-TrackerThumbnailer.description"></a><h2>Description</h2>
<p>This is a convenience API using D-Bus for creating and updating
thumbnails for files being mined. It is also used to create
thumbnails for album art found embedded in some medias.</p>
<p>This follows the thumbnailer specification:
http://live.gnome.org/ThumbnailerSpec</p>
</div>
<div class="refsect1">
<a name="libtracker-miner-TrackerThumbnailer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tracker-thumbnailer-new"></a><h3>tracker_thumbnailer_new ()</h3>
<pre class="programlisting"><a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer"><span class="returnvalue">TrackerThumbnailer</span></a> *
tracker_thumbnailer_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer"><span class="type">TrackerThumbnailer</span></a> object that can be used to signal
the system's thumbnailing daemon(s) via D-Bus to add or remove
content that needs thumbnailing.</p>
<p>For example, when mounting a USB thumb drive, content may not have
thumbnails and this object allows the content of that thumb drive
to be queued for processing.</p>
<div class="refsect3">
<a name="id-1.3.6.2.7.2.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successfully stored to be reported, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: 0.18.</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-thumbnailer-send"></a><h3>tracker_thumbnailer_send ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
tracker_thumbnailer_send (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer"><span class="type">TrackerThumbnailer</span></a> *thumbnailer</code></em>);</pre>
<p>Sends to the thumbnailer all stored requests.</p>
<div class="refsect3">
<a name="id-1.3.6.2.7.3.5"></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>thumbnailer</p></td>
<td class="parameter_description"><p>Thumbnailer object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-thumbnailer-move-add"></a><h3>tracker_thumbnailer_move_add ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
tracker_thumbnailer_move_add (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer"><span class="type">TrackerThumbnailer</span></a> *thumbnailer</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *from_uri</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mime_type</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *to_uri</code></em>);</pre>
<p>Adds a new request to tell the thumbnailer that <em class="parameter"><code>from_uri</code></em>
was moved to
<em class="parameter"><code>to_uri</code></em>
. Stored requests can be sent with <a class="link" href="libtracker-miner-TrackerThumbnailer.html#tracker-thumbnailer-send" title="tracker_thumbnailer_send ()"><code class="function">tracker_thumbnailer_send()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.6.2.7.4.5"></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>thumbnailer</p></td>
<td class="parameter_description"><p>Thumbnailer object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>from_uri</p></td>
<td class="parameter_description"><p>URI of the file before the move</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mime_type</p></td>
<td class="parameter_description"><p>mime-type of the file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>to_uri</p></td>
<td class="parameter_description"><p>URI of the file after the move</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.6.2.7.4.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successfully stored to be reported, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</p>
</div>
<p class="since">Since: 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-thumbnailer-remove-add"></a><h3>tracker_thumbnailer_remove_add ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
tracker_thumbnailer_remove_add (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer"><span class="type">TrackerThumbnailer</span></a> *thumbnailer</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mime_type</code></em>);</pre>
<p>Adds a new request to tell the thumbnailer that <em class="parameter"><code>uri</code></em>
was removed.
Stored requests can be sent with <a class="link" href="libtracker-miner-TrackerThumbnailer.html#tracker-thumbnailer-send" title="tracker_thumbnailer_send ()"><code class="function">tracker_thumbnailer_send()</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.6.2.7.5.5"></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>thumbnailer</p></td>
<td class="parameter_description"><p>Thumbnailer object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>URI of the file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mime_type</p></td>
<td class="parameter_description"><p>mime-type of the file</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.6.2.7.5.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successfully stored to be reported, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</p>
</div>
<p class="since">Since: 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="tracker-thumbnailer-cleanup"></a><h3>tracker_thumbnailer_cleanup ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
tracker_thumbnailer_cleanup (<em class="parameter"><code><a class="link" href="libtracker-miner-TrackerThumbnailer.html#TrackerThumbnailer" title="struct TrackerThumbnailer"><span class="type">TrackerThumbnailer</span></a> *thumbnailer</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri_prefix</code></em>);</pre>
<p>Tells thumbnailer to cleanup all thumbnails under <em class="parameter"><code>uri_prefix</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.6.2.7.6.5"></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>thumbnailer</p></td>
<td class="parameter_description"><p>Thumbnailer object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri_prefix</p></td>
<td class="parameter_description"><p>URI prefix</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.6.2.7.6.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if successfully reported, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><span class="type">FALSE</span></a> otherwise.</p>
</div>
<p class="since">Since: 0.8</p>
</div>
</div>
<div class="refsect1">
<a name="libtracker-miner-TrackerThumbnailer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="TrackerThumbnailer"></a><h3>struct TrackerThumbnailer</h3>
<pre class="programlisting">struct TrackerThumbnailer {
GObject parent;
};
</pre>
<p>A class implementation for managing thumbnails when mining content.</p>
<div class="refsect3">
<a name="id-1.3.6.2.8.2.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> <em class="structfield"><code><a name="TrackerThumbnailer.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>parent object</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="TrackerThumbnailerClass"></a><h3>struct TrackerThumbnailerClass</h3>
<pre class="programlisting">struct TrackerThumbnailerClass {
GObjectClass parent;
};
</pre>
<p>Prototype for the class.</p>
<div class="refsect3">
<a name="id-1.3.6.2.8.3.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="TrackerThumbnailerClass.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>parent object class</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|