← Back to branch summary

~ubuntu-branches/ubuntu/raring/grilo/raring

« back to all changes in this revision

Viewing changes to doc/grilo/html/GrlMetadataSource.html

  • Committer: Bazaar Package Importer
  • Author(s): Alberto Garcia
  • Date: 2011-07-02 13:48:46 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20110702134846-u10hi90nwf6wf3v0
Tags: 0.1.16-1
* New upstream release.
* debian/{grl-inspect.1,libgrilo-0.1-0.manpages,libgrilo-0.1-0.install}:
  use manpage shipped by upstream.
* debian/libgrilo-0.1-0.shlibs: new API, bump shlibs to 0.1.16.
* debian/copyright: Author(s) => Authors.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/grilo/html/GrlMetadataSource.html
49
49
struct              <a class="link" href="GrlMetadataSource.html#GrlMetadataSource-struct" title="struct GrlMetadataSource">GrlMetadataSource</a>;
50
50
<span class="returnvalue">void</span>                (<a class="link" href="GrlMetadataSource.html#GrlMetadataSourceResolveCb" title="GrlMetadataSourceResolveCb ()">*GrlMetadataSourceResolveCb</a>)       (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
51
51
                                                         <em class="parameter"><code><span class="type">guint</span> operation_id</code></em>,
52
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
52
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
53
53
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
54
54
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);
55
55
<span class="returnvalue">void</span>                (<a class="link" href="GrlMetadataSource.html#GrlMetadataSourceSetMetadataCb" title="GrlMetadataSourceSetMetadataCb ()">*GrlMetadataSourceSetMetadataCb</a>)   (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
56
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
57
57
                                                         <em class="parameter"><code><span class="type">GList</span> *failed_keys</code></em>,
58
58
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
59
59
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);
75
75
<span class="returnvalue">GList</span> *             <a class="link" href="GrlMetadataSource.html#grl-metadata-source-filter-writable" title="grl_metadata_source_filter_writable ()">grl_metadata_source_filter_writable</a> (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
76
76
                                                         <em class="parameter"><code><span class="type">GList</span> **keys</code></em>,
77
77
                                                         <em class="parameter"><code><span class="type">gboolean</span> return_filtered</code></em>);
78
 
const <span class="returnvalue">GList</span> *       <a class="link" href="GrlMetadataSource.html#grl-metadata-source-key-depends" title="grl_metadata_source_key_depends ()">grl_metadata_source_key_depends</a>     (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
79
 
                                                         <em class="parameter"><code><a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> key_id</code></em>);
80
78
const <span class="returnvalue">GList</span> *       <a class="link" href="GrlMetadataSource.html#grl-metadata-source-writable-keys" title="grl_metadata_source_writable_keys ()">grl_metadata_source_writable_keys</a>   (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>);
81
79
<span class="returnvalue">gboolean</span>            <a class="link" href="GrlMetadataSource.html#grl-metadata-source-may-resolve" title="grl_metadata_source_may_resolve ()">grl_metadata_source_may_resolve</a>     (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
82
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
80
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
83
81
                                                         <em class="parameter"><code><a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> key_id</code></em>,
84
82
                                                         <em class="parameter"><code><span class="type">GList</span> **missing_keys</code></em>);
85
83
<span class="returnvalue">guint</span>               <a class="link" href="GrlMetadataSource.html#grl-metadata-source-resolve" title="grl_metadata_source_resolve ()">grl_metadata_source_resolve</a>         (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
86
84
                                                         <em class="parameter"><code>const <span class="type">GList</span> *keys</code></em>,
87
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
85
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
88
86
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataResolutionFlags" title="enum GrlMetadataResolutionFlags"><span class="type">GrlMetadataResolutionFlags</span></a> flags</code></em>,
89
87
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataSourceResolveCb" title="GrlMetadataSourceResolveCb ()"><span class="type">GrlMetadataSourceResolveCb</span></a> callback</code></em>,
90
88
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
91
 
<span class="returnvalue">GrlMedia</span> *          <a class="link" href="GrlMetadataSource.html#grl-metadata-source-resolve-sync" title="grl_metadata_source_resolve_sync ()">grl_metadata_source_resolve_sync</a>    (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
 
89
<a class="link" href="GrlMedia.html" title="GrlMedia"><span class="returnvalue">GrlMedia</span></a> *          <a class="link" href="GrlMetadataSource.html#grl-metadata-source-resolve-sync" title="grl_metadata_source_resolve_sync ()">grl_metadata_source_resolve_sync</a>    (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
92
90
                                                         <em class="parameter"><code>const <span class="type">GList</span> *keys</code></em>,
93
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
91
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
94
92
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataResolutionFlags" title="enum GrlMetadataResolutionFlags"><span class="type">GrlMetadataResolutionFlags</span></a> flags</code></em>,
95
93
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
96
 
<span class="returnvalue">void</span>                <a class="link" href="GrlMetadataSource.html#grl-metadata-source-set-operation-data" title="grl_metadata_source_set_operation_data ()">grl_metadata_source_set_operation_data</a>
97
 
                                                        (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
98
 
                                                         <em class="parameter"><code><span class="type">guint</span> operation_id</code></em>,
99
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
100
94
<span class="returnvalue">void</span>                <a class="link" href="GrlMetadataSource.html#grl-metadata-source-set-metadata" title="grl_metadata_source_set_metadata ()">grl_metadata_source_set_metadata</a>    (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
101
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
95
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
102
96
                                                         <em class="parameter"><code><span class="type">GList</span> *keys</code></em>,
103
97
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataWritingFlags" title="enum GrlMetadataWritingFlags"><span class="type">GrlMetadataWritingFlags</span></a> flags</code></em>,
104
98
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataSourceSetMetadataCb" title="GrlMetadataSourceSetMetadataCb ()"><span class="type">GrlMetadataSourceSetMetadataCb</span></a> callback</code></em>,
105
99
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
106
100
<span class="returnvalue">GList</span> *             <a class="link" href="GrlMetadataSource.html#grl-metadata-source-set-metadata-sync" title="grl_metadata_source_set_metadata_sync ()">grl_metadata_source_set_metadata_sync</a>
107
101
                                                        (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
108
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
102
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
109
103
                                                         <em class="parameter"><code><span class="type">GList</span> *keys</code></em>,
110
104
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataWritingFlags" title="enum GrlMetadataWritingFlags"><span class="type">GrlMetadataWritingFlags</span></a> flags</code></em>,
111
105
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
112
 
<span class="returnvalue">void</span>                <a class="link" href="GrlMetadataSource.html#grl-metadata-source-cancel" title="grl_metadata_source_cancel ()">grl_metadata_source_cancel</a>          (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
113
 
                                                         <em class="parameter"><code><span class="type">guint</span> operation_id</code></em>);
114
106
const <span class="returnvalue">gchar</span> *       <a class="link" href="GrlMetadataSource.html#grl-metadata-source-get-id" title="grl_metadata_source_get_id ()">grl_metadata_source_get_id</a>          (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>);
115
107
const <span class="returnvalue">gchar</span> *       <a class="link" href="GrlMetadataSource.html#grl-metadata-source-get-name" title="grl_metadata_source_get_name ()">grl_metadata_source_get_name</a>        (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>);
116
108
const <span class="returnvalue">gchar</span> *       <a class="link" href="GrlMetadataSource.html#grl-metadata-source-get-description" title="grl_metadata_source_get_description ()">grl_metadata_source_get_description</a> (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>);
141
133
</p>
142
134
<p>
143
135
The metadata sources fetch metadata from different online or local
144
 
databases and store them in the passed <span class="type">GrlMedia</span>.
 
136
databases and store them in the passed <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a>.
145
137
</p>
146
138
<p>
147
139
In opposition to <a class="link" href="GrlMediaSource.html" title="GrlMediaSource"><span class="type">GrlMediaSource</span></a>, <a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> does not create
148
 
new <span class="type">GrlMedia</span> instances, just fill them up with the metadata
 
140
new <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> instances, just fill them up with the metadata
149
141
provided by the specific <a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a>.
150
142
</p>
151
143
<p>
152
144
For example, <span class="type">GrlLastfmAlbumartSource</span> only provides album's covers,
153
 
and they will be used in the <span class="type">GrlMedia</span> generated by another
 
145
and they will be used in the <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> generated by another
154
146
<a class="link" href="GrlMediaSource.html" title="GrlMediaSource"><span class="type">GrlMediaSource</span></a> plugin.
155
147
</p>
156
148
<p>
157
149
The main method is <a class="link" href="GrlMetadataSource.html#grl-metadata-source-resolve" title="grl_metadata_source_resolve ()"><code class="function">grl_metadata_source_resolve()</code></a> which will retrieve
158
 
a list of <a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> requested for the passed <span class="type">GrlMedia</span>.
 
150
a list of <a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> requested for the passed <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a>.
159
151
</p>
160
152
</div>
161
153
<div class="refsect1">
235
227
<a name="GrlMetadataSourceResolveCb"></a><h3>GrlMetadataSourceResolveCb ()</h3>
236
228
<pre class="programlisting"><span class="returnvalue">void</span>                (*GrlMetadataSourceResolveCb)       (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
237
229
                                                         <em class="parameter"><code><span class="type">guint</span> operation_id</code></em>,
238
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
230
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
239
231
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
240
232
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
241
233
<p>
254
246
</tr>
255
247
<tr>
256
248
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
257
 
<td>a <span class="type">GrlMedia</span> transfer object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
249
<td>a <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> transfer object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
258
250
</td>
259
251
</tr>
260
252
<tr>
274
266
<div class="refsect2">
275
267
<a name="GrlMetadataSourceSetMetadataCb"></a><h3>GrlMetadataSourceSetMetadataCb ()</h3>
276
268
<pre class="programlisting"><span class="returnvalue">void</span>                (*GrlMetadataSourceSetMetadataCb)   (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
277
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
269
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
278
270
                                                         <em class="parameter"><code><span class="type">GList</span> *failed_keys</code></em>,
279
271
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
280
272
                                                         <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
290
282
</tr>
291
283
<tr>
292
284
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
293
 
<td>a <span class="type">GrlMedia</span> transfer object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
285
<td>a <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> transfer object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
294
286
</td>
295
287
</tr>
296
288
<tr>
346
338
<td>the <span class="type">GList</span> of <a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> to fetch and store</td>
347
339
</tr>
348
340
<tr>
349
 
<td><p><span class="term"><span class="type">GrlMedia</span> *<em class="structfield"><code><a name="GrlMetadataSourceResolveSpec.media"></a>media</code></em>;</span></p></td>
350
 
<td>a <span class="type">GrlMedia</span> transfer object</td>
 
341
<td><p><span class="term"><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *<em class="structfield"><code><a name="GrlMetadataSourceResolveSpec.media"></a>media</code></em>;</span></p></td>
 
342
<td>a <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> transfer object</td>
351
343
</tr>
352
344
<tr>
353
345
<td><p><span class="term"><a class="link" href="GrlMetadataSource.html#GrlMetadataResolutionFlags" title="enum GrlMetadataResolutionFlags"><span class="type">GrlMetadataResolutionFlags</span></a> <em class="structfield"><code><a name="GrlMetadataSourceResolveSpec.flags"></a>flags</code></em>;</span></p></td>
391
383
<td>a metadata source</td>
392
384
</tr>
393
385
<tr>
394
 
<td><p><span class="term"><span class="type">GrlMedia</span> *<em class="structfield"><code><a name="GrlMetadataSourceSetMetadataSpec.media"></a>media</code></em>;</span></p></td>
395
 
<td>a <span class="type">GrlMedia</span> transfer object</td>
 
386
<td><p><span class="term"><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *<em class="structfield"><code><a name="GrlMetadataSourceSetMetadataSpec.media"></a>media</code></em>;</span></p></td>
 
387
<td>a <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> transfer object</td>
396
388
</tr>
397
389
<tr>
398
390
<td><p><span class="term"><span class="type">GList</span> *<em class="structfield"><code><a name="GrlMetadataSourceSetMetadataSpec.keys"></a>keys</code></em>;</span></p></td>
461
453
</tr>
462
454
<tr>
463
455
<td><p><a name="GRL-OP-BROWSE:CAPS"></a><span class="term"><code class="literal">GRL_OP_BROWSE</code></span></p></td>
464
 
<td>Retrieve complete sets of <span class="type">GrlMedia</span>
 
456
<td>Retrieve complete sets of <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a>
465
457
</td>
466
458
</tr>
467
459
<tr>
468
460
<td><p><a name="GRL-OP-SEARCH:CAPS"></a><span class="term"><code class="literal">GRL_OP_SEARCH</code></span></p></td>
469
 
<td>Look up for <span class="type">GrlMedia</span> given a search text
 
461
<td>Look up for <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> given a search text
470
462
</td>
471
463
</tr>
472
464
<tr>
473
465
<td><p><a name="GRL-OP-QUERY:CAPS"></a><span class="term"><code class="literal">GRL_OP_QUERY</code></span></p></td>
474
 
<td>Look up for <span class="type">GrlMedia</span> give a service specific query
 
466
<td>Look up for <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> give a service specific query
475
467
</td>
476
468
</tr>
477
469
<tr>
491
483
</tr>
492
484
<tr>
493
485
<td><p><a name="GRL-OP-SET-METADATA:CAPS"></a><span class="term"><code class="literal">GRL_OP_SET_METADATA</code></span></p></td>
494
 
<td>Update metadata of a <span class="type">GrlMedia</span> in a service.
 
486
<td>Update metadata of a <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> in a service.
495
487
</td>
496
488
</tr>
497
489
<tr>
498
490
<td><p><a name="GRL-OP-MEDIA-FROM-URI:CAPS"></a><span class="term"><code class="literal">GRL_OP_MEDIA_FROM_URI</code></span></p></td>
499
 
<td>Create a <span class="type">GrlMedia</span> instance from an URI
 
491
<td>Create a <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> instance from an URI
500
492
representing a media resource.
501
493
</td>
502
494
</tr>
791
783
</div>
792
784
<hr>
793
785
<div class="refsect2">
794
 
<a name="grl-metadata-source-key-depends"></a><h3>grl_metadata_source_key_depends ()</h3>
795
 
<pre class="programlisting">const <span class="returnvalue">GList</span> *       grl_metadata_source_key_depends     (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
796
 
                                                         <em class="parameter"><code><a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> key_id</code></em>);</pre>
797
 
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
798
 
<h3 class="title">Warning</h3>
799
 
<p><code class="literal">grl_metadata_source_key_depends</code> has been deprecated since version 0.1.10 and should not be used in newly-written code. use <a class="link" href="GrlMetadataSource.html#grl-metadata-source-may-resolve" title="grl_metadata_source_may_resolve ()"><code class="function">grl_metadata_source_may_resolve()</code></a> instead.</p>
800
 
</div>
801
 
<p>
802
 
Get the list of <a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> which are needed a priori, in order to fetch
803
 
and store the requested <em class="parameter"><code>key_id</code></em>
804
 
</p>
805
 
<div class="variablelist"><table border="0">
806
 
<col align="left" valign="top">
807
 
<tbody>
808
 
<tr>
809
 
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
810
 
<td>a metadata source</td>
811
 
</tr>
812
 
<tr>
813
 
<td><p><span class="term"><em class="parameter"><code>key_id</code></em> :</span></p></td>
814
 
<td>the requested metadata key. <span class="annotation">[<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GObject.ParamSpec]</span>
815
 
</td>
816
 
</tr>
817
 
<tr>
818
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
819
 
<td>a <span class="type">GList</span> with the keys, or <em class="parameter"><code>NULL</code></em> if it can not resolve <em class="parameter"><code>key_id</code></em>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject.ParamSpec][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
820
 
</td>
821
 
</tr>
822
 
</tbody>
823
 
</table></div>
824
 
<p class="since">Since 0.1.1</p>
825
 
</div>
826
 
<hr>
827
 
<div class="refsect2">
828
786
<a name="grl-metadata-source-writable-keys"></a><h3>grl_metadata_source_writable_keys ()</h3>
829
787
<pre class="programlisting">const <span class="returnvalue">GList</span> *       grl_metadata_source_writable_keys   (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>);</pre>
830
788
<p>
831
789
Similar to <a class="link" href="GrlMetadataSource.html#grl-metadata-source-supported-keys" title="grl_metadata_source_supported_keys ()"><code class="function">grl_metadata_source_supported_keys()</code></a>, but these keys
832
 
are marked as writable, meaning the source allows the client 
 
790
are marked as writable, meaning the source allows the client
833
791
to provide new values for these keys that will be stored permanently.
834
792
</p>
835
793
<div class="variablelist"><table border="0">
852
810
<div class="refsect2">
853
811
<a name="grl-metadata-source-may-resolve"></a><h3>grl_metadata_source_may_resolve ()</h3>
854
812
<pre class="programlisting"><span class="returnvalue">gboolean</span>            grl_metadata_source_may_resolve     (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
855
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
813
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
856
814
                                                         <em class="parameter"><code><a class="link" href="grilo-grl-metadata-key.html#GrlKeyID" title="GrlKeyID"><span class="type">GrlKeyID</span></a> key_id</code></em>,
857
815
                                                         <em class="parameter"><code><span class="type">GList</span> **missing_keys</code></em>);</pre>
858
816
<p>
902
860
<a name="grl-metadata-source-resolve"></a><h3>grl_metadata_source_resolve ()</h3>
903
861
<pre class="programlisting"><span class="returnvalue">guint</span>               grl_metadata_source_resolve         (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
904
862
                                                         <em class="parameter"><code>const <span class="type">GList</span> *keys</code></em>,
905
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
863
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
906
864
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataResolutionFlags" title="enum GrlMetadataResolutionFlags"><span class="type">GrlMetadataResolutionFlags</span></a> flags</code></em>,
907
865
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataSourceResolveCb" title="GrlMetadataSourceResolveCb ()"><span class="type">GrlMetadataSourceResolveCb</span></a> callback</code></em>,
908
866
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
956
914
<hr>
957
915
<div class="refsect2">
958
916
<a name="grl-metadata-source-resolve-sync"></a><h3>grl_metadata_source_resolve_sync ()</h3>
959
 
<pre class="programlisting"><span class="returnvalue">GrlMedia</span> *          grl_metadata_source_resolve_sync    (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
 
917
<pre class="programlisting"><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="returnvalue">GrlMedia</span></a> *          grl_metadata_source_resolve_sync    (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
960
918
                                                         <em class="parameter"><code>const <span class="type">GList</span> *keys</code></em>,
961
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
919
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
962
920
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataResolutionFlags" title="enum GrlMetadataResolutionFlags"><span class="type">GrlMetadataResolutionFlags</span></a> flags</code></em>,
963
921
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
964
922
<p>
997
955
</tr>
998
956
<tr>
999
957
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1000
 
<td>the updated <span class="type">GrlMedia</span>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
958
<td>the updated <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1001
959
</td>
1002
960
</tr>
1003
961
</tbody>
1006
964
</div>
1007
965
<hr>
1008
966
<div class="refsect2">
1009
 
<a name="grl-metadata-source-set-operation-data"></a><h3>grl_metadata_source_set_operation_data ()</h3>
1010
 
<pre class="programlisting"><span class="returnvalue">void</span>                grl_metadata_source_set_operation_data
1011
 
                                                        (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
1012
 
                                                         <em class="parameter"><code><span class="type">guint</span> operation_id</code></em>,
1013
 
                                                         <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
1014
 
<p>
1015
 
Attach a pointer to the specific operation.
1016
 
</p>
1017
 
<div class="variablelist"><table border="0">
1018
 
<col align="left" valign="top">
1019
 
<tbody>
1020
 
<tr>
1021
 
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
1022
 
<td>a metadata source</td>
1023
 
</tr>
1024
 
<tr>
1025
 
<td><p><span class="term"><em class="parameter"><code>operation_id</code></em> :</span></p></td>
1026
 
<td>the identifier of a running operation</td>
1027
 
</tr>
1028
 
<tr>
1029
 
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1030
 
<td>the data to attach</td>
1031
 
</tr>
1032
 
</tbody>
1033
 
</table></div>
1034
 
<p class="since">Since 0.1.14</p>
1035
 
</div>
1036
 
<hr>
1037
 
<div class="refsect2">
1038
967
<a name="grl-metadata-source-set-metadata"></a><h3>grl_metadata_source_set_metadata ()</h3>
1039
968
<pre class="programlisting"><span class="returnvalue">void</span>                grl_metadata_source_set_metadata    (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
1040
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
969
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
1041
970
                                                         <em class="parameter"><code><span class="type">GList</span> *keys</code></em>,
1042
971
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataWritingFlags" title="enum GrlMetadataWritingFlags"><span class="type">GrlMetadataWritingFlags</span></a> flags</code></em>,
1043
972
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataSourceSetMetadataCb" title="GrlMetadataSourceSetMetadataCb ()"><span class="type">GrlMetadataSourceSetMetadataCb</span></a> callback</code></em>,
1045
974
<p>
1046
975
This is the main method of the <a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> class. It will
1047
976
get the values for <em class="parameter"><code>keys</code></em> from <em class="parameter"><code>media</code></em> and store it permanently. After
1048
 
calling this method, future queries that return this media object 
 
977
calling this method, future queries that return this media object
1049
978
shall return this new values for the selected keys.
1050
979
</p>
1051
980
<p>
1060
989
</tr>
1061
990
<tr>
1062
991
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
1063
 
<td>the <span class="type">GrlMedia</span> object that we want to operate on.</td>
 
992
<td>the <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> object that we want to operate on.</td>
1064
993
</tr>
1065
994
<tr>
1066
995
<td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td>
1091
1020
<a name="grl-metadata-source-set-metadata-sync"></a><h3>grl_metadata_source_set_metadata_sync ()</h3>
1092
1021
<pre class="programlisting"><span class="returnvalue">GList</span> *             grl_metadata_source_set_metadata_sync
1093
1022
                                                        (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
1094
 
                                                         <em class="parameter"><code><span class="type">GrlMedia</span> *media</code></em>,
 
1023
                                                         <em class="parameter"><code><a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> *media</code></em>,
1095
1024
                                                         <em class="parameter"><code><span class="type">GList</span> *keys</code></em>,
1096
1025
                                                         <em class="parameter"><code><a class="link" href="GrlMetadataSource.html#GrlMetadataWritingFlags" title="enum GrlMetadataWritingFlags"><span class="type">GrlMetadataWritingFlags</span></a> flags</code></em>,
1097
1026
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
1113
1042
</tr>
1114
1043
<tr>
1115
1044
<td><p><span class="term"><em class="parameter"><code>media</code></em> :</span></p></td>
1116
 
<td>the <span class="type">GrlMedia</span> object that we want to operate on</td>
 
1045
<td>the <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a> object that we want to operate on</td>
1117
1046
</tr>
1118
1047
<tr>
1119
1048
<td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td>
1141
1070
</div>
1142
1071
<hr>
1143
1072
<div class="refsect2">
1144
 
<a name="grl-metadata-source-cancel"></a><h3>grl_metadata_source_cancel ()</h3>
1145
 
<pre class="programlisting"><span class="returnvalue">void</span>                grl_metadata_source_cancel          (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>,
1146
 
                                                         <em class="parameter"><code><span class="type">guint</span> operation_id</code></em>);</pre>
1147
 
<p>
1148
 
Cancel a running method.
1149
 
</p>
1150
 
<p>
1151
 
The derived class must implement the cancel vmethod in order to honour the
1152
 
request correctly. Otherwise, the operation will not be interrupted.
1153
 
</p>
1154
 
<p>
1155
 
In all cases, if this function is called on an ongoing operation, the
1156
 
corresponding callback will be called with the
1157
 
<em class="parameter"><code>GRL_CORE_ERROR_OPERATION_CANCELLED</code></em> error set, and no more action will be
1158
 
taken for that operation after the said callback with error has been called.
1159
 
</p>
1160
 
<div class="variablelist"><table border="0">
1161
 
<col align="left" valign="top">
1162
 
<tbody>
1163
 
<tr>
1164
 
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
1165
 
<td>a metadata source</td>
1166
 
</tr>
1167
 
<tr>
1168
 
<td><p><span class="term"><em class="parameter"><code>operation_id</code></em> :</span></p></td>
1169
 
<td>the identifier of the running operation, as returned by the
1170
 
function that started it</td>
1171
 
</tr>
1172
 
</tbody>
1173
 
</table></div>
1174
 
<p class="since">Since 0.1.14</p>
1175
 
</div>
1176
 
<hr>
1177
 
<div class="refsect2">
1178
1073
<a name="grl-metadata-source-get-id"></a><h3>grl_metadata_source_get_id ()</h3>
1179
1074
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       grl_metadata_source_get_id          (<em class="parameter"><code><a class="link" href="GrlMetadataSource.html" title="GrlMetadataSource"><span class="type">GrlMetadataSource</span></a> *source</code></em>);</pre>
1180
1075
<div class="variablelist"><table border="0">
1265
1160
</div>
1266
1161
<div class="refsect1">
1267
1162
<a name="GrlMetadataSource.see-also"></a><h2>See Also</h2>
1268
 
<a class="link" href="GrlMediaPlugin.html" title="GrlMediaPlugin"><span class="type">GrlMediaPlugin</span></a>, <a class="link" href="GrlMediaSource.html" title="GrlMediaSource"><span class="type">GrlMediaSource</span></a>, <span class="type">GrlMedia</span>
 
1163
<a class="link" href="GrlMediaPlugin.html" title="GrlMediaPlugin"><span class="type">GrlMediaPlugin</span></a>, <a class="link" href="GrlMediaSource.html" title="GrlMediaSource"><span class="type">GrlMediaSource</span></a>, <a class="link" href="GrlMedia.html" title="GrlMedia"><span class="type">GrlMedia</span></a>
1269
1164
</div>
1270
1165
</div>
1271
1166
<div class="footer">