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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="RBMetaData">
<refmeta>
<refentrytitle role="top_of_page" id="RBMetaData.top_of_page">rb-metadata</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-metadata</refname>
<refpurpose>metadata reader and writer interface</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBMetaData.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBMetaData-struct">RBMetaData</link>;
<link linkend="RBMetaDataClass">RBMetaDataClass</link>;
enum <link linkend="RBMetaDataField">RBMetaDataField</link>;
enum <link linkend="RBMetaDataError">RBMetaDataError</link>;
<link linkend="RBMetaData">RBMetaData</link>* <link linkend="rb-metadata-new">rb_metadata_new</link> (void);
<link linkend="GType">GType</link> <link linkend="rb-metadata-get-field-type">rb_metadata_get_field_type</link> (<link linkend="RBMetaDataField">RBMetaDataField</link> field);
const <link linkend="char">char</link>* <link linkend="rb-metadata-get-field-name">rb_metadata_get_field_name</link> (<link linkend="RBMetaDataField">RBMetaDataField</link> field);
<link linkend="gboolean">gboolean</link> <link linkend="rb-metadata-can-save">rb_metadata_can_save</link> (<link linkend="RBMetaData">RBMetaData</link> *md,
const <link linkend="char">char</link> *mimetype);
<link linkend="void">void</link> <link linkend="rb-metadata-load">rb_metadata_load</link> (<link linkend="RBMetaData">RBMetaData</link> *md,
const <link linkend="char">char</link> *uri,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="rb-metadata-save">rb_metadata_save</link> (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="GError">GError</link> **error);
const <link linkend="char">char</link>* <link linkend="rb-metadata-get-mime">rb_metadata_get_mime</link> (<link linkend="RBMetaData">RBMetaData</link> *md);
<link linkend="gboolean">gboolean</link> <link linkend="rb-metadata-has-missing-plugins">rb_metadata_has_missing_plugins</link> (<link linkend="RBMetaData">RBMetaData</link> *md);
<link linkend="gboolean">gboolean</link> <link linkend="rb-metadata-get-missing-plugins">rb_metadata_get_missing_plugins</link> (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="char">char</link> ***missing_plugins,
<link linkend="char">char</link> ***plugin_descriptions);
<link linkend="gboolean">gboolean</link> <link linkend="rb-metadata-get">rb_metadata_get</link> (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="RBMetaDataField">RBMetaDataField</link> field,
<link linkend="GValue">GValue</link> *val);
<link linkend="gboolean">gboolean</link> <link linkend="rb-metadata-set">rb_metadata_set</link> (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="RBMetaDataField">RBMetaDataField</link> field,
const <link linkend="GValue">GValue</link> *val);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBMetaData.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----RBMetaData
</synopsis>
</refsect1>
<refsect1 id="RBMetaData.description" role="desc">
<title role="desc.title">Description</title>
<para>
Provides a simple synchronous interface for metadata extraction and updating.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBMetaData.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBMetaData-struct" role="struct">
<title>RBMetaData</title>
<indexterm zone="RBMetaData-struct"><primary>RBMetaData</primary></indexterm><programlisting>typedef struct _RBMetaData RBMetaData;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBMetaDataClass" role="struct">
<title>RBMetaDataClass</title>
<indexterm zone="RBMetaDataClass"><primary>RBMetaDataClass</primary></indexterm><programlisting>typedef struct {
GObjectClass parent_class;
} RBMetaDataClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBMetaDataField" role="enum">
<title>enum RBMetaDataField</title>
<indexterm zone="RBMetaDataField"><primary>RBMetaDataField</primary></indexterm><programlisting>typedef enum
{
RB_METADATA_FIELD_TITLE, /* string */
RB_METADATA_FIELD_ARTIST, /* string */
RB_METADATA_FIELD_ALBUM, /* string */
RB_METADATA_FIELD_DATE, /* ulong */
RB_METADATA_FIELD_GENRE, /* string */
RB_METADATA_FIELD_COMMENT, /* string */
RB_METADATA_FIELD_TRACK_NUMBER, /* ulong */
RB_METADATA_FIELD_MAX_TRACK_NUMBER, /* ulong */
RB_METADATA_FIELD_DISC_NUMBER, /* ulong */
RB_METADATA_FIELD_MAX_DISC_NUMBER, /* ulong */
RB_METADATA_FIELD_DESCRIPTION, /* string */
RB_METADATA_FIELD_VERSION, /* string */
RB_METADATA_FIELD_ISRC, /* string */
RB_METADATA_FIELD_ORGANIZATION, /* string */
RB_METADATA_FIELD_COPYRIGHT, /* string */
RB_METADATA_FIELD_CONTACT, /* string */
RB_METADATA_FIELD_LICENSE, /* string */
RB_METADATA_FIELD_PERFORMER, /* string */
RB_METADATA_FIELD_DURATION, /* ulong */
RB_METADATA_FIELD_CODEC, /* string */
RB_METADATA_FIELD_BITRATE, /* ulong */
RB_METADATA_FIELD_TRACK_GAIN, /* double */
RB_METADATA_FIELD_TRACK_PEAK, /* double */
RB_METADATA_FIELD_ALBUM_GAIN, /* double */
RB_METADATA_FIELD_ALBUM_PEAK, /* double */
RB_METADATA_FIELD_LANGUAGE_CODE, /* string */
RB_METADATA_FIELD_MUSICBRAINZ_TRACKID, /* string */
RB_METADATA_FIELD_MUSICBRAINZ_ARTISTID, /* string */
RB_METADATA_FIELD_MUSICBRAINZ_ALBUMID, /* string */
RB_METADATA_FIELD_MUSICBRAINZ_ALBUMARTISTID, /* string */
RB_METADATA_FIELD_ARTIST_SORTNAME, /* string */
RB_METADATA_FIELD_LAST /* nothing */
} RBMetaDataField;
</programlisting>
<para>
Metadata fields that can be read from and written to files.</para>
<para>
</para><variablelist role="enum">
<varlistentry id="RB-METADATA-FIELD-TITLE:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_TITLE</literal></term>
<listitem><simpara> Title of the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-ARTIST:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_ARTIST</literal></term>
<listitem><simpara> Person(s) responsible for the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-ALBUM:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_ALBUM</literal></term>
<listitem><simpara> Album containing the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-DATE:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_DATE</literal></term>
<listitem><simpara> Release date of the album
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-GENRE:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_GENRE</literal></term>
<listitem><simpara> Genre of the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-COMMENT:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_COMMENT</literal></term>
<listitem><simpara> Free form comment on the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-TRACK-NUMBER:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_TRACK_NUMBER</literal></term>
<listitem><simpara> Track number inside a collection
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-MAX-TRACK-NUMBER:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_MAX_TRACK_NUMBER</literal></term>
<listitem><simpara> Count of tracks inside the collection
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-DISC-NUMBER:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_DISC_NUMBER</literal></term>
<listitem><simpara> Disc number inside a collection
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-MAX-DISC-NUMBER:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_MAX_DISC_NUMBER</literal></term>
<listitem><simpara> Count of discs inside the collection
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-DESCRIPTION:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_DESCRIPTION</literal></term>
<listitem><simpara> Short text describing the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-VERSION:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_VERSION</literal></term>
<listitem><simpara> Version of the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-ISRC:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_ISRC</literal></term>
<listitem><simpara> International Standard Recording Code
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-ORGANIZATION:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_ORGANIZATION</literal></term>
<listitem><simpara> Organization responsible for the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-COPYRIGHT:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_COPYRIGHT</literal></term>
<listitem><simpara> Copyright notice on the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-CONTACT:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_CONTACT</literal></term>
<listitem><simpara> Contact information
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-LICENSE:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_LICENSE</literal></term>
<listitem><simpara> License of the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-PERFORMER:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_PERFORMER</literal></term>
<listitem><simpara> Person(s) performing in the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-DURATION:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_DURATION</literal></term>
<listitem><simpara> Duration of the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-CODEC:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_CODEC</literal></term>
<listitem><simpara> Codec used to store the recording
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-BITRATE:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_BITRATE</literal></term>
<listitem><simpara> Exact or average encoding bitrate in bits/s
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-TRACK-GAIN:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_TRACK_GAIN</literal></term>
<listitem><simpara> Track gain in dB for replaygain
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-TRACK-PEAK:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_TRACK_PEAK</literal></term>
<listitem><simpara> Track peak volume level
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-ALBUM-GAIN:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_ALBUM_GAIN</literal></term>
<listitem><simpara> Album gain in dB for replaygain
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-ALBUM-PEAK:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_ALBUM_PEAK</literal></term>
<listitem><simpara> Album peak volume level
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-LANGUAGE-CODE:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_LANGUAGE_CODE</literal></term>
<listitem><simpara> Language code (ISO-639-1)
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-MUSICBRAINZ-TRACKID:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_MUSICBRAINZ_TRACKID</literal></term>
<listitem><simpara> MusicBrainz track ID
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-MUSICBRAINZ-ARTISTID:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_MUSICBRAINZ_ARTISTID</literal></term>
<listitem><simpara> MusicBrainz artist ID
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-MUSICBRAINZ-ALBUMID:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_MUSICBRAINZ_ALBUMID</literal></term>
<listitem><simpara> MusicBrainz album ID
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-MUSICBRAINZ-ALBUMARTISTID:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_MUSICBRAINZ_ALBUMARTISTID</literal></term>
<listitem><simpara> MusicBrainz album artist ID
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-ARTIST-SORTNAME:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_ARTIST_SORTNAME</literal></term>
<listitem><simpara> Person(s) responsible for the recording, as used for sorting
</simpara></listitem>
</varlistentry>
<varlistentry id="RB-METADATA-FIELD-LAST:CAPS" role="constant">
<term><literal>RB_METADATA_FIELD_LAST</literal></term>
<listitem><simpara> invalid field
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="RBMetaDataError" role="enum">
<title>enum RBMetaDataError</title>
<indexterm zone="RBMetaDataError"><primary>RBMetaDataError</primary></indexterm><programlisting>typedef enum
{
RB_METADATA_ERROR_GNOMEVFS,
RB_METADATA_ERROR_MISSING_PLUGIN,
RB_METADATA_ERROR_UNRECOGNIZED,
RB_METADATA_ERROR_UNSUPPORTED,
RB_METADATA_ERROR_GENERAL,
RB_METADATA_ERROR_INTERNAL,
RB_METADATA_ERROR_NOT_AUDIO,
RB_METADATA_ERROR_NOT_AUDIO_IGNORE,
RB_METADATA_ERROR_EMPTY_FILE
} RBMetaDataError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-metadata-new" role="function">
<title>rb_metadata_new ()</title>
<indexterm zone="rb-metadata-new"><primary>rb_metadata_new</primary></indexterm><programlisting><link linkend="RBMetaData">RBMetaData</link>* rb_metadata_new (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> new <link linkend="RBMetaData"><type>RBMetaData</type></link> instance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-get-field-type" role="function">
<title>rb_metadata_get_field_type ()</title>
<indexterm zone="rb-metadata-get-field-type"><primary>rb_metadata_get_field_type</primary></indexterm><programlisting><link linkend="GType">GType</link> rb_metadata_get_field_type (<link linkend="RBMetaDataField">RBMetaDataField</link> field);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaDataField"><type>RBMetaDataField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GType"><type>GType</type></link> of the value for the metadata field
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-get-field-name" role="function">
<title>rb_metadata_get_field_name ()</title>
<indexterm zone="rb-metadata-get-field-name"><primary>rb_metadata_get_field_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* rb_metadata_get_field_name (<link linkend="RBMetaDataField">RBMetaDataField</link> field);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>field</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaDataField"><type>RBMetaDataField</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the name of the metadata field
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-can-save" role="function">
<title>rb_metadata_can_save ()</title>
<indexterm zone="rb-metadata-can-save"><primary>rb_metadata_can_save</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_metadata_can_save (<link linkend="RBMetaData">RBMetaData</link> *md,
const <link linkend="char">char</link> *mimetype);</programlisting>
<para>
Checks if the metadata writer is capable of updating file metadata
for a given media type.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mimetype</parameter> :</term>
<listitem><simpara> the MIME type-ish string to check
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the file metadata for the given media type can be updated
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-load" role="function">
<title>rb_metadata_load ()</title>
<indexterm zone="rb-metadata-load"><primary>rb_metadata_load</primary></indexterm><programlisting><link linkend="void">void</link> rb_metadata_load (<link linkend="RBMetaData">RBMetaData</link> *md,
const <link linkend="char">char</link> *uri,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Reads metadata information from the specified URI.
Once this has returned successfully (with *error == NULL),
rb_metadata_get, rb_metadata_get_mime, rb_metadata_has_missing_plugins,
and rb_metadata_get_missing_plugins can usefully be called.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> URI from which to load metadata
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-save" role="function">
<title>rb_metadata_save ()</title>
<indexterm zone="rb-metadata-save"><primary>rb_metadata_save</primary></indexterm><programlisting><link linkend="void">void</link> rb_metadata_save (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Saves all metadata changes made with rb_metadata_set to the
target URI.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-get-mime" role="function">
<title>rb_metadata_get_mime ()</title>
<indexterm zone="rb-metadata-get-mime"><primary>rb_metadata_get_mime</primary></indexterm><programlisting>const <link linkend="char">char</link>* rb_metadata_get_mime (<link linkend="RBMetaData">RBMetaData</link> *md);</programlisting>
<para>
Returns the type of the file from which metadata was read.
This isn't really a MIME type, but it looks like one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> MIME type-ish string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-has-missing-plugins" role="function">
<title>rb_metadata_has_missing_plugins ()</title>
<indexterm zone="rb-metadata-has-missing-plugins"><primary>rb_metadata_has_missing_plugins</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_metadata_has_missing_plugins (<link linkend="RBMetaData">RBMetaData</link> *md);</programlisting>
<para>
If the metadata reader could not decode the file it was asked to
because one or more media framework plugins (specifically, for the
existing implementations, GStreamer plugins) required are missing,
this will return TRUE.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if required plugins are missing
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-get-missing-plugins" role="function">
<title>rb_metadata_get_missing_plugins ()</title>
<indexterm zone="rb-metadata-get-missing-plugins"><primary>rb_metadata_get_missing_plugins</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_metadata_get_missing_plugins (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="char">char</link> ***missing_plugins,
<link linkend="char">char</link> ***plugin_descriptions);</programlisting>
<para>
This function returns the information used to request automatic
installation of media framework plugins required to decode the target URI.
Use <link linkend="g-strfreev"><function>g_strfreev()</function></link> to free the returned information arrays.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>missing_plugins</parameter> :</term>
<listitem><simpara> returns machine-readable missing plugin information
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>plugin_descriptions</parameter> :</term>
<listitem><simpara> returns human-readable missing plugin descriptions
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if missing plugin information was returned
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-get" role="function">
<title>rb_metadata_get ()</title>
<indexterm zone="rb-metadata-get"><primary>rb_metadata_get</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_metadata_get (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="RBMetaDataField">RBMetaDataField</link> field,
<link linkend="GValue">GValue</link> *val);</programlisting>
<para>
Retrieves the value of a metadata field extracted from the target URI.
If the target URI contained no value for the field, returns FALSE.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>field</parameter> :</term>
<listitem><simpara> the <link linkend="RBMetaDataField"><type>RBMetaDataField</type></link> to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter> :</term>
<listitem><simpara> returns the field value
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if a value was returned
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-metadata-set" role="function">
<title>rb_metadata_set ()</title>
<indexterm zone="rb-metadata-set"><primary>rb_metadata_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_metadata_set (<link linkend="RBMetaData">RBMetaData</link> *md,
<link linkend="RBMetaDataField">RBMetaDataField</link> field,
const <link linkend="GValue">GValue</link> *val);</programlisting>
<para>
Sets a metadata field value. The value is only stored inside the
<link linkend="RBMetaData"><type>RBMetaData</type></link> object until rb_metadata_save is called.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>md</parameter> :</term>
<listitem><simpara> a <link linkend="RBMetaData"><type>RBMetaData</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>field</parameter> :</term>
<listitem><simpara> the <link linkend="RBMetaDataField"><type>RBMetaDataField</type></link> to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val</parameter> :</term>
<listitem><simpara> the vaule to set
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the field is valid
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
