~ubuntu-branches/ubuntu/precise/libdmapsharing/precise

« back to all changes in this revision

Viewing changes to docs/html/DMAPRecord.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2011-05-30 17:50:18 UTC
  • mfrom: (1.1.7 upstream)
  • Revision ID: james.westby@ubuntu.com-20110530175018-bbz8iqkeu3e9zaba
Tags: 2.9.12-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
 
<html xmlns="http://www.w3.org/1999/xhtml">
4
 
  <head>
5
 
    <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
6
 
    <title>DMAPRecord</title>
7
 
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2" />
8
 
    <link rel="home" href="index.html" title="libdmapsharing Reference Manual" />
9
 
    <link rel="up" href="ch04.html" title="Libdmapsharing Objects and Interfaces" />
10
 
    <link rel="prev" href="libdmapsharing-3.0-dmap-share.html" title="DMAPShare" />
11
 
    <link rel="next" href="DMAPRecordFactory.html" title="DMAPRecordFactory" />
12
 
    <meta xmlns="" name="generator" content="GTK-Doc V1.15 (XML mode)" />
13
 
    <link xmlns="" rel="stylesheet" href="style.css" type="text/css" />
14
 
  </head>
15
 
  <body>
16
 
    <table xmlns="" class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
 
      <tr valign="middle">
18
 
        <td>
19
 
          <a accesskey="p" href="libdmapsharing-3.0-dmap-share.html">
20
 
            <img src="left.png" width="24" height="24" border="0" alt="Prev" />
21
 
          </a>
22
 
        </td>
23
 
        <td>
24
 
          <a accesskey="u" href="ch04.html">
25
 
            <img src="up.png" width="24" height="24" border="0" alt="Up" />
26
 
          </a>
27
 
        </td>
28
 
        <td>
29
 
          <a accesskey="h" href="index.html">
30
 
            <img src="home.png" width="24" height="24" border="0" alt="Home" />
31
 
          </a>
32
 
        </td>
33
 
        <th width="100%" align="center">libdmapsharing Reference Manual</th>
34
 
        <td>
35
 
          <a accesskey="n" href="DMAPRecordFactory.html">
36
 
            <img src="right.png" width="24" height="24" border="0" alt="Next" />
37
 
          </a>
38
 
        </td>
39
 
      </tr>
40
 
      <tr>
41
 
        <td colspan="5" class="shortcuts"><a href="#DMAPRecord.synopsis" class="shortcut">Top</a>
42
 
                  �|�
43
 
                  <a href="#DMAPRecord.description" class="shortcut">Description</a>
44
 
                  �|�
45
 
                  <a href="#DMAPRecord.object-hierarchy" class="shortcut">Object Hierarchy</a>
46
 
                  �|�
47
 
                  <a href="#DMAPRecord.prerequisites" class="shortcut">Prerequisites</a></td>
48
 
      </tr>
49
 
    </table>
50
 
    <div class="refentry" title="DMAPRecord">
51
 
      <a id="DMAPRecord"></a>
52
 
      <div class="titlepage"></div>
53
 
      <div xmlns="" class="refnamediv">
54
 
        <table width="100%">
55
 
          <tr>
56
 
            <td valign="top">
57
 
              <h2>
58
 
                <span xmlns="http://www.w3.org/1999/xhtml" class="refentrytitle"><a id="DMAPRecord.top_of_page"></a>DMAPRecord</span>
59
 
              </h2>
60
 
              <p>DMAPRecord</p>
61
 
            </td>
62
 
            <td valign="top" align="right"></td>
63
 
          </tr>
64
 
        </table>
65
 
      </div>
66
 
      <div class="refsynopsisdiv" title="Synopsis">
67
 
        <a id="DMAPRecord.synopsis"></a>
68
 
        <h2>Synopsis</h2>
69
 
        <pre class="synopsis">#define             <a class="link" href="DMAPRecord.html#DMAP-TYPE-RECORD:CAPS" title="DMAP_TYPE_RECORD">DMAP_TYPE_RECORD</a>
70
 
#define             <a class="link" href="DMAPRecord.html#DMAP-RECORD:CAPS" title="DMAP_RECORD()">DMAP_RECORD</a>                         (o)
71
 
#define             <a class="link" href="DMAPRecord.html#IS-DMAP-RECORD:CAPS" title="IS_DMAP_RECORD()">IS_DMAP_RECORD</a>                      (o)
72
 
#define             <a class="link" href="DMAPRecord.html#DMAP-RECORD-GET-INTERFACE:CAPS" title="DMAP_RECORD_GET_INTERFACE()">DMAP_RECORD_GET_INTERFACE</a>           (o)
73
 
                    <a class="link" href="DMAPRecord.html#DMAPRecord-struct" title="DMAPRecord">DMAPRecord</a>;
74
 
                    <a class="link" href="DMAPRecord.html#DMAPRecordIface" title="DMAPRecordIface">DMAPRecordIface</a>;
75
 
typedef             <a class="link" href="DMAPRecord.html#bitwise" title="bitwise">bitwise</a>;
76
 
enum                <a class="link" href="DMAPRecord.html#DMAPMediaKind" title="enum DMAPMediaKind">DMAPMediaKind</a>;
77
 
<GTKDOCLINK xmlns="" HREF="GType"><span xmlns="http://www.w3.org/1999/xhtml" class="returnvalue">GType</span></GTKDOCLINK>               <a class="link" href="DMAPRecord.html#dmap-record-get-type" title="dmap_record_get_type ()">dmap_record_get_type</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
78
 
<GTKDOCLINK xmlns="" HREF="GByteArray"><span xmlns="http://www.w3.org/1999/xhtml" class="returnvalue">GByteArray</span></GTKDOCLINK> *        <a class="link" href="DMAPRecord.html#dmap-record-to-blob" title="dmap_record_to_blob ()">dmap_record_to_blob</a>                 (<em class="parameter"><code><a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="type">DMAPRecord</span></a> *record</code></em>);
79
 
<a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="returnvalue">DMAPRecord</span></a> *        <a class="link" href="DMAPRecord.html#dmap-record-set-from-blob" title="dmap_record_set_from_blob ()">dmap_record_set_from_blob</a>           (<em class="parameter"><code><a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="type">DMAPRecord</span></a> *record</code></em>,
80
 
                                                         <em class="parameter"><code><GTKDOCLINK xmlns="" HREF="GByteArray"><span xmlns="http://www.w3.org/1999/xhtml" class="type">GByteArray</span></GTKDOCLINK> *blob</code></em>);
81
 
</pre>
82
 
      </div>
83
 
      <div class="refsect1" title="Object Hierarchy">
84
 
        <a id="DMAPRecord.object-hierarchy"></a>
85
 
        <h2>Object Hierarchy</h2>
86
 
        <pre class="synopsis">
87
 
  <GTKDOCLINK xmlns="" HREF="GInterface">GInterface</GTKDOCLINK>
88
 
   +----DMAPRecord
89
 
</pre>
90
 
      </div>
91
 
      <div class="refsect1" title="Prerequisites">
92
 
        <a id="DMAPRecord.prerequisites"></a>
93
 
        <h2>Prerequisites</h2>
94
 
        <p>
95
 
DMAPRecord requires
96
 
 <GTKDOCLINK xmlns="" HREF="GObject">GObject</GTKDOCLINK>.</p>
97
 
      </div>
98
 
      <div class="refsect1" title="Description">
99
 
        <a id="DMAPRecord.description"></a>
100
 
        <h2>Description</h2>
101
 
        <p>
102
 
</p>
103
 
      </div>
104
 
      <div class="refsect1" title="Details">
105
 
        <a id="DMAPRecord.details"></a>
106
 
        <h2>Details</h2>
107
 
        <div class="refsect2" title="DMAP_TYPE_RECORD">
108
 
          <a id="DMAP-TYPE-RECORD:CAPS"></a>
109
 
          <h3>DMAP_TYPE_RECORD</h3>
110
 
          <pre class="programlisting">#define DMAP_TYPE_RECORD       (dmap_record_get_type ())
111
 
</pre>
112
 
          <p>
113
 
The type for <a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="type">DMAPRecord</span></a>.
114
 
</p>
115
 
        </div>
116
 
        <hr xmlns="" />
117
 
        <div class="refsect2" title="DMAP_RECORD()">
118
 
          <a id="DMAP-RECORD:CAPS"></a>
119
 
          <h3>DMAP_RECORD()</h3>
120
 
          <pre class="programlisting">#define             DMAP_RECORD(o)</pre>
121
 
          <p>
122
 
Casts a <a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="type">DMAPRecord</span></a> or derived pointer into a (DMAPRecord *) pointer.
123
 
Depending on the current debugging level, this function may invoke
124
 
certain runtime checks to identify invalid casts.
125
 
</p>
126
 
          <div class="variablelist">
127
 
            <table border="0">
128
 
              <col align="left" valign="top" />
129
 
              <tbody>
130
 
                <tr>
131
 
                  <td>
132
 
                    <p>
133
 
                      <span class="term"><em class="parameter"><code>o</code></em>�:</span>
134
 
                    </p>
135
 
                  </td>
136
 
                  <td>Object which is subject to casting.
137
 
</td>
138
 
                </tr>
139
 
              </tbody>
140
 
            </table>
141
 
          </div>
142
 
        </div>
143
 
        <hr xmlns="" />
144
 
        <div class="refsect2" title="IS_DMAP_RECORD()">
145
 
          <a id="IS-DMAP-RECORD:CAPS"></a>
146
 
          <h3>IS_DMAP_RECORD()</h3>
147
 
          <pre class="programlisting">#define             IS_DMAP_RECORD(o)</pre>
148
 
          <p>
149
 
Checks whether a valid <GTKDOCLINK xmlns="" HREF="GTypeInstance"><span xmlns="http://www.w3.org/1999/xhtml" class="type">GTypeInstance</span></GTKDOCLINK> pointer is of type <a class="link" href="DMAPRecord.html#DMAP-TYPE-RECORD:CAPS" title="DMAP_TYPE_RECORD"><code class="literal">DMAP_TYPE_RECORD</code></a>.
150
 
</p>
151
 
          <div class="variablelist">
152
 
            <table border="0">
153
 
              <col align="left" valign="top" />
154
 
              <tbody>
155
 
                <tr>
156
 
                  <td>
157
 
                    <p>
158
 
                      <span class="term"><em class="parameter"><code>o</code></em>�:</span>
159
 
                    </p>
160
 
                  </td>
161
 
                  <td>Instance to check for being a <a class="link" href="DMAPRecord.html#DMAP-TYPE-RECORD:CAPS" title="DMAP_TYPE_RECORD"><code class="literal">DMAP_TYPE_RECORD</code></a>.
162
 
</td>
163
 
                </tr>
164
 
              </tbody>
165
 
            </table>
166
 
          </div>
167
 
        </div>
168
 
        <hr xmlns="" />
169
 
        <div class="refsect2" title="DMAP_RECORD_GET_INTERFACE()">
170
 
          <a id="DMAP-RECORD-GET-INTERFACE:CAPS"></a>
171
 
          <h3>DMAP_RECORD_GET_INTERFACE()</h3>
172
 
          <pre class="programlisting">#define             DMAP_RECORD_GET_INTERFACE(o)</pre>
173
 
          <p>
174
 
</p>
175
 
          <div class="variablelist">
176
 
            <table border="0">
177
 
              <col align="left" valign="top" />
178
 
              <tbody>
179
 
                <tr>
180
 
                  <td>
181
 
                    <p>
182
 
                      <span class="term"><em class="parameter"><code>o</code></em>�:</span>
183
 
                    </p>
184
 
                  </td>
185
 
                  <td>
186
 
</td>
187
 
                </tr>
188
 
              </tbody>
189
 
            </table>
190
 
          </div>
191
 
        </div>
192
 
        <hr xmlns="" />
193
 
        <div class="refsect2" title="DMAPRecord">
194
 
          <a id="DMAPRecord-struct"></a>
195
 
          <h3>DMAPRecord</h3>
196
 
          <pre class="programlisting">typedef struct _DMAPRecord DMAPRecord;</pre>
197
 
          <p>
198
 
</p>
199
 
        </div>
200
 
        <hr xmlns="" />
201
 
        <div class="refsect2" title="DMAPRecordIface">
202
 
          <a id="DMAPRecordIface"></a>
203
 
          <h3>DMAPRecordIface</h3>
204
 
          <pre class="programlisting">typedef struct {
205
 
        GTypeInterface parent;
206
 
 
207
 
        GByteArray *(*to_blob) (DMAPRecord * record);
208
 
        DMAPRecord *(*set_from_blob) (DMAPRecord * record, GByteArray * blob);
209
 
} DMAPRecordIface;
210
 
</pre>
211
 
          <p>
212
 
</p>
213
 
        </div>
214
 
        <hr xmlns="" />
215
 
        <div class="refsect2" title="bitwise">
216
 
          <a id="bitwise"></a>
217
 
          <h3>bitwise</h3>
218
 
          <pre class="programlisting">typedef unsigned long long bitwise;
219
 
</pre>
220
 
          <p>
221
 
</p>
222
 
        </div>
223
 
        <hr xmlns="" />
224
 
        <div class="refsect2" title="enum DMAPMediaKind">
225
 
          <a id="DMAPMediaKind"></a>
226
 
          <h3>enum DMAPMediaKind</h3>
227
 
          <pre class="programlisting">typedef enum
228
 
{
229
 
        DMAP_MEDIA_KIND_MUSIC = 1,
230
 
        DMAP_MEDIA_KIND_MOVIE = 2
231
 
} DMAPMediaKind;
232
 
</pre>
233
 
          <p>
234
 
</p>
235
 
        </div>
236
 
        <hr xmlns="" />
237
 
        <div class="refsect2" title="dmap_record_get_type ()">
238
 
          <a id="dmap-record-get-type"></a>
239
 
          <h3>dmap_record_get_type ()</h3>
240
 
          <pre class="programlisting"><GTKDOCLINK xmlns="" HREF="GType"><span xmlns="http://www.w3.org/1999/xhtml" class="returnvalue">GType</span></GTKDOCLINK>               dmap_record_get_type                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
241
 
          <p>
242
 
</p>
243
 
          <div class="variablelist">
244
 
            <table border="0">
245
 
              <col align="left" valign="top" />
246
 
              <tbody>
247
 
                <tr>
248
 
                  <td>
249
 
                    <p>
250
 
                      <span class="term"><span class="emphasis"><em>Returns</em></span>�:</span>
251
 
                    </p>
252
 
                  </td>
253
 
                  <td>
254
 
</td>
255
 
                </tr>
256
 
              </tbody>
257
 
            </table>
258
 
          </div>
259
 
        </div>
260
 
        <hr xmlns="" />
261
 
        <div class="refsect2" title="dmap_record_to_blob ()">
262
 
          <a id="dmap-record-to-blob"></a>
263
 
          <h3>dmap_record_to_blob ()</h3>
264
 
          <pre class="programlisting"><GTKDOCLINK xmlns="" HREF="GByteArray"><span xmlns="http://www.w3.org/1999/xhtml" class="returnvalue">GByteArray</span></GTKDOCLINK> *        dmap_record_to_blob                 (<em class="parameter"><code><a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="type">DMAPRecord</span></a> *record</code></em>);</pre>
265
 
          <div class="variablelist">
266
 
            <table border="0">
267
 
              <col align="left" valign="top" />
268
 
              <tbody>
269
 
                <tr>
270
 
                  <td>
271
 
                    <p>
272
 
                      <span class="term"><em class="parameter"><code>record</code></em>�:</span>
273
 
                    </p>
274
 
                  </td>
275
 
                  <td>A DMAPRecord.
276
 
</td>
277
 
                </tr>
278
 
                <tr>
279
 
                  <td>
280
 
                    <p>
281
 
                      <span class="term"><span class="emphasis"><em>Returns</em></span>�:</span>
282
 
                    </p>
283
 
                  </td>
284
 
                  <td> A byte array representation of the record.
285
 
</td>
286
 
                </tr>
287
 
              </tbody>
288
 
            </table>
289
 
          </div>
290
 
        </div>
291
 
        <hr xmlns="" />
292
 
        <div class="refsect2" title="dmap_record_set_from_blob ()">
293
 
          <a id="dmap-record-set-from-blob"></a>
294
 
          <h3>dmap_record_set_from_blob ()</h3>
295
 
          <pre class="programlisting"><a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="returnvalue">DMAPRecord</span></a> *        dmap_record_set_from_blob           (<em class="parameter"><code><a class="link" href="DMAPRecord.html" title="DMAPRecord"><span class="type">DMAPRecord</span></a> *record</code></em>,
296
 
                                                         <em class="parameter"><code><GTKDOCLINK xmlns="" HREF="GByteArray"><span xmlns="http://www.w3.org/1999/xhtml" class="type">GByteArray</span></GTKDOCLINK> *blob</code></em>);</pre>
297
 
          <p>
298
 
</p>
299
 
          <div class="variablelist">
300
 
            <table border="0">
301
 
              <col align="left" valign="top" />
302
 
              <tbody>
303
 
                <tr>
304
 
                  <td>
305
 
                    <p>
306
 
                      <span class="term"><em class="parameter"><code>record</code></em>�:</span>
307
 
                    </p>
308
 
                  </td>
309
 
                  <td>
310
 
</td>
311
 
                </tr>
312
 
                <tr>
313
 
                  <td>
314
 
                    <p>
315
 
                      <span class="term"><em class="parameter"><code>blob</code></em>�:</span>
316
 
                    </p>
317
 
                  </td>
318
 
                  <td>
319
 
</td>
320
 
                </tr>
321
 
                <tr>
322
 
                  <td>
323
 
                    <p>
324
 
                      <span class="term"><span class="emphasis"><em>Returns</em></span>�:</span>
325
 
                    </p>
326
 
                  </td>
327
 
                  <td>
328
 
</td>
329
 
                </tr>
330
 
              </tbody>
331
 
            </table>
332
 
          </div>
333
 
        </div>
334
 
      </div>
335
 
    </div>
336
 
    <div xmlns="" class="footer"><hr />
337
 
          Generated by GTK-Doc V1.15</div>
338
 
  </body>
339
 
</html>
 
 
b'\\ No newline at end of file'