← Back to branch summary

~serge-hallyn/ubuntu/precise/rhythmbox/rhythmbox-sort

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-metadata.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-12-02 19:23:18 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051202192318-7ayjionj59dq1wk4
Tags: 0.9.2-0ubuntu3
* debian/control.in:
  - Build-Depends on libmusicbrainz4-dev so rhythmbox does the CD 
    query on internet (Ubuntu: #20363).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-metadata.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="rhythmbox-rb-metadata">
 
5
<refmeta>
 
6
<refentrytitle>rb-metadata</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-metadata</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
#define     <link linkend="RB-METADATA-NUM-FIELDS:CAPS">RB_METADATA_NUM_FIELDS</link>
 
22
enum        <link linkend="RBMetaDataField">RBMetaDataField</link>;
 
23
enum        <link linkend="RBMetaDataError">RBMetaDataError</link>;
 
24
#define     <link linkend="RB-METADATA-ERROR:CAPS">RB_METADATA_ERROR</link>
 
25
<link linkend="GQuark">GQuark</link>      <link linkend="rb-metadata-error-quark">rb_metadata_error_quark</link>         (void);
 
26
typedef     <link linkend="RBMetaDataPrivate">RBMetaDataPrivate</link>;
 
27
<link linkend="RBMetaData">RBMetaData</link>* <link linkend="rb-metadata-new">rb_metadata_new</link>                 (void);
 
28
<link linkend="GType">GType</link>       <link linkend="rb-metadata-get-field-type">rb_metadata_get_field_type</link>      (<link linkend="RBMetaData">RBMetaData</link> *md,
 
29
                                             <link linkend="RBMetaDataField">RBMetaDataField</link> field);
 
30
<link linkend="gboolean">gboolean</link>    <link linkend="rb-metadata-can-save">rb_metadata_can_save</link>            (<link linkend="RBMetaData">RBMetaData</link> *md,
 
31
                                             const <link linkend="char">char</link> *mimetype);
 
32
<link linkend="void">void</link>        <link linkend="rb-metadata-load">rb_metadata_load</link>                (<link linkend="RBMetaData">RBMetaData</link> *md,
 
33
                                             const <link linkend="char">char</link> *uri,
 
34
                                             <link linkend="GError">GError</link> **error);
 
35
<link linkend="void">void</link>        <link linkend="rb-metadata-save">rb_metadata_save</link>                (<link linkend="RBMetaData">RBMetaData</link> *md,
 
36
                                             <link linkend="GError">GError</link> **error);
 
37
const <link linkend="char">char</link>* <link linkend="rb-metadata-get-mime">rb_metadata_get_mime</link>            (<link linkend="RBMetaData">RBMetaData</link> *md);
 
38
<link linkend="gboolean">gboolean</link>    <link linkend="rb-metadata-get">rb_metadata_get</link>                 (<link linkend="RBMetaData">RBMetaData</link> *md,
 
39
                                             <link linkend="RBMetaDataField">RBMetaDataField</link> field,
 
40
                                             <link linkend="GValue">GValue</link> *val);
 
41
<link linkend="gboolean">gboolean</link>    <link linkend="rb-metadata-set">rb_metadata_set</link>                 (<link linkend="RBMetaData">RBMetaData</link> *md,
 
42
                                             <link linkend="RBMetaDataField">RBMetaDataField</link> field,
 
43
                                             const <link linkend="GValue">GValue</link> *val);
 
44
 
 
45
</synopsis>
 
46
</refsynopsisdiv>
 
47
 
 
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
<refsect1>
 
57
<title>Description</title>
 
58
<para>
 
59
 
 
60
</para>
 
61
</refsect1>
 
62
 
 
63
<refsect1>
 
64
<title>Details</title>
 
65
<refsect2>
 
66
<title><anchor id="RB-METADATA-NUM-FIELDS:CAPS"/>RB_METADATA_NUM_FIELDS</title>
 
67
<indexterm><primary>RB_METADATA_NUM_FIELDS</primary></indexterm><programlisting>#define RB_METADATA_NUM_FIELDS 23
 
68
</programlisting>
 
69
<para>
 
70
 
 
71
</para></refsect2>
 
72
<refsect2>
 
73
<title><anchor id="RBMetaDataField"/>enum RBMetaDataField</title>
 
74
<indexterm><primary>RBMetaDataField</primary></indexterm><programlisting>typedef enum
 
75
{
 
76
        RB_METADATA_FIELD_TITLE,                   /* string */
 
77
        RB_METADATA_FIELD_ARTIST,                  /* string */
 
78
        RB_METADATA_FIELD_ALBUM,                   /* string */
 
79
        RB_METADATA_FIELD_DATE,                    /* string */
 
80
        RB_METADATA_FIELD_GENRE,                   /* string */
 
81
        RB_METADATA_FIELD_COMMENT,                 /* string */
 
82
        RB_METADATA_FIELD_TRACK_NUMBER,            /* ulong */
 
83
        RB_METADATA_FIELD_MAX_TRACK_NUMBER,        /* ulong */
 
84
        RB_METADATA_FIELD_DISC_NUMBER,             /* ulong */
 
85
        RB_METADATA_FIELD_MAX_DISC_NUMBER,         /* ulong */
 
86
        RB_METADATA_FIELD_DESCRIPTION,             /* string */
 
87
        RB_METADATA_FIELD_VERSION,                 /* string */
 
88
        RB_METADATA_FIELD_ISRC,                    /* string */
 
89
        RB_METADATA_FIELD_ORGANIZATION,            /* string */
 
90
        RB_METADATA_FIELD_COPYRIGHT,               /* string */
 
91
        RB_METADATA_FIELD_CONTACT,                 /* string */
 
92
        RB_METADATA_FIELD_LICENSE,                 /* string */
 
93
        RB_METADATA_FIELD_PERFORMER,               /* string */
 
94
        RB_METADATA_FIELD_DURATION,                /* ulong */
 
95
        RB_METADATA_FIELD_CODEC,                   /* string */
 
96
        RB_METADATA_FIELD_BITRATE,                 /* ulong */
 
97
        RB_METADATA_FIELD_TRACK_GAIN,              /* double */
 
98
        RB_METADATA_FIELD_TRACK_PEAK,              /* double */
 
99
        RB_METADATA_FIELD_ALBUM_GAIN,              /* double */
 
100
        RB_METADATA_FIELD_ALBUM_PEAK,              /* double */
 
101
} RBMetaDataField;
 
102
</programlisting>
 
103
<para>
 
104
 
 
105
</para></refsect2>
 
106
<refsect2>
 
107
<title><anchor id="RBMetaDataError"/>enum RBMetaDataError</title>
 
108
<indexterm><primary>RBMetaDataError</primary></indexterm><programlisting>typedef enum
 
109
{
 
110
        RB_METADATA_ERROR_GNOMEVFS,
 
111
        RB_METADATA_ERROR_MISSING_PLUGIN,
 
112
        RB_METADATA_ERROR_UNRECOGNIZED,
 
113
        RB_METADATA_ERROR_UNSUPPORTED,
 
114
        RB_METADATA_ERROR_GENERAL,
 
115
        RB_METADATA_ERROR_INTERNAL,
 
116
        RB_METADATA_ERROR_NOT_AUDIO,
 
117
        RB_METADATA_ERROR_NOT_AUDIO_IGNORE,
 
118
} RBMetaDataError;
 
119
</programlisting>
 
120
<para>
 
121
 
 
122
</para></refsect2>
 
123
<refsect2>
 
124
<title><anchor id="RB-METADATA-ERROR:CAPS"/>RB_METADATA_ERROR</title>
 
125
<indexterm><primary>RB_METADATA_ERROR</primary></indexterm><programlisting>#define RB_METADATA_ERROR rb_metadata_error_quark ()
 
126
</programlisting>
 
127
<para>
 
128
 
 
129
</para></refsect2>
 
130
<refsect2>
 
131
<title><anchor id="rb-metadata-error-quark"/>rb_metadata_error_quark ()</title>
 
132
<indexterm><primary>rb_metadata_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>      rb_metadata_error_quark         (void);</programlisting>
 
133
<para>
 
134
 
 
135
</para><variablelist role="params">
 
136
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
137
 
 
138
 
 
139
</simpara></listitem></varlistentry>
 
140
</variablelist></refsect2>
 
141
<refsect2>
 
142
<title><anchor id="RBMetaDataPrivate"/>RBMetaDataPrivate</title>
 
143
<indexterm><primary>RBMetaDataPrivate</primary></indexterm><programlisting>typedef struct RBMetaDataPrivate RBMetaDataPrivate;
 
144
</programlisting>
 
145
<para>
 
146
 
 
147
</para></refsect2>
 
148
<refsect2>
 
149
<title><anchor id="rb-metadata-new"/>rb_metadata_new ()</title>
 
150
<indexterm><primary>rb_metadata_new</primary></indexterm><programlisting><link linkend="RBMetaData">RBMetaData</link>* rb_metadata_new                 (void);</programlisting>
 
151
<para>
 
152
 
 
153
</para><variablelist role="params">
 
154
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
155
 
 
156
 
 
157
</simpara></listitem></varlistentry>
 
158
</variablelist></refsect2>
 
159
<refsect2>
 
160
<title><anchor id="rb-metadata-get-field-type"/>rb_metadata_get_field_type ()</title>
 
161
<indexterm><primary>rb_metadata_get_field_type</primary></indexterm><programlisting><link linkend="GType">GType</link>       rb_metadata_get_field_type      (<link linkend="RBMetaData">RBMetaData</link> *md,
 
162
                                             <link linkend="RBMetaDataField">RBMetaDataField</link> field);</programlisting>
 
163
<para>
 
164
 
 
165
</para><variablelist role="params">
 
166
<varlistentry><term><parameter>md</parameter>&nbsp;:</term>
 
167
<listitem><simpara>
 
168
</simpara></listitem></varlistentry>
 
169
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
170
<listitem><simpara>
 
171
</simpara></listitem></varlistentry>
 
172
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
173
 
 
174
 
 
175
</simpara></listitem></varlistentry>
 
176
</variablelist></refsect2>
 
177
<refsect2>
 
178
<title><anchor id="rb-metadata-can-save"/>rb_metadata_can_save ()</title>
 
179
<indexterm><primary>rb_metadata_can_save</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_metadata_can_save            (<link linkend="RBMetaData">RBMetaData</link> *md,
 
180
                                             const <link linkend="char">char</link> *mimetype);</programlisting>
 
181
<para>
 
182
 
 
183
</para><variablelist role="params">
 
184
<varlistentry><term><parameter>md</parameter>&nbsp;:</term>
 
185
<listitem><simpara>
 
186
</simpara></listitem></varlistentry>
 
187
<varlistentry><term><parameter>mimetype</parameter>&nbsp;:</term>
 
188
<listitem><simpara>
 
189
</simpara></listitem></varlistentry>
 
190
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
191
 
 
192
 
 
193
</simpara></listitem></varlistentry>
 
194
</variablelist></refsect2>
 
195
<refsect2>
 
196
<title><anchor id="rb-metadata-load"/>rb_metadata_load ()</title>
 
197
<indexterm><primary>rb_metadata_load</primary></indexterm><programlisting><link linkend="void">void</link>        rb_metadata_load                (<link linkend="RBMetaData">RBMetaData</link> *md,
 
198
                                             const <link linkend="char">char</link> *uri,
 
199
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
200
<para>
 
201
 
 
202
</para><variablelist role="params">
 
203
<varlistentry><term><parameter>md</parameter>&nbsp;:</term>
 
204
<listitem><simpara>
 
205
</simpara></listitem></varlistentry>
 
206
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
207
<listitem><simpara>
 
208
</simpara></listitem></varlistentry>
 
209
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
210
<listitem><simpara>
 
211
 
 
212
 
 
213
</simpara></listitem></varlistentry>
 
214
</variablelist></refsect2>
 
215
<refsect2>
 
216
<title><anchor id="rb-metadata-save"/>rb_metadata_save ()</title>
 
217
<indexterm><primary>rb_metadata_save</primary></indexterm><programlisting><link linkend="void">void</link>        rb_metadata_save                (<link linkend="RBMetaData">RBMetaData</link> *md,
 
218
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
219
<para>
 
220
 
 
221
</para><variablelist role="params">
 
222
<varlistentry><term><parameter>md</parameter>&nbsp;:</term>
 
223
<listitem><simpara>
 
224
</simpara></listitem></varlistentry>
 
225
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
226
<listitem><simpara>
 
227
 
 
228
 
 
229
</simpara></listitem></varlistentry>
 
230
</variablelist></refsect2>
 
231
<refsect2>
 
232
<title><anchor id="rb-metadata-get-mime"/>rb_metadata_get_mime ()</title>
 
233
<indexterm><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>
 
234
<para>
 
235
 
 
236
</para><variablelist role="params">
 
237
<varlistentry><term><parameter>md</parameter>&nbsp;:</term>
 
238
<listitem><simpara>
 
239
</simpara></listitem></varlistentry>
 
240
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
241
 
 
242
 
 
243
</simpara></listitem></varlistentry>
 
244
</variablelist></refsect2>
 
245
<refsect2>
 
246
<title><anchor id="rb-metadata-get"/>rb_metadata_get ()</title>
 
247
<indexterm><primary>rb_metadata_get</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_metadata_get                 (<link linkend="RBMetaData">RBMetaData</link> *md,
 
248
                                             <link linkend="RBMetaDataField">RBMetaDataField</link> field,
 
249
                                             <link linkend="GValue">GValue</link> *val);</programlisting>
 
250
<para>
 
251
 
 
252
</para><variablelist role="params">
 
253
<varlistentry><term><parameter>md</parameter>&nbsp;:</term>
 
254
<listitem><simpara>
 
255
</simpara></listitem></varlistentry>
 
256
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
257
<listitem><simpara>
 
258
</simpara></listitem></varlistentry>
 
259
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
 
260
<listitem><simpara>
 
261
</simpara></listitem></varlistentry>
 
262
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
263
 
 
264
 
 
265
</simpara></listitem></varlistentry>
 
266
</variablelist></refsect2>
 
267
<refsect2>
 
268
<title><anchor id="rb-metadata-set"/>rb_metadata_set ()</title>
 
269
<indexterm><primary>rb_metadata_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_metadata_set                 (<link linkend="RBMetaData">RBMetaData</link> *md,
 
270
                                             <link linkend="RBMetaDataField">RBMetaDataField</link> field,
 
271
                                             const <link linkend="GValue">GValue</link> *val);</programlisting>
 
272
<para>
 
273
 
 
274
</para><variablelist role="params">
 
275
<varlistentry><term><parameter>md</parameter>&nbsp;:</term>
 
276
<listitem><simpara>
 
277
</simpara></listitem></varlistentry>
 
278
<varlistentry><term><parameter>field</parameter>&nbsp;:</term>
 
279
<listitem><simpara>
 
280
</simpara></listitem></varlistentry>
 
281
<varlistentry><term><parameter>val</parameter>&nbsp;:</term>
 
282
<listitem><simpara>
 
283
</simpara></listitem></varlistentry>
 
284
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
285
 
 
286
 
 
287
</simpara></listitem></varlistentry>
 
288
</variablelist></refsect2>
 
289
 
 
290
</refsect1>
 
291
 
 
292
 
 
293
 
 
294
 
 
295
</refentry>