← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/rhythmbox/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/html/RBMetaData.html

  • Committer: Bazaar Package Importer
  • Author(s): Rico Tzschichholz
  • Date: 2011-07-29 16:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 191.
  • Revision ID: james.westby@ubuntu.com-20110729164138-wwicy8nqalm18ck7
Tags: upstream-2.90.1~20110802
Import upstream version 2.90.1~20110802

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBMetaData.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>RBMetaData</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
 
8
<link rel="up" href="ch03.html" title="Metadata">
 
9
<link rel="prev" href="ch03.html" title="Metadata">
 
10
<link rel="next" href="ch04.html" title="RhythmDB">
 
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
 
21
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#RBMetaData.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBMetaData.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBMetaData.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry">
 
32
<a name="RBMetaData"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="RBMetaData.top_of_page"></a>RBMetaData</span></h2>
 
36
<p>RBMetaData — metadata reader and writer interface</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv">
 
41
<a name="RBMetaData.synopsis"></a><h2>Synopsis</h2>
 
42
<pre class="synopsis">struct              <a class="link" href="RBMetaData.html#RBMetaData-struct" title="struct RBMetaData">RBMetaData</a>;
 
43
struct              <a class="link" href="RBMetaData.html#RBMetaDataClass" title="struct RBMetaDataClass">RBMetaDataClass</a>;
 
44
enum                <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField">RBMetaDataField</a>;
 
45
enum                <a class="link" href="RBMetaData.html#RBMetaDataError" title="enum RBMetaDataError">RBMetaDataError</a>;
 
46
<a class="link" href="RBMetaData.html" title="RBMetaData"><span class="returnvalue">RBMetaData</span></a> *            <a class="link" href="RBMetaData.html#rb-metadata-new" title="rb_metadata_new ()">rb_metadata_new</a>                     (<em class="parameter"><code><span class="type">void</span></code></em>);
 
47
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               <a class="link" href="RBMetaData.html#rb-metadata-get-field-type" title="rb_metadata_get_field_type ()">rb_metadata_get_field_type</a>          (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);
 
48
const <span class="returnvalue">char</span> *          <a class="link" href="RBMetaData.html#rb-metadata-get-field-name" title="rb_metadata_get_field_name ()">rb_metadata_get_field_name</a>          (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);
 
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBMetaData.html#rb-metadata-can-save" title="rb_metadata_can_save ()">rb_metadata_can_save</a>                (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
50
                                                         <em class="parameter"><code>const <span class="type">char</span> *media_type</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="RBMetaData.html#rb-metadata-load" title="rb_metadata_load ()">rb_metadata_load</a>                    (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
52
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
53
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
54
<span class="returnvalue">void</span>                <a class="link" href="RBMetaData.html#rb-metadata-save" title="rb_metadata_save ()">rb_metadata_save</a>                    (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
55
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
57
const <span class="returnvalue">char</span> *          <a class="link" href="RBMetaData.html#rb-metadata-get-media-type" title="rb_metadata_get_media_type ()">rb_metadata_get_media_type</a>          (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);
 
58
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBMetaData.html#rb-metadata-has-missing-plugins" title="rb_metadata_has_missing_plugins ()">rb_metadata_has_missing_plugins</a>     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);
 
59
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBMetaData.html#rb-metadata-get-missing-plugins" title="rb_metadata_get_missing_plugins ()">rb_metadata_get_missing_plugins</a>     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
60
                                                         <em class="parameter"><code><span class="type">char</span> ***missing_plugins</code></em>,
 
61
                                                         <em class="parameter"><code><span class="type">char</span> ***plugin_descriptions</code></em>);
 
62
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBMetaData.html#rb-metadata-get" title="rb_metadata_get ()">rb_metadata_get</a>                     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
63
                                                         <em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
 
64
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);
 
65
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="RBMetaData.html#rb-metadata-set" title="rb_metadata_set ()">rb_metadata_set</a>                     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
66
                                                         <em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
 
67
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);
 
68
</pre>
 
69
</div>
 
70
<div class="refsect1">
 
71
<a name="RBMetaData.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
72
<pre class="synopsis">
 
73
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
74
   +----RBMetaData
 
75
</pre>
 
76
</div>
 
77
<div class="refsect1">
 
78
<a name="RBMetaData.description"></a><h2>Description</h2>
 
79
<p>
 
80
Provides a simple synchronous interface for metadata extraction and updating.
 
81
</p>
 
82
</div>
 
83
<div class="refsect1">
 
84
<a name="RBMetaData.details"></a><h2>Details</h2>
 
85
<div class="refsect2">
 
86
<a name="RBMetaData-struct"></a><h3>struct RBMetaData</h3>
 
87
<pre class="programlisting">struct RBMetaData;</pre>
 
88
<p>
 
89
</p>
 
90
</div>
 
91
<hr>
 
92
<div class="refsect2">
 
93
<a name="RBMetaDataClass"></a><h3>struct RBMetaDataClass</h3>
 
94
<pre class="programlisting">struct RBMetaDataClass {
 
95
        GObjectClass parent_class;
 
96
};
 
97
</pre>
 
98
<p>
 
99
</p>
 
100
</div>
 
101
<hr>
 
102
<div class="refsect2">
 
103
<a name="RBMetaDataField"></a><h3>enum RBMetaDataField</h3>
 
104
<pre class="programlisting">typedef enum
 
105
{
 
106
        RB_METADATA_FIELD_TITLE,                   /* string */
 
107
        RB_METADATA_FIELD_ARTIST,                  /* string */
 
108
        RB_METADATA_FIELD_ALBUM,                   /* string */
 
109
        RB_METADATA_FIELD_DATE,                    /* ulong */
 
110
        RB_METADATA_FIELD_GENRE,                   /* string */
 
111
        RB_METADATA_FIELD_COMMENT,                 /* string */
 
112
        RB_METADATA_FIELD_TRACK_NUMBER,            /* ulong */
 
113
        RB_METADATA_FIELD_MAX_TRACK_NUMBER,        /* ulong */
 
114
        RB_METADATA_FIELD_DISC_NUMBER,             /* ulong */
 
115
        RB_METADATA_FIELD_MAX_DISC_NUMBER,         /* ulong */
 
116
        RB_METADATA_FIELD_DESCRIPTION,             /* string */
 
117
        RB_METADATA_FIELD_VERSION,                 /* string */
 
118
        RB_METADATA_FIELD_ISRC,                    /* string */
 
119
        RB_METADATA_FIELD_ORGANIZATION,            /* string */
 
120
        RB_METADATA_FIELD_COPYRIGHT,               /* string */
 
121
        RB_METADATA_FIELD_CONTACT,                 /* string */
 
122
        RB_METADATA_FIELD_LICENSE,                 /* string */
 
123
        RB_METADATA_FIELD_PERFORMER,               /* string */
 
124
        RB_METADATA_FIELD_DURATION,                /* ulong */
 
125
        RB_METADATA_FIELD_CODEC,                   /* string */
 
126
        RB_METADATA_FIELD_BITRATE,                 /* ulong */
 
127
        RB_METADATA_FIELD_TRACK_GAIN,              /* double */
 
128
        RB_METADATA_FIELD_TRACK_PEAK,              /* double */
 
129
        RB_METADATA_FIELD_ALBUM_GAIN,              /* double */
 
130
        RB_METADATA_FIELD_ALBUM_PEAK,              /* double */
 
131
        RB_METADATA_FIELD_LANGUAGE_CODE,           /* string */
 
132
        RB_METADATA_FIELD_BPM,                     /* double */
 
133
        RB_METADATA_FIELD_MUSICBRAINZ_TRACKID,     /* string */
 
134
        RB_METADATA_FIELD_MUSICBRAINZ_ARTISTID,    /* string */
 
135
        RB_METADATA_FIELD_MUSICBRAINZ_ALBUMID,     /* string */
 
136
        RB_METADATA_FIELD_MUSICBRAINZ_ALBUMARTISTID,   /* string */
 
137
        RB_METADATA_FIELD_ARTIST_SORTNAME,         /* string */
 
138
        RB_METADATA_FIELD_ALBUM_SORTNAME,          /* string */
 
139
        RB_METADATA_FIELD_ALBUM_ARTIST,            /* string */
 
140
        RB_METADATA_FIELD_ALBUM_ARTIST_SORTNAME,   /* string */
 
141
 
 
142
        RB_METADATA_FIELD_LAST                     /* nothing */
 
143
} RBMetaDataField;
 
144
</pre>
 
145
<p>
 
146
Metadata fields that can be read from and written to files.
 
147
</p>
 
148
<div class="variablelist"><table border="0">
 
149
<col align="left" valign="top">
 
150
<tbody>
 
151
<tr>
 
152
<td><p><a name="RB-METADATA-FIELD-TITLE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TITLE</code></span></p></td>
 
153
<td>Title of the recording
 
154
</td>
 
155
</tr>
 
156
<tr>
 
157
<td><p><a name="RB-METADATA-FIELD-ARTIST:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ARTIST</code></span></p></td>
 
158
<td>Person(s) responsible for the recording
 
159
</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><a name="RB-METADATA-FIELD-ALBUM:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM</code></span></p></td>
 
163
<td>Album containing the recording
 
164
</td>
 
165
</tr>
 
166
<tr>
 
167
<td><p><a name="RB-METADATA-FIELD-DATE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DATE</code></span></p></td>
 
168
<td>Release date of the album
 
169
</td>
 
170
</tr>
 
171
<tr>
 
172
<td><p><a name="RB-METADATA-FIELD-GENRE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_GENRE</code></span></p></td>
 
173
<td>Genre of the recording
 
174
</td>
 
175
</tr>
 
176
<tr>
 
177
<td><p><a name="RB-METADATA-FIELD-COMMENT:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_COMMENT</code></span></p></td>
 
178
<td>Free form comment on the recording
 
179
</td>
 
180
</tr>
 
181
<tr>
 
182
<td><p><a name="RB-METADATA-FIELD-TRACK-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TRACK_NUMBER</code></span></p></td>
 
183
<td>Track number inside a collection
 
184
</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><a name="RB-METADATA-FIELD-MAX-TRACK-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MAX_TRACK_NUMBER</code></span></p></td>
 
188
<td>Count of tracks inside the collection
 
189
</td>
 
190
</tr>
 
191
<tr>
 
192
<td><p><a name="RB-METADATA-FIELD-DISC-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DISC_NUMBER</code></span></p></td>
 
193
<td>Disc number inside a collection
 
194
</td>
 
195
</tr>
 
196
<tr>
 
197
<td><p><a name="RB-METADATA-FIELD-MAX-DISC-NUMBER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MAX_DISC_NUMBER</code></span></p></td>
 
198
<td>Count of discs inside the collection
 
199
</td>
 
200
</tr>
 
201
<tr>
 
202
<td><p><a name="RB-METADATA-FIELD-DESCRIPTION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DESCRIPTION</code></span></p></td>
 
203
<td>Short text describing the recording
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td><p><a name="RB-METADATA-FIELD-VERSION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_VERSION</code></span></p></td>
 
208
<td>Version of the recording
 
209
</td>
 
210
</tr>
 
211
<tr>
 
212
<td><p><a name="RB-METADATA-FIELD-ISRC:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ISRC</code></span></p></td>
 
213
<td>International Standard Recording Code
 
214
</td>
 
215
</tr>
 
216
<tr>
 
217
<td><p><a name="RB-METADATA-FIELD-ORGANIZATION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ORGANIZATION</code></span></p></td>
 
218
<td>Organization responsible for the recording
 
219
</td>
 
220
</tr>
 
221
<tr>
 
222
<td><p><a name="RB-METADATA-FIELD-COPYRIGHT:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_COPYRIGHT</code></span></p></td>
 
223
<td>Copyright notice on the recording
 
224
</td>
 
225
</tr>
 
226
<tr>
 
227
<td><p><a name="RB-METADATA-FIELD-CONTACT:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_CONTACT</code></span></p></td>
 
228
<td>Contact information
 
229
</td>
 
230
</tr>
 
231
<tr>
 
232
<td><p><a name="RB-METADATA-FIELD-LICENSE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_LICENSE</code></span></p></td>
 
233
<td>License of the recording
 
234
</td>
 
235
</tr>
 
236
<tr>
 
237
<td><p><a name="RB-METADATA-FIELD-PERFORMER:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_PERFORMER</code></span></p></td>
 
238
<td>Person(s) performing in the recording
 
239
</td>
 
240
</tr>
 
241
<tr>
 
242
<td><p><a name="RB-METADATA-FIELD-DURATION:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_DURATION</code></span></p></td>
 
243
<td>Duration of the recording
 
244
</td>
 
245
</tr>
 
246
<tr>
 
247
<td><p><a name="RB-METADATA-FIELD-CODEC:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_CODEC</code></span></p></td>
 
248
<td>Codec used to store the recording
 
249
</td>
 
250
</tr>
 
251
<tr>
 
252
<td><p><a name="RB-METADATA-FIELD-BITRATE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_BITRATE</code></span></p></td>
 
253
<td>Exact or average encoding bitrate in bits/s
 
254
</td>
 
255
</tr>
 
256
<tr>
 
257
<td><p><a name="RB-METADATA-FIELD-TRACK-GAIN:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TRACK_GAIN</code></span></p></td>
 
258
<td>Track gain in dB for replaygain
 
259
</td>
 
260
</tr>
 
261
<tr>
 
262
<td><p><a name="RB-METADATA-FIELD-TRACK-PEAK:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_TRACK_PEAK</code></span></p></td>
 
263
<td>Track peak volume level
 
264
</td>
 
265
</tr>
 
266
<tr>
 
267
<td><p><a name="RB-METADATA-FIELD-ALBUM-GAIN:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_GAIN</code></span></p></td>
 
268
<td>Album gain in dB for replaygain
 
269
</td>
 
270
</tr>
 
271
<tr>
 
272
<td><p><a name="RB-METADATA-FIELD-ALBUM-PEAK:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_PEAK</code></span></p></td>
 
273
<td>Album peak volume level
 
274
</td>
 
275
</tr>
 
276
<tr>
 
277
<td><p><a name="RB-METADATA-FIELD-LANGUAGE-CODE:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_LANGUAGE_CODE</code></span></p></td>
 
278
<td>Language code (ISO-639-1)
 
279
</td>
 
280
</tr>
 
281
<tr>
 
282
<td><p><a name="RB-METADATA-FIELD-BPM:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_BPM</code></span></p></td>
 
283
<td>Beats Per Minute
 
284
</td>
 
285
</tr>
 
286
<tr>
 
287
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-TRACKID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_TRACKID</code></span></p></td>
 
288
<td>MusicBrainz track ID
 
289
</td>
 
290
</tr>
 
291
<tr>
 
292
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-ARTISTID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_ARTISTID</code></span></p></td>
 
293
<td>MusicBrainz artist ID
 
294
</td>
 
295
</tr>
 
296
<tr>
 
297
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-ALBUMID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_ALBUMID</code></span></p></td>
 
298
<td>MusicBrainz album ID
 
299
</td>
 
300
</tr>
 
301
<tr>
 
302
<td><p><a name="RB-METADATA-FIELD-MUSICBRAINZ-ALBUMARTISTID:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_MUSICBRAINZ_ALBUMARTISTID</code></span></p></td>
 
303
<td>MusicBrainz album artist ID
 
304
</td>
 
305
</tr>
 
306
<tr>
 
307
<td><p><a name="RB-METADATA-FIELD-ARTIST-SORTNAME:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ARTIST_SORTNAME</code></span></p></td>
 
308
<td>Person(s) responsible for the recording, as used for sorting
 
309
</td>
 
310
</tr>
 
311
<tr>
 
312
<td><p><a name="RB-METADATA-FIELD-ALBUM-SORTNAME:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_SORTNAME</code></span></p></td>
 
313
<td>Album containing the recording, as used for sorting
 
314
</td>
 
315
</tr>
 
316
<tr>
 
317
<td><p><a name="RB-METADATA-FIELD-ALBUM-ARTIST:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_ARTIST</code></span></p></td>
 
318
<td>The artist of the entire album
 
319
</td>
 
320
</tr>
 
321
<tr>
 
322
<td><p><a name="RB-METADATA-FIELD-ALBUM-ARTIST-SORTNAME:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_ALBUM_ARTIST_SORTNAME</code></span></p></td>
 
323
<td>The artist of the entire album, as it should be sorted
 
324
</td>
 
325
</tr>
 
326
<tr>
 
327
<td><p><a name="RB-METADATA-FIELD-LAST:CAPS"></a><span class="term"><code class="literal">RB_METADATA_FIELD_LAST</code></span></p></td>
 
328
<td>invalid field
 
329
</td>
 
330
</tr>
 
331
</tbody>
 
332
</table></div>
 
333
</div>
 
334
<hr>
 
335
<div class="refsect2">
 
336
<a name="RBMetaDataError"></a><h3>enum RBMetaDataError</h3>
 
337
<pre class="programlisting">typedef enum
 
338
{
 
339
        RB_METADATA_ERROR_IO,
 
340
        RB_METADATA_ERROR_MISSING_PLUGIN,
 
341
        RB_METADATA_ERROR_UNRECOGNIZED,
 
342
        RB_METADATA_ERROR_UNSUPPORTED,
 
343
        RB_METADATA_ERROR_GENERAL,
 
344
        RB_METADATA_ERROR_INTERNAL,
 
345
        RB_METADATA_ERROR_EMPTY_FILE
 
346
} RBMetaDataError;
 
347
</pre>
 
348
<p>
 
349
</p>
 
350
</div>
 
351
<hr>
 
352
<div class="refsect2">
 
353
<a name="rb-metadata-new"></a><h3>rb_metadata_new ()</h3>
 
354
<pre class="programlisting"><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="returnvalue">RBMetaData</span></a> *        rb_metadata_new                     (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
355
<p>
 
356
Creates a new metadata backend instance.
 
357
</p>
 
358
<div class="variablelist"><table border="0">
 
359
<col align="left" valign="top">
 
360
<tbody><tr>
 
361
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
362
<td>new <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> instance</td>
 
363
</tr></tbody>
 
364
</table></div>
 
365
</div>
 
366
<hr>
 
367
<div class="refsect2">
 
368
<a name="rb-metadata-get-field-type"></a><h3>rb_metadata_get_field_type ()</h3>
 
369
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>               rb_metadata_get_field_type          (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);</pre>
 
370
<p>
 
371
Returns the <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of the value for a metadata field.
 
372
</p>
 
373
<div class="variablelist"><table border="0">
 
374
<col align="left" valign="top">
 
375
<tbody>
 
376
<tr>
 
377
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
 
378
<td>a <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a>
 
379
</td>
 
380
</tr>
 
381
<tr>
 
382
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
383
<td>value type</td>
 
384
</tr>
 
385
</tbody>
 
386
</table></div>
 
387
</div>
 
388
<hr>
 
389
<div class="refsect2">
 
390
<a name="rb-metadata-get-field-name"></a><h3>rb_metadata_get_field_name ()</h3>
 
391
<pre class="programlisting">const <span class="returnvalue">char</span> *              rb_metadata_get_field_name          (<em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>);</pre>
 
392
<p>
 
393
Returns the name of a metadata field.
 
394
</p>
 
395
<div class="variablelist"><table border="0">
 
396
<col align="left" valign="top">
 
397
<tbody>
 
398
<tr>
 
399
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
 
400
<td>a <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a>
 
401
</td>
 
402
</tr>
 
403
<tr>
 
404
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
405
<td>field name</td>
 
406
</tr>
 
407
</tbody>
 
408
</table></div>
 
409
</div>
 
410
<hr>
 
411
<div class="refsect2">
 
412
<a name="rb-metadata-can-save"></a><h3>rb_metadata_can_save ()</h3>
 
413
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_metadata_can_save                (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
414
                                                         <em class="parameter"><code>const <span class="type">char</span> *media_type</code></em>);</pre>
 
415
<p>
 
416
Checks if the metadata writer is capable of updating file metadata
 
417
for a given media type.
 
418
</p>
 
419
<div class="variablelist"><table border="0">
 
420
<col align="left" valign="top">
 
421
<tbody>
 
422
<tr>
 
423
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
424
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
425
</td>
 
426
</tr>
 
427
<tr>
 
428
<td><p><span class="term"><em class="parameter"><code>media_type</code></em> :</span></p></td>
 
429
<td>the media type string to check</td>
 
430
</tr>
 
431
<tr>
 
432
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
433
<td>TRUE if the file metadata for the given media type can be updated</td>
 
434
</tr>
 
435
</tbody>
 
436
</table></div>
 
437
</div>
 
438
<hr>
 
439
<div class="refsect2">
 
440
<a name="rb-metadata-load"></a><h3>rb_metadata_load ()</h3>
 
441
<pre class="programlisting"><span class="returnvalue">void</span>                rb_metadata_load                    (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
442
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
443
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
444
<p>
 
445
Reads metadata information from the specified URI.
 
446
Once this has returned successfully (with *error == NULL),
 
447
rb_metadata_get, rb_metadata_get_media_type, rb_metadata_has_missing_plugins,
 
448
and rb_metadata_get_missing_plugins can usefully be called.
 
449
</p>
 
450
<div class="variablelist"><table border="0">
 
451
<col align="left" valign="top">
 
452
<tbody>
 
453
<tr>
 
454
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
455
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
456
</td>
 
457
</tr>
 
458
<tr>
 
459
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
 
460
<td>URI from which to load metadata</td>
 
461
</tr>
 
462
<tr>
 
463
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
464
<td>returns error information</td>
 
465
</tr>
 
466
</tbody>
 
467
</table></div>
 
468
</div>
 
469
<hr>
 
470
<div class="refsect2">
 
471
<a name="rb-metadata-save"></a><h3>rb_metadata_save ()</h3>
 
472
<pre class="programlisting"><span class="returnvalue">void</span>                rb_metadata_save                    (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
473
                                                         <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
 
474
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
475
<p>
 
476
Saves all metadata changes made with rb_metadata_set to the
 
477
target URI.
 
478
</p>
 
479
<div class="variablelist"><table border="0">
 
480
<col align="left" valign="top">
 
481
<tbody>
 
482
<tr>
 
483
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
484
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
485
</td>
 
486
</tr>
 
487
<tr>
 
488
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
 
489
<td>the target URI</td>
 
490
</tr>
 
491
<tr>
 
492
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
493
<td>returns error information</td>
 
494
</tr>
 
495
</tbody>
 
496
</table></div>
 
497
</div>
 
498
<hr>
 
499
<div class="refsect2">
 
500
<a name="rb-metadata-get-media-type"></a><h3>rb_metadata_get_media_type ()</h3>
 
501
<pre class="programlisting">const <span class="returnvalue">char</span> *              rb_metadata_get_media_type          (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);</pre>
 
502
<p>
 
503
Returns the type of the file from which metadata was read.
 
504
This may look like a MIME type, but it isn't.
 
505
</p>
 
506
<div class="variablelist"><table border="0">
 
507
<col align="left" valign="top">
 
508
<tbody>
 
509
<tr>
 
510
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
511
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
512
</td>
 
513
</tr>
 
514
<tr>
 
515
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
516
<td>media type string</td>
 
517
</tr>
 
518
</tbody>
 
519
</table></div>
 
520
</div>
 
521
<hr>
 
522
<div class="refsect2">
 
523
<a name="rb-metadata-has-missing-plugins"></a><h3>rb_metadata_has_missing_plugins ()</h3>
 
524
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_metadata_has_missing_plugins     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>);</pre>
 
525
<p>
 
526
If the metadata reader could not decode the file it was asked to
 
527
because one or more media framework plugins (specifically, for the
 
528
existing implementations, GStreamer plugins) required are missing,
 
529
this will return TRUE.
 
530
</p>
 
531
<div class="variablelist"><table border="0">
 
532
<col align="left" valign="top">
 
533
<tbody>
 
534
<tr>
 
535
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
536
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
537
</td>
 
538
</tr>
 
539
<tr>
 
540
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
541
<td>TRUE if required plugins are missing</td>
 
542
</tr>
 
543
</tbody>
 
544
</table></div>
 
545
</div>
 
546
<hr>
 
547
<div class="refsect2">
 
548
<a name="rb-metadata-get-missing-plugins"></a><h3>rb_metadata_get_missing_plugins ()</h3>
 
549
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_metadata_get_missing_plugins     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
550
                                                         <em class="parameter"><code><span class="type">char</span> ***missing_plugins</code></em>,
 
551
                                                         <em class="parameter"><code><span class="type">char</span> ***plugin_descriptions</code></em>);</pre>
 
552
<p>
 
553
This function returns the information used to request automatic
 
554
installation of media framework plugins required to decode the target URI.
 
555
Use <a href="http://library.gnome.org/devel/glib/unstable/glib-String-Utility-Functions.html#g-strfreev"><code class="function">g_strfreev()</code></a> to free the returned information arrays.
 
556
</p>
 
557
<div class="variablelist"><table border="0">
 
558
<col align="left" valign="top">
 
559
<tbody>
 
560
<tr>
 
561
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
562
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
563
</td>
 
564
</tr>
 
565
<tr>
 
566
<td><p><span class="term"><em class="parameter"><code>missing_plugins</code></em> :</span></p></td>
 
567
<td>returns machine-readable
 
568
missing plugin information. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span>
 
569
</td>
 
570
</tr>
 
571
<tr>
 
572
<td><p><span class="term"><em class="parameter"><code>plugin_descriptions</code></em> :</span></p></td>
 
573
<td>returns human-readable
 
574
missing plugin descriptions. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/array"><span class="acronym">array</span></a> zero-terminated=1]</span>
 
575
</td>
 
576
</tr>
 
577
<tr>
 
578
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
579
<td>TRUE if missing plugin information was returned</td>
 
580
</tr>
 
581
</tbody>
 
582
</table></div>
 
583
</div>
 
584
<hr>
 
585
<div class="refsect2">
 
586
<a name="rb-metadata-get"></a><h3>rb_metadata_get ()</h3>
 
587
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_metadata_get                     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
588
                                                         <em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
 
589
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);</pre>
 
590
<p>
 
591
Retrieves the value of a metadata field extracted from the target URI.
 
592
If the target URI contained no value for the field, returns FALSE.
 
593
</p>
 
594
<div class="variablelist"><table border="0">
 
595
<col align="left" valign="top">
 
596
<tbody>
 
597
<tr>
 
598
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
599
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
600
</td>
 
601
</tr>
 
602
<tr>
 
603
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
 
604
<td>the <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> to retrieve</td>
 
605
</tr>
 
606
<tr>
 
607
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 
608
<td>returns the field value. <span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a> caller-allocates][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
 
609
</td>
 
610
</tr>
 
611
<tr>
 
612
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
613
<td>TRUE if a value was returned</td>
 
614
</tr>
 
615
</tbody>
 
616
</table></div>
 
617
</div>
 
618
<hr>
 
619
<div class="refsect2">
 
620
<a name="rb-metadata-set"></a><h3>rb_metadata_set ()</h3>
 
621
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            rb_metadata_set                     (<em class="parameter"><code><a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> *md</code></em>,
 
622
                                                         <em class="parameter"><code><a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> field</code></em>,
 
623
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *val</code></em>);</pre>
 
624
<p>
 
625
Sets a metadata field value.  The value is only stored inside the
 
626
<a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a> object until rb_metadata_save is called.
 
627
</p>
 
628
<div class="variablelist"><table border="0">
 
629
<col align="left" valign="top">
 
630
<tbody>
 
631
<tr>
 
632
<td><p><span class="term"><em class="parameter"><code>md</code></em> :</span></p></td>
 
633
<td>a <a class="link" href="RBMetaData.html" title="RBMetaData"><span class="type">RBMetaData</span></a>
 
634
</td>
 
635
</tr>
 
636
<tr>
 
637
<td><p><span class="term"><em class="parameter"><code>field</code></em> :</span></p></td>
 
638
<td>the <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> to set</td>
 
639
</tr>
 
640
<tr>
 
641
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
 
642
<td>the value to set</td>
 
643
</tr>
 
644
<tr>
 
645
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
646
<td>TRUE if the field is valid</td>
 
647
</tr>
 
648
</tbody>
 
649
</table></div>
 
650
</div>
 
651
</div>
 
652
</div>
 
653
<div class="footer">
 
654
<hr>
 
655
          Generated by GTK-Doc V1.17</div>
 
656
</body>
 
657
</html>
 
 
b'\\ No newline at end of file'