libmediaart-doc 0.7.0-2 / usr / share / gtk-doc / html / libmediaart / libmediaart-Cache.html

This file is indexed.

/usr/share/gtk-doc/html/libmediaart/libmediaart-Cache.html is in libmediaart-doc 0.7.0-2.

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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libmediaart Library Reference Manual: Cache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libmediaart Library Reference Manual">
<link rel="up" href="ch02.html" title="Reference">
<link rel="prev" href="libmediaart-MediaArtProcess.html" title="Extraction">
<link rel="next" href="libmediaart-Plugins.html" title="Plugins">
<meta name="generator" content="GTK-Doc V1.21 (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="#libmediaart-Cache.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libmediaart-MediaArtProcess.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libmediaart-Plugins.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libmediaart-Cache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libmediaart-Cache.top_of_page"></a>Cache</span></h2>
<p>Cache — Caching and lookup of stored media art.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libmediaart-Cache.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libmediaart-Cache.html#media-art-get-path" title="media_art_get_path ()">media_art_get_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libmediaart-Cache.html#media-art-get-file" title="media_art_get_file ()">media_art_get_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libmediaart-Cache.html#media-art-remove" title="media_art_remove ()">media_art_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libmediaart-Cache.html#media-art-strip-invalid-entities" title="media_art_strip_invalid_entities ()">media_art_strip_invalid_entities</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libmediaart-Cache.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libmediaart/mediaart.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libmediaart-Cache.description"></a><h2>Description</h2>
<p>These functions give you access to the media art that has been
extracted and saved. There are normally two places the media art
will be located in. These locations store symlinks not real copies
of the content:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>The user's XDG_CACHE_HOME directory (usually
<code class="filename">~/.cache/media-art/</code>)</p></li>
<li class="listitem"><p>The local file system's top level
<code class="filename">.mediaartlocal</code> directory (for example
<code class="filename">/media/martyn/pendrive/.mediaartlocal/</code>)</p></li>
</ul></div>
<p>To find the media art for a given media file, use the function
<a class="link" href="libmediaart-Cache.html#media-art-get-file" title="media_art_get_file ()"><code class="function">media_art_get_file()</code></a> (you can also use <a class="link" href="libmediaart-Cache.html#media-art-get-path" title="media_art_get_path ()"><code class="function">media_art_get_path()</code></a>, which
does the same thing but for path strings instead of <span class="type">GFile</span>
objects).</p>
<p>If media art for the file is not found in the cache, these
functions will return <code class="literal">NULL</code>. You may find some embedded media art
upon loading the file, and you can use <a class="link" href="libmediaart-MediaArtProcess.html#media-art-process-buffer" title="media_art_process_buffer ()"><code class="function">media_art_process_buffer()</code></a>
to convert it to the correct format and save it in the cache for
next time. The <a class="link" href="libmediaart-MediaArtProcess.html#media-art-process-file" title="media_art_process_file ()"><code class="function">media_art_process_file()</code></a> function also supports
searching for external media art images using a basic heuristic.</p>
</div>
<div class="refsect1">
<a name="libmediaart-Cache.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="media-art-get-path"></a><h3>media_art_get_path ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
media_art_get_path (<em class="parameter"><code>const <span class="type">gchar</span> *artist</code></em>,
                    <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                    <em class="parameter"><code>const <span class="type">gchar</span> *prefix</code></em>,
                    <em class="parameter"><code>const <span class="type">gchar</span> *uri</code></em>,
                    <em class="parameter"><code><span class="type">gchar</span> **cache_path</code></em>,
                    <em class="parameter"><code><span class="type">gchar</span> **local_uri</code></em>);</pre>
<p>This function calls <a class="link" href="libmediaart-Cache.html#media-art-get-file" title="media_art_get_file ()"><code class="function">media_art_get_file()</code></a> by creating a <span class="type">GFile</span> for
<em class="parameter"><code>uri</code></em>
 and passing the same arguments to <a class="link" href="libmediaart-Cache.html#media-art-get-file" title="media_art_get_file ()"><code class="function">media_art_get_file()</code></a>. For more
details about what this function does, see <a class="link" href="libmediaart-Cache.html#media-art-get-file" title="media_art_get_file ()"><code class="function">media_art_get_file()</code></a>.</p>
<p>Get the path to media art for a given resource. Newly allocated
data returned in <em class="parameter"><code>cache_path</code></em>
 and <em class="parameter"><code>local_uri</code></em>
 must be freed with <code class="function">g_free()</code>.</p>
<div class="refsect3">
<a name="id-1.3.3.3.6.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>artist</p></td>
<td class="parameter_description"><p> the artist. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p> the title. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>prefix</p></td>
<td class="parameter_description"><p> the prefix, for example "album". </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p> the uri of the file or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>cache_path</p></td>
<td class="parameter_description"><p> a string
representing the path to the cache for this media art
path or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>local_uri</p></td>
<td class="parameter_description"><p> a string
representing the URI to the local media art or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.6.2.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>cache_path</code></em>
or <em class="parameter"><code>local_uri</code></em>
were returned,
otherwise <code class="literal">FALSE</code>.</p>
<p></p>
</div>
<p class="since">Since 0.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="media-art-get-file"></a><h3>media_art_get_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
media_art_get_file (<em class="parameter"><code>const <span class="type">gchar</span> *artist</code></em>,
                    <em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
                    <em class="parameter"><code>const <span class="type">gchar</span> *prefix</code></em>,
                    <em class="parameter"><code><span class="type">GFile</span> *file</code></em>,
                    <em class="parameter"><code><span class="type">GFile</span> **cache_file</code></em>,
                    <em class="parameter"><code><span class="type">GFile</span> **local_file</code></em>);</pre>
<p>Gets the files pointing to cache files suitable for storing the media
art provided by the <em class="parameter"><code>artist</code></em>
, <em class="parameter"><code>title</code></em>
 and <em class="parameter"><code>file</code></em>
 arguments. <em class="parameter"><code>cache_file</code></em>

will point to a location in the XDG user cache directory, meanwhile
<em class="parameter"><code>local_file</code></em>
 will point to a cache file that resides in the same
filesystem than <em class="parameter"><code>file</code></em>
.</p>
<p>The <em class="parameter"><code>file</code></em>
 provided is required if <em class="parameter"><code>local_file</code></em>
 is to be returned.
The <em class="parameter"><code>local_file</code></em>
 relates to a location on the media the local file
system or media storage it is found on, so for example, if you have
a mounted volume with MP3s on it in
<code class="filename">file:///media/martyn/pendrive</code>, the <em class="parameter"><code>local_file</code></em>

will point to a URI that looks like
<code class="filename">file:///media/martyn/pendrive/.mediaartlocal/...</code>.</p>
<p>The <em class="parameter"><code>cache_file</code></em>
 is very different to the <em class="parameter"><code>local_file</code></em>
, the
<em class="parameter"><code>cache_file</code></em>
 relates to a symlink stored in XDG cache directories
for the user. A <em class="parameter"><code>cache_file</code></em>
 would be expected to look like
<code class="filename">file:///home/martyn/.cache/media-art/...</code>. This
is normally the location that is most useful (assuming the cache
has been extracted in the first place).</p>
<p>When done, both <span class="type">GFile</span>s must be freed with <code class="function">g_object_unref()</code> if
non-<code class="literal">NULL</code>.</p>
<div class="refsect3">
<a name="id-1.3.3.3.6.3.8"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>artist</p></td>
<td class="parameter_description"><p> the artist. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p> the title. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>prefix</p></td>
<td class="parameter_description"><p> the prefix for cache files, for example "album". </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p> a <span class="type">GFile</span> representing the actual media art or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>cache_file</p></td>
<td class="parameter_description"><p> a pointer to a
<span class="type">GFile</span> which represents the cached file for media art, or <code class="literal">NULL</code>
a <span class="type">GFile</span> representing the user's cache path, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>local_file</p></td>
<td class="parameter_description"><p> a pointer to a
<span class="type">GFile</span> representing the location of the local media art. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.6.3.9"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>cache_file</code></em>
or <em class="parameter"><code>local_file</code></em>
were returned, otherwise <code class="literal">FALSE</code>.</p>
<p></p>
</div>
<p class="since">Since 0.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="media-art-remove"></a><h3>media_art_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
media_art_remove (<em class="parameter"><code>const <span class="type">gchar</span> *artist</code></em>,
                  <em class="parameter"><code>const <span class="type">gchar</span> *album</code></em>);</pre>
<p>Removes media art for given album/artist provided.</p>
<div class="refsect3">
<a name="id-1.3.3.3.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>artist</p></td>
<td class="parameter_description"><p>artist the media art belongs to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>album</p></td>
<td class="parameter_description"><p> album the media art belongs or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.6.4.6"></a><h4>Returns</h4>
<p> <span class="type">TRUE</span> on success, otherwise <span class="type">FALSE</span>.</p>
<p></p>
</div>
<p class="since">Since 0.2.0</p>
</div>
<hr>
<div class="refsect2">
<a name="media-art-strip-invalid-entities"></a><h3>media_art_strip_invalid_entities ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
media_art_strip_invalid_entities (<em class="parameter"><code>const <span class="type">gchar</span> *original</code></em>);</pre>
<p>Strip a albumname or artistname string to prepare it for calculating the
media art path with it. Certain characters and charactersets will be stripped
and a newly allocated string returned which you must free with <code class="function">g_free()</code>.</p>
<p>This functions is used internally by <a class="link" href="libmediaart-Cache.html#media-art-get-file" title="media_art_get_file ()"><code class="function">media_art_get_file()</code></a> and
<a class="link" href="libmediaart-Cache.html#media-art-get-path" title="media_art_get_path ()"><code class="function">media_art_get_path()</code></a>. You will not normally need to call it yourself.</p>
<p>This function provides the following features:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem"><p>Invalid characters include: ()[]&lt;&gt;{}_!@#$^&amp;*+=|\/"'?~;</p></li>
<li class="listitem"><p>Text inside brackets <code class="function">of()</code>, {}, [] and &lt;&gt; pairs are removed.</p></li>
<li class="listitem"><p>Multiples of space characters are removed.</p></li>
</ol></div>
<div class="refsect3">
<a name="id-1.3.3.3.6.5.8"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>original</p></td>
<td class="parameter_description"><p>original string</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.3.6.5.9"></a><h4>Returns</h4>
<p> <em class="parameter"><code>original</code></em>
stripped of invalid characters which must be
freed. On error or if <em class="parameter"><code>original</code></em>
is empty, <code class="literal">NULL</code> is returned.</p>
<p></p>
</div>
<p class="since">Since 0.2.0</p>
</div>
</div>
<div class="refsect1">
<a name="libmediaart-Cache.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.