← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-daap-structure.xml

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/xml/rb-daap-structure.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-daap-structure">
 
5
<refmeta>
 
6
<refentrytitle>rb-daap-structure</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-daap-structure</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
enum        <link linkend="RBDAAPContentCode">RBDAAPContentCode</link>;
 
22
            <link linkend="RBDAAPItem">RBDAAPItem</link>;
 
23
<link linkend="GNode">GNode</link>*      <link linkend="rb-daap-structure-add">rb_daap_structure_add</link>           (<link linkend="GNode">GNode</link> *parent,
 
24
                                             <link linkend="RBDAAPContentCode">RBDAAPContentCode</link> cc,
 
25
                                             ...);
 
26
<link linkend="gchar">gchar</link>*      <link linkend="rb-daap-structure-serialize">rb_daap_structure_serialize</link>     (<link linkend="GNode">GNode</link> *structure,
 
27
                                             <link linkend="guint">guint</link> *length);
 
28
<link linkend="GNode">GNode</link>*      <link linkend="rb-daap-structure-parse">rb_daap_structure_parse</link>         (const <link linkend="gchar">gchar</link> *buf,
 
29
                                             <link linkend="gint">gint</link> buf_length);
 
30
<link linkend="RBDAAPItem">RBDAAPItem</link>* <link linkend="rb-daap-structure-find-item">rb_daap_structure_find_item</link>     (<link linkend="GNode">GNode</link> *structure,
 
31
                                             <link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);
 
32
<link linkend="GNode">GNode</link>*      <link linkend="rb-daap-structure-find-node">rb_daap_structure_find_node</link>     (<link linkend="GNode">GNode</link> *structure,
 
33
                                             <link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);
 
34
<link linkend="void">void</link>        <link linkend="rb-daap-structure-print">rb_daap_structure_print</link>         (<link linkend="GNode">GNode</link> *structure);
 
35
<link linkend="void">void</link>        <link linkend="rb-daap-structure-destroy">rb_daap_structure_destroy</link>       (<link linkend="GNode">GNode</link> *structure);
 
36
enum        <link linkend="RBDAAPType">RBDAAPType</link>;
 
37
            <link linkend="RBDAAPContentCodeDefinition">RBDAAPContentCodeDefinition</link>;
 
38
const <link linkend="RBDAAPContentCodeDefinition">RBDAAPContentCodeDefinition</link>* <link linkend="rb-daap-content-codes">rb_daap_content_codes</link>
 
39
                                            (<link linkend="guint">guint</link> *number);
 
40
<link linkend="gint32">gint32</link>      <link linkend="rb-daap-content-code-string-as-int32">rb_daap_content_code_string_as_int32</link>
 
41
                                            (const <link linkend="gchar">gchar</link> *str);
 
42
const <link linkend="gchar">gchar</link>* <link linkend="rb-daap-content-code-name">rb_daap_content_code_name</link>      (<link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);
 
43
<link linkend="RBDAAPType">RBDAAPType</link>  <link linkend="rb-daap-content-code-rb-daap-type">rb_daap_content_code_rb_daap_type</link>
 
44
                                            (<link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);
 
45
const <link linkend="gchar">gchar</link>* <link linkend="rb-daap-content-code-string">rb_daap_content_code_string</link>    (<link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);
 
46
</synopsis>
 
47
</refsynopsisdiv>
 
48
 
 
49
 
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
<refsect1>
 
58
<title>Description</title>
 
59
<para>
 
60
 
 
61
</para>
 
62
</refsect1>
 
63
 
 
64
<refsect1>
 
65
<title>Details</title>
 
66
<refsect2>
 
67
<title><anchor id="RBDAAPContentCode"/>enum RBDAAPContentCode</title>
 
68
<indexterm><primary>RBDAAPContentCode</primary></indexterm><programlisting>typedef enum {
 
69
        RB_DAAP_CC_INVALID = 0,
 
70
        RB_DAAP_CC_MDCL = 1,
 
71
        RB_DAAP_CC_MSTT,
 
72
        RB_DAAP_CC_MIID,
 
73
        RB_DAAP_CC_MINM,
 
74
        RB_DAAP_CC_MIKD,
 
75
        RB_DAAP_CC_MPER,
 
76
        RB_DAAP_CC_MCON,
 
77
        RB_DAAP_CC_MCTI,
 
78
        RB_DAAP_CC_MPCO,
 
79
        RB_DAAP_CC_MSTS, // 10
 
80
        RB_DAAP_CC_MIMC,
 
81
        RB_DAAP_CC_MCTC,
 
82
        RB_DAAP_CC_MRCO,
 
83
        RB_DAAP_CC_MTCO,
 
84
        RB_DAAP_CC_MLCL,
 
85
        RB_DAAP_CC_MLIT,
 
86
        RB_DAAP_CC_MBCL,
 
87
        RB_DAAP_CC_MSRV, 
 
88
        RB_DAAP_CC_MSAU,
 
89
        RB_DAAP_CC_MSLR, // 20
 
90
        RB_DAAP_CC_MPRO, 
 
91
        RB_DAAP_CC_APRO,
 
92
        RB_DAAP_CC_MSAL,
 
93
        RB_DAAP_CC_MSUP,
 
94
        RB_DAAP_CC_MSPI,
 
95
        RB_DAAP_CC_MSEX,
 
96
        RB_DAAP_CC_MSBR,
 
97
        RB_DAAP_CC_MSQY,
 
98
        RB_DAAP_CC_MSIX,
 
99
        RB_DAAP_CC_MSRS, // 30
 
100
        RB_DAAP_CC_MSTM, 
 
101
        RB_DAAP_CC_MSDC,
 
102
        RB_DAAP_CC_MCCR,
 
103
        RB_DAAP_CC_MCNM,
 
104
        RB_DAAP_CC_MCNA,
 
105
        RB_DAAP_CC_MCTY,
 
106
        RB_DAAP_CC_MLOG,
 
107
        RB_DAAP_CC_MLID,
 
108
        RB_DAAP_CC_MUPD,
 
109
        RB_DAAP_CC_MUSR, // 40
 
110
        RB_DAAP_CC_MUTY, 
 
111
        RB_DAAP_CC_MUDL,
 
112
        RB_DAAP_CC_AVDB,
 
113
        RB_DAAP_CC_ABRO,
 
114
        RB_DAAP_CC_ABAL,
 
115
        RB_DAAP_CC_ABAR,
 
116
        RB_DAAP_CC_ABCP,
 
117
        RB_DAAP_CC_ABGN,
 
118
        RB_DAAP_CC_ADBS,
 
119
        RB_DAAP_CC_ASAL, // 50
 
120
        RB_DAAP_CC_ASAR, 
 
121
        RB_DAAP_CC_ASBT,
 
122
        RB_DAAP_CC_ASBR,
 
123
        RB_DAAP_CC_ASCM,
 
124
        RB_DAAP_CC_ASCO,
 
125
        RB_DAAP_CC_ASDA,
 
126
        RB_DAAP_CC_ASDM,
 
127
        RB_DAAP_CC_ASDC,
 
128
        RB_DAAP_CC_ASDN,
 
129
        RB_DAAP_CC_ASDB, // 60
 
130
        RB_DAAP_CC_ASEQ,
 
131
        RB_DAAP_CC_ASFM,
 
132
        RB_DAAP_CC_ASGN,
 
133
        RB_DAAP_CC_ASDT,
 
134
        RB_DAAP_CC_ASRV,
 
135
        RB_DAAP_CC_ASSR,
 
136
        RB_DAAP_CC_ASSZ,
 
137
        RB_DAAP_CC_ASST,
 
138
        RB_DAAP_CC_ASSP,
 
139
        RB_DAAP_CC_ASTM, // 70
 
140
        RB_DAAP_CC_ASTC, 
 
141
        RB_DAAP_CC_ASTN,
 
142
        RB_DAAP_CC_ASUR,
 
143
        RB_DAAP_CC_ASYR,
 
144
        RB_DAAP_CC_ASDK,
 
145
        RB_DAAP_CC_ASUL,
 
146
        RB_DAAP_CC_APLY,
 
147
        RB_DAAP_CC_ABPL,
 
148
        RB_DAAP_CC_APSO,
 
149
        RB_DAAP_CC_PRSV, // 80
 
150
        RB_DAAP_CC_ARIF, 
 
151
        RB_DAAP_CC_AESV,
 
152
        RB_DAAP_CC_MSAS,
 
153
        RB_DAAP_CC_AGRP,
 
154
        RB_DAAP_CC_ASCP,
 
155
} RBDAAPContentCode;
 
156
</programlisting>
 
157
<para>
 
158
 
 
159
</para></refsect2>
 
160
<refsect2>
 
161
<title><anchor id="RBDAAPItem"/>RBDAAPItem</title>
 
162
<indexterm><primary>RBDAAPItem</primary></indexterm><programlisting>typedef struct {
 
163
        RBDAAPContentCode content_code;
 
164
        GValue content;
 
165
        guint size;
 
166
} RBDAAPItem;
 
167
</programlisting>
 
168
<para>
 
169
 
 
170
</para></refsect2>
 
171
<refsect2>
 
172
<title><anchor id="rb-daap-structure-add"/>rb_daap_structure_add ()</title>
 
173
<indexterm><primary>rb_daap_structure_add</primary></indexterm><programlisting><link linkend="GNode">GNode</link>*      rb_daap_structure_add           (<link linkend="GNode">GNode</link> *parent,
 
174
                                             <link linkend="RBDAAPContentCode">RBDAAPContentCode</link> cc,
 
175
                                             ...);</programlisting>
 
176
<para>
 
177
 
 
178
</para><variablelist role="params">
 
179
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
180
<listitem><simpara>
 
181
</simpara></listitem></varlistentry>
 
182
<varlistentry><term><parameter>cc</parameter>&nbsp;:</term>
 
183
<listitem><simpara>
 
184
</simpara></listitem></varlistentry>
 
185
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
186
<listitem><simpara>
 
187
</simpara></listitem></varlistentry>
 
188
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
189
 
 
190
 
 
191
</simpara></listitem></varlistentry>
 
192
</variablelist></refsect2>
 
193
<refsect2>
 
194
<title><anchor id="rb-daap-structure-serialize"/>rb_daap_structure_serialize ()</title>
 
195
<indexterm><primary>rb_daap_structure_serialize</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      rb_daap_structure_serialize     (<link linkend="GNode">GNode</link> *structure,
 
196
                                             <link linkend="guint">guint</link> *length);</programlisting>
 
197
<para>
 
198
 
 
199
</para><variablelist role="params">
 
200
<varlistentry><term><parameter>structure</parameter>&nbsp;:</term>
 
201
<listitem><simpara>
 
202
</simpara></listitem></varlistentry>
 
203
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
 
204
<listitem><simpara>
 
205
</simpara></listitem></varlistentry>
 
206
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
207
 
 
208
 
 
209
</simpara></listitem></varlistentry>
 
210
</variablelist></refsect2>
 
211
<refsect2>
 
212
<title><anchor id="rb-daap-structure-parse"/>rb_daap_structure_parse ()</title>
 
213
<indexterm><primary>rb_daap_structure_parse</primary></indexterm><programlisting><link linkend="GNode">GNode</link>*      rb_daap_structure_parse         (const <link linkend="gchar">gchar</link> *buf,
 
214
                                             <link linkend="gint">gint</link> buf_length);</programlisting>
 
215
<para>
 
216
 
 
217
</para><variablelist role="params">
 
218
<varlistentry><term><parameter>buf</parameter>&nbsp;:</term>
 
219
<listitem><simpara>
 
220
</simpara></listitem></varlistentry>
 
221
<varlistentry><term><parameter>buf_length</parameter>&nbsp;:</term>
 
222
<listitem><simpara>
 
223
</simpara></listitem></varlistentry>
 
224
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
225
 
 
226
 
 
227
</simpara></listitem></varlistentry>
 
228
</variablelist></refsect2>
 
229
<refsect2>
 
230
<title><anchor id="rb-daap-structure-find-item"/>rb_daap_structure_find_item ()</title>
 
231
<indexterm><primary>rb_daap_structure_find_item</primary></indexterm><programlisting><link linkend="RBDAAPItem">RBDAAPItem</link>* rb_daap_structure_find_item     (<link linkend="GNode">GNode</link> *structure,
 
232
                                             <link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);</programlisting>
 
233
<para>
 
234
 
 
235
</para><variablelist role="params">
 
236
<varlistentry><term><parameter>structure</parameter>&nbsp;:</term>
 
237
<listitem><simpara>
 
238
</simpara></listitem></varlistentry>
 
239
<varlistentry><term><parameter>code</parameter>&nbsp;:</term>
 
240
<listitem><simpara>
 
241
</simpara></listitem></varlistentry>
 
242
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
243
 
 
244
 
 
245
</simpara></listitem></varlistentry>
 
246
</variablelist></refsect2>
 
247
<refsect2>
 
248
<title><anchor id="rb-daap-structure-find-node"/>rb_daap_structure_find_node ()</title>
 
249
<indexterm><primary>rb_daap_structure_find_node</primary></indexterm><programlisting><link linkend="GNode">GNode</link>*      rb_daap_structure_find_node     (<link linkend="GNode">GNode</link> *structure,
 
250
                                             <link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);</programlisting>
 
251
<para>
 
252
 
 
253
</para><variablelist role="params">
 
254
<varlistentry><term><parameter>structure</parameter>&nbsp;:</term>
 
255
<listitem><simpara>
 
256
</simpara></listitem></varlistentry>
 
257
<varlistentry><term><parameter>code</parameter>&nbsp;:</term>
 
258
<listitem><simpara>
 
259
</simpara></listitem></varlistentry>
 
260
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
261
 
 
262
 
 
263
</simpara></listitem></varlistentry>
 
264
</variablelist></refsect2>
 
265
<refsect2>
 
266
<title><anchor id="rb-daap-structure-print"/>rb_daap_structure_print ()</title>
 
267
<indexterm><primary>rb_daap_structure_print</primary></indexterm><programlisting><link linkend="void">void</link>        rb_daap_structure_print         (<link linkend="GNode">GNode</link> *structure);</programlisting>
 
268
<para>
 
269
 
 
270
</para><variablelist role="params">
 
271
<varlistentry><term><parameter>structure</parameter>&nbsp;:</term>
 
272
<listitem><simpara>
 
273
 
 
274
 
 
275
</simpara></listitem></varlistentry>
 
276
</variablelist></refsect2>
 
277
<refsect2>
 
278
<title><anchor id="rb-daap-structure-destroy"/>rb_daap_structure_destroy ()</title>
 
279
<indexterm><primary>rb_daap_structure_destroy</primary></indexterm><programlisting><link linkend="void">void</link>        rb_daap_structure_destroy       (<link linkend="GNode">GNode</link> *structure);</programlisting>
 
280
<para>
 
281
 
 
282
</para><variablelist role="params">
 
283
<varlistentry><term><parameter>structure</parameter>&nbsp;:</term>
 
284
<listitem><simpara>
 
285
 
 
286
 
 
287
</simpara></listitem></varlistentry>
 
288
</variablelist></refsect2>
 
289
<refsect2>
 
290
<title><anchor id="RBDAAPType"/>enum RBDAAPType</title>
 
291
<indexterm><primary>RBDAAPType</primary></indexterm><programlisting>typedef enum {
 
292
        RB_DAAP_TYPE_BYTE = 0x0001,
 
293
        RB_DAAP_TYPE_SIGNED_INT = 0x0002,
 
294
        RB_DAAP_TYPE_SHORT = 0x0003,
 
295
        RB_DAAP_TYPE_INT = 0x0005,
 
296
        RB_DAAP_TYPE_INT64 = 0x0007,
 
297
        RB_DAAP_TYPE_STRING = 0x0009,
 
298
        RB_DAAP_TYPE_DATE = 0x000A,
 
299
        RB_DAAP_TYPE_VERSION = 0x000B,
 
300
        RB_DAAP_TYPE_CONTAINER = 0x000C
 
301
} RBDAAPType;
 
302
</programlisting>
 
303
<para>
 
304
 
 
305
</para></refsect2>
 
306
<refsect2>
 
307
<title><anchor id="RBDAAPContentCodeDefinition"/>RBDAAPContentCodeDefinition</title>
 
308
<indexterm><primary>RBDAAPContentCodeDefinition</primary></indexterm><programlisting>typedef struct {
 
309
        RBDAAPContentCode code;
 
310
        gint32 int_code;
 
311
        const gchar *name;
 
312
        const gchar *string;
 
313
        RBDAAPType type;
 
314
} RBDAAPContentCodeDefinition;
 
315
</programlisting>
 
316
<para>
 
317
 
 
318
</para></refsect2>
 
319
<refsect2>
 
320
<title><anchor id="rb-daap-content-codes"/>rb_daap_content_codes ()</title>
 
321
<indexterm><primary>rb_daap_content_codes</primary></indexterm><programlisting>const <link linkend="RBDAAPContentCodeDefinition">RBDAAPContentCodeDefinition</link>* rb_daap_content_codes
 
322
                                            (<link linkend="guint">guint</link> *number);</programlisting>
 
323
<para>
 
324
 
 
325
</para><variablelist role="params">
 
326
<varlistentry><term><parameter>number</parameter>&nbsp;:</term>
 
327
<listitem><simpara>
 
328
</simpara></listitem></varlistentry>
 
329
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
330
 
 
331
 
 
332
</simpara></listitem></varlistentry>
 
333
</variablelist></refsect2>
 
334
<refsect2>
 
335
<title><anchor id="rb-daap-content-code-string-as-int32"/>rb_daap_content_code_string_as_int32 ()</title>
 
336
<indexterm><primary>rb_daap_content_code_string_as_int32</primary></indexterm><programlisting><link linkend="gint32">gint32</link>      rb_daap_content_code_string_as_int32
 
337
                                            (const <link linkend="gchar">gchar</link> *str);</programlisting>
 
338
<para>
 
339
 
 
340
</para><variablelist role="params">
 
341
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
 
342
<listitem><simpara>
 
343
</simpara></listitem></varlistentry>
 
344
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
345
 
 
346
 
 
347
</simpara></listitem></varlistentry>
 
348
</variablelist></refsect2>
 
349
<refsect2>
 
350
<title><anchor id="rb-daap-content-code-name"/>rb_daap_content_code_name ()</title>
 
351
<indexterm><primary>rb_daap_content_code_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* rb_daap_content_code_name      (<link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);</programlisting>
 
352
<para>
 
353
 
 
354
</para><variablelist role="params">
 
355
<varlistentry><term><parameter>code</parameter>&nbsp;:</term>
 
356
<listitem><simpara>
 
357
</simpara></listitem></varlistentry>
 
358
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
359
 
 
360
 
 
361
</simpara></listitem></varlistentry>
 
362
</variablelist></refsect2>
 
363
<refsect2>
 
364
<title><anchor id="rb-daap-content-code-rb-daap-type"/>rb_daap_content_code_rb_daap_type ()</title>
 
365
<indexterm><primary>rb_daap_content_code_rb_daap_type</primary></indexterm><programlisting><link linkend="RBDAAPType">RBDAAPType</link>  rb_daap_content_code_rb_daap_type
 
366
                                            (<link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);</programlisting>
 
367
<para>
 
368
 
 
369
</para><variablelist role="params">
 
370
<varlistentry><term><parameter>code</parameter>&nbsp;:</term>
 
371
<listitem><simpara>
 
372
</simpara></listitem></varlistentry>
 
373
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
374
 
 
375
 
 
376
</simpara></listitem></varlistentry>
 
377
</variablelist></refsect2>
 
378
<refsect2>
 
379
<title><anchor id="rb-daap-content-code-string"/>rb_daap_content_code_string ()</title>
 
380
<indexterm><primary>rb_daap_content_code_string</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* rb_daap_content_code_string    (<link linkend="RBDAAPContentCode">RBDAAPContentCode</link> code);</programlisting>
 
381
<para>
 
382
 
 
383
</para><variablelist role="params">
 
384
<varlistentry><term><parameter>code</parameter>&nbsp;:</term>
 
385
<listitem><simpara>
 
386
</simpara></listitem></varlistentry>
 
387
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
388
 
 
389
 
 
390
</simpara></listitem></varlistentry>
 
391
</variablelist></refsect2>
 
392
 
 
393
</refsect1>
 
394
 
 
395
 
 
396
 
 
397
 
 
398
</refentry>