← Back to branch summary

~ubuntu-branches/ubuntu/utopic/rhythmbox/utopic-proposed

« back to all changes in this revision

Viewing changes to doc/reference/html/rhythmbox-rb-metadata.html

Tags: upstream-0.9.2
Import upstream version 0.9.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/rhythmbox-rb-metadata.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>rb-metadata</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="Rhythmbox Development Reference Manual">
 
7
<link rel="up" href="ch03.html" title="Metadata">
 
8
<link rel="prev" href="ch03.html" title="Metadata">
 
9
<link rel="next" href="ch04.html" title="Player">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="chapter" href="ch01.html" title="IRadio UI">
 
13
<link rel="chapter" href="ch02.html" title="Lib">
 
14
<link rel="chapter" href="ch03.html" title="Metadata">
 
15
<link rel="chapter" href="ch04.html" title="Player">
 
16
<link rel="chapter" href="ch05.html" title="RhythmDB">
 
17
<link rel="chapter" href="ch06.html" title="Shell">
 
18
<link rel="chapter" href="ch07.html" title="Sources">
 
19
<link rel="chapter" href="ch08.html" title="Widgets">
 
20
</head>
 
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
22
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
23
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
26
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
 
27
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
28
</tr></table>
 
29
<div class="refentry" lang="en">
 
30
<a name="rhythmbox-rb-metadata"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle">rb-metadata</span></h2>
 
34
<p>rb-metadata &#8212; </p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
 
 
42
 
 
43
 
 
44
#define     <a href="rhythmbox-rb-metadata.html#RB-METADATA-NUM-FIELDS:CAPS">RB_METADATA_NUM_FIELDS</a>
 
45
enum        <a href="rhythmbox-rb-metadata.html#RBMetaDataField">RBMetaDataField</a>;
 
46
enum        <a href="rhythmbox-rb-metadata.html#RBMetaDataError">RBMetaDataError</a>;
 
47
#define     <a href="rhythmbox-rb-metadata.html#RB-METADATA-ERROR:CAPS">RB_METADATA_ERROR</a>
 
48
GQuark      <a href="rhythmbox-rb-metadata.html#rb-metadata-error-quark">rb_metadata_error_quark</a>         (void);
 
49
typedef     <a href="rhythmbox-rb-metadata.html#RBMetaDataPrivate">RBMetaDataPrivate</a>;
 
50
RBMetaData* <a href="rhythmbox-rb-metadata.html#rb-metadata-new">rb_metadata_new</a>                 (void);
 
51
GType       <a href="rhythmbox-rb-metadata.html#rb-metadata-get-field-type">rb_metadata_get_field_type</a>      (RBMetaData *md,
 
52
                                             <a href="rhythmbox-rb-metadata.html#RBMetaDataField">RBMetaDataField</a> field);
 
53
gboolean    <a href="rhythmbox-rb-metadata.html#rb-metadata-can-save">rb_metadata_can_save</a>            (RBMetaData *md,
 
54
                                             const char *mimetype);
 
55
void        <a href="rhythmbox-rb-metadata.html#rb-metadata-load">rb_metadata_load</a>                (RBMetaData *md,
 
56
                                             const char *uri,
 
57
                                             GError **error);
 
58
void        <a href="rhythmbox-rb-metadata.html#rb-metadata-save">rb_metadata_save</a>                (RBMetaData *md,
 
59
                                             GError **error);
 
60
const char* <a href="rhythmbox-rb-metadata.html#rb-metadata-get-mime">rb_metadata_get_mime</a>            (RBMetaData *md);
 
61
gboolean    <a href="rhythmbox-rb-metadata.html#rb-metadata-get">rb_metadata_get</a>                 (RBMetaData *md,
 
62
                                             <a href="rhythmbox-rb-metadata.html#RBMetaDataField">RBMetaDataField</a> field,
 
63
                                             GValue *val);
 
64
gboolean    <a href="rhythmbox-rb-metadata.html#rb-metadata-set">rb_metadata_set</a>                 (RBMetaData *md,
 
65
                                             <a href="rhythmbox-rb-metadata.html#RBMetaDataField">RBMetaDataField</a> field,
 
66
                                             const GValue *val);
 
67
 
 
68
</pre>
 
69
</div>
 
70
<div class="refsect1" lang="en">
 
71
<a name="id2518756"></a><h2>Description</h2>
 
72
<p>
 
73
 
 
74
</p>
 
75
</div>
 
76
<div class="refsect1" lang="en">
 
77
<a name="id2518768"></a><h2>Details</h2>
 
78
<div class="refsect2" lang="en">
 
79
<a name="id2518774"></a><h3>
 
80
<a name="RB-METADATA-NUM-FIELDS:CAPS"></a>RB_METADATA_NUM_FIELDS</h3>
 
81
<a class="indexterm" name="id2518783"></a><pre class="programlisting">#define RB_METADATA_NUM_FIELDS 23
 
82
</pre>
 
83
<p>
 
84
 
 
85
</p>
 
86
</div>
 
87
<hr>
 
88
<div class="refsect2" lang="en">
 
89
<a name="id2518798"></a><h3>
 
90
<a name="RBMetaDataField"></a>enum RBMetaDataField</h3>
 
91
<a class="indexterm" name="id2518808"></a><pre class="programlisting">typedef enum
 
92
{
 
93
        RB_METADATA_FIELD_TITLE,                   /* string */
 
94
        RB_METADATA_FIELD_ARTIST,                  /* string */
 
95
        RB_METADATA_FIELD_ALBUM,                   /* string */
 
96
        RB_METADATA_FIELD_DATE,                    /* string */
 
97
        RB_METADATA_FIELD_GENRE,                   /* string */
 
98
        RB_METADATA_FIELD_COMMENT,                 /* string */
 
99
        RB_METADATA_FIELD_TRACK_NUMBER,            /* ulong */
 
100
        RB_METADATA_FIELD_MAX_TRACK_NUMBER,        /* ulong */
 
101
        RB_METADATA_FIELD_DISC_NUMBER,             /* ulong */
 
102
        RB_METADATA_FIELD_MAX_DISC_NUMBER,         /* ulong */
 
103
        RB_METADATA_FIELD_DESCRIPTION,             /* string */
 
104
        RB_METADATA_FIELD_VERSION,                 /* string */
 
105
        RB_METADATA_FIELD_ISRC,                    /* string */
 
106
        RB_METADATA_FIELD_ORGANIZATION,            /* string */
 
107
        RB_METADATA_FIELD_COPYRIGHT,               /* string */
 
108
        RB_METADATA_FIELD_CONTACT,                 /* string */
 
109
        RB_METADATA_FIELD_LICENSE,                 /* string */
 
110
        RB_METADATA_FIELD_PERFORMER,               /* string */
 
111
        RB_METADATA_FIELD_DURATION,                /* ulong */
 
112
        RB_METADATA_FIELD_CODEC,                   /* string */
 
113
        RB_METADATA_FIELD_BITRATE,                 /* ulong */
 
114
        RB_METADATA_FIELD_TRACK_GAIN,              /* double */
 
115
        RB_METADATA_FIELD_TRACK_PEAK,              /* double */
 
116
        RB_METADATA_FIELD_ALBUM_GAIN,              /* double */
 
117
        RB_METADATA_FIELD_ALBUM_PEAK,              /* double */
 
118
} RBMetaDataField;
 
119
</pre>
 
120
<p>
 
121
 
 
122
</p>
 
123
</div>
 
124
<hr>
 
125
<div class="refsect2" lang="en">
 
126
<a name="id2558550"></a><h3>
 
127
<a name="RBMetaDataError"></a>enum RBMetaDataError</h3>
 
128
<a class="indexterm" name="id2518668"></a><pre class="programlisting">typedef enum
 
129
{
 
130
        RB_METADATA_ERROR_GNOMEVFS,
 
131
        RB_METADATA_ERROR_MISSING_PLUGIN,
 
132
        RB_METADATA_ERROR_UNRECOGNIZED,
 
133
        RB_METADATA_ERROR_UNSUPPORTED,
 
134
        RB_METADATA_ERROR_GENERAL,
 
135
        RB_METADATA_ERROR_INTERNAL,
 
136
        RB_METADATA_ERROR_NOT_AUDIO,
 
137
        RB_METADATA_ERROR_NOT_AUDIO_IGNORE,
 
138
} RBMetaDataError;
 
139
</pre>
 
140
<p>
 
141
 
 
142
</p>
 
143
</div>
 
144
<hr>
 
145
<div class="refsect2" lang="en">
 
146
<a name="id2518851"></a><h3>
 
147
<a name="RB-METADATA-ERROR:CAPS"></a>RB_METADATA_ERROR</h3>
 
148
<a class="indexterm" name="id2524561"></a><pre class="programlisting">#define RB_METADATA_ERROR rb_metadata_error_quark ()
 
149
</pre>
 
150
<p>
 
151
 
 
152
</p>
 
153
</div>
 
154
<hr>
 
155
<div class="refsect2" lang="en">
 
156
<a name="id2560668"></a><h3>
 
157
<a name="rb-metadata-error-quark"></a>rb_metadata_error_quark ()</h3>
 
158
<a class="indexterm" name="id2560677"></a><pre class="programlisting">GQuark      rb_metadata_error_quark         (void);</pre>
 
159
<p>
 
160
 
 
161
</p>
 
162
<div class="variablelist"><table border="0">
 
163
<col align="left" valign="top">
 
164
<tbody><tr>
 
165
<td>
 
166
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
167
<td>
 
168
 
 
169
 
 
170
</td>
 
171
</tr></tbody>
 
172
</table></div>
 
173
</div>
 
174
<hr>
 
175
<div class="refsect2" lang="en">
 
176
<a name="id2560713"></a><h3>
 
177
<a name="RBMetaDataPrivate"></a>RBMetaDataPrivate</h3>
 
178
<a class="indexterm" name="id2560723"></a><pre class="programlisting">typedef struct RBMetaDataPrivate RBMetaDataPrivate;
 
179
</pre>
 
180
<p>
 
181
 
 
182
</p>
 
183
</div>
 
184
<hr>
 
185
<div class="refsect2" lang="en">
 
186
<a name="id2560740"></a><h3>
 
187
<a name="rb-metadata-new"></a>rb_metadata_new ()</h3>
 
188
<a class="indexterm" name="id2560750"></a><pre class="programlisting">RBMetaData* rb_metadata_new                 (void);</pre>
 
189
<p>
 
190
 
 
191
</p>
 
192
<div class="variablelist"><table border="0">
 
193
<col align="left" valign="top">
 
194
<tbody><tr>
 
195
<td>
 
196
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
197
<td>
 
198
 
 
199
 
 
200
</td>
 
201
</tr></tbody>
 
202
</table></div>
 
203
</div>
 
204
<hr>
 
205
<div class="refsect2" lang="en">
 
206
<a name="id2560785"></a><h3>
 
207
<a name="rb-metadata-get-field-type"></a>rb_metadata_get_field_type ()</h3>
 
208
<a class="indexterm" name="id2560794"></a><pre class="programlisting">GType       rb_metadata_get_field_type      (RBMetaData *md,
 
209
                                             <a href="rhythmbox-rb-metadata.html#RBMetaDataField">RBMetaDataField</a> field);</pre>
 
210
<p>
 
211
 
 
212
</p>
 
213
<div class="variablelist"><table border="0">
 
214
<col align="left" valign="top">
 
215
<tbody>
 
216
<tr>
 
217
<td>
 
218
<span class="term"><em class="parameter"><code>md</code></em>&#160;:</span></td>
 
219
<td>
 
220
</td>
 
221
</tr>
 
222
<tr>
 
223
<td>
 
224
<span class="term"><em class="parameter"><code>field</code></em>&#160;:</span></td>
 
225
<td>
 
226
</td>
 
227
</tr>
 
228
<tr>
 
229
<td>
 
230
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
231
<td>
 
232
 
 
233
 
 
234
</td>
 
235
</tr>
 
236
</tbody>
 
237
</table></div>
 
238
</div>
 
239
<hr>
 
240
<div class="refsect2" lang="en">
 
241
<a name="id2560871"></a><h3>
 
242
<a name="rb-metadata-can-save"></a>rb_metadata_can_save ()</h3>
 
243
<a class="indexterm" name="id2560880"></a><pre class="programlisting">gboolean    rb_metadata_can_save            (RBMetaData *md,
 
244
                                             const char *mimetype);</pre>
 
245
<p>
 
246
 
 
247
</p>
 
248
<div class="variablelist"><table border="0">
 
249
<col align="left" valign="top">
 
250
<tbody>
 
251
<tr>
 
252
<td>
 
253
<span class="term"><em class="parameter"><code>md</code></em>&#160;:</span></td>
 
254
<td>
 
255
</td>
 
256
</tr>
 
257
<tr>
 
258
<td>
 
259
<span class="term"><em class="parameter"><code>mimetype</code></em>&#160;:</span></td>
 
260
<td>
 
261
</td>
 
262
</tr>
 
263
<tr>
 
264
<td>
 
265
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
266
<td>
 
267
 
 
268
 
 
269
</td>
 
270
</tr>
 
271
</tbody>
 
272
</table></div>
 
273
</div>
 
274
<hr>
 
275
<div class="refsect2" lang="en">
 
276
<a name="id2557434"></a><h3>
 
277
<a name="rb-metadata-load"></a>rb_metadata_load ()</h3>
 
278
<a class="indexterm" name="id2557444"></a><pre class="programlisting">void        rb_metadata_load                (RBMetaData *md,
 
279
                                             const char *uri,
 
280
                                             GError **error);</pre>
 
281
<p>
 
282
 
 
283
</p>
 
284
<div class="variablelist"><table border="0">
 
285
<col align="left" valign="top">
 
286
<tbody>
 
287
<tr>
 
288
<td>
 
289
<span class="term"><em class="parameter"><code>md</code></em>&#160;:</span></td>
 
290
<td>
 
291
</td>
 
292
</tr>
 
293
<tr>
 
294
<td>
 
295
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
 
296
<td>
 
297
</td>
 
298
</tr>
 
299
<tr>
 
300
<td>
 
301
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
302
<td>
 
303
 
 
304
 
 
305
</td>
 
306
</tr>
 
307
</tbody>
 
308
</table></div>
 
309
</div>
 
310
<hr>
 
311
<div class="refsect2" lang="en">
 
312
<a name="id2557532"></a><h3>
 
313
<a name="rb-metadata-save"></a>rb_metadata_save ()</h3>
 
314
<a class="indexterm" name="id2557542"></a><pre class="programlisting">void        rb_metadata_save                (RBMetaData *md,
 
315
                                             GError **error);</pre>
 
316
<p>
 
317
 
 
318
</p>
 
319
<div class="variablelist"><table border="0">
 
320
<col align="left" valign="top">
 
321
<tbody>
 
322
<tr>
 
323
<td>
 
324
<span class="term"><em class="parameter"><code>md</code></em>&#160;:</span></td>
 
325
<td>
 
326
</td>
 
327
</tr>
 
328
<tr>
 
329
<td>
 
330
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
331
<td>
 
332
 
 
333
 
 
334
</td>
 
335
</tr>
 
336
</tbody>
 
337
</table></div>
 
338
</div>
 
339
<hr>
 
340
<div class="refsect2" lang="en">
 
341
<a name="id2557608"></a><h3>
 
342
<a name="rb-metadata-get-mime"></a>rb_metadata_get_mime ()</h3>
 
343
<a class="indexterm" name="id2557617"></a><pre class="programlisting">const char* rb_metadata_get_mime            (RBMetaData *md);</pre>
 
344
<p>
 
345
 
 
346
</p>
 
347
<div class="variablelist"><table border="0">
 
348
<col align="left" valign="top">
 
349
<tbody>
 
350
<tr>
 
351
<td>
 
352
<span class="term"><em class="parameter"><code>md</code></em>&#160;:</span></td>
 
353
<td>
 
354
</td>
 
355
</tr>
 
356
<tr>
 
357
<td>
 
358
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
359
<td>
 
360
 
 
361
 
 
362
</td>
 
363
</tr>
 
364
</tbody>
 
365
</table></div>
 
366
</div>
 
367
<hr>
 
368
<div class="refsect2" lang="en">
 
369
<a name="id2563534"></a><h3>
 
370
<a name="rb-metadata-get"></a>rb_metadata_get ()</h3>
 
371
<a class="indexterm" name="id2563542"></a><pre class="programlisting">gboolean    rb_metadata_get                 (RBMetaData *md,
 
372
                                             <a href="rhythmbox-rb-metadata.html#RBMetaDataField">RBMetaDataField</a> field,
 
373
                                             GValue *val);</pre>
 
374
<p>
 
375
 
 
376
</p>
 
377
<div class="variablelist"><table border="0">
 
378
<col align="left" valign="top">
 
379
<tbody>
 
380
<tr>
 
381
<td>
 
382
<span class="term"><em class="parameter"><code>md</code></em>&#160;:</span></td>
 
383
<td>
 
384
</td>
 
385
</tr>
 
386
<tr>
 
387
<td>
 
388
<span class="term"><em class="parameter"><code>field</code></em>&#160;:</span></td>
 
389
<td>
 
390
</td>
 
391
</tr>
 
392
<tr>
 
393
<td>
 
394
<span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
 
395
<td>
 
396
</td>
 
397
</tr>
 
398
<tr>
 
399
<td>
 
400
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
401
<td>
 
402
 
 
403
 
 
404
</td>
 
405
</tr>
 
406
</tbody>
 
407
</table></div>
 
408
</div>
 
409
<hr>
 
410
<div class="refsect2" lang="en">
 
411
<a name="id2563630"></a><h3>
 
412
<a name="rb-metadata-set"></a>rb_metadata_set ()</h3>
 
413
<a class="indexterm" name="id2563638"></a><pre class="programlisting">gboolean    rb_metadata_set                 (RBMetaData *md,
 
414
                                             <a href="rhythmbox-rb-metadata.html#RBMetaDataField">RBMetaDataField</a> field,
 
415
                                             const GValue *val);</pre>
 
416
<p>
 
417
 
 
418
</p>
 
419
<div class="variablelist"><table border="0">
 
420
<col align="left" valign="top">
 
421
<tbody>
 
422
<tr>
 
423
<td>
 
424
<span class="term"><em class="parameter"><code>md</code></em>&#160;:</span></td>
 
425
<td>
 
426
</td>
 
427
</tr>
 
428
<tr>
 
429
<td>
 
430
<span class="term"><em class="parameter"><code>field</code></em>&#160;:</span></td>
 
431
<td>
 
432
</td>
 
433
</tr>
 
434
<tr>
 
435
<td>
 
436
<span class="term"><em class="parameter"><code>val</code></em>&#160;:</span></td>
 
437
<td>
 
438
</td>
 
439
</tr>
 
440
<tr>
 
441
<td>
 
442
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
443
<td>
 
444
 
 
445
 
 
446
</td>
 
447
</tr>
 
448
</tbody>
 
449
</table></div>
 
450
</div>
 
451
</div>
 
452
</div>
 
453
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
454
<td align="left"><a accesskey="p" href="ch03.html"><b>&lt;&lt;&#160;Metadata</b></a></td>
 
455
<td align="right"><a accesskey="n" href="ch04.html"><b>Player&#160;&gt;&gt;</b></a></td>
 
456
</tr></table>
 
457
</body>
 
458
</html>