1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Rhythmbox Development Reference Manual: RhythmDBEntryType</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch04.html" title="RhythmDB">
<link rel="prev" href="ch04.html" title="RhythmDB">
<link rel="next" href="RhythmDBImportJob.html" title="RhythmDBImportJob">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#RhythmDBEntryType.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#RhythmDBEntryType.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#RhythmDBEntryType.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch04.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RhythmDBImportJob.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RhythmDBEntryType"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RhythmDBEntryType.top_of_page"></a>RhythmDBEntryType</span></h2>
<p>RhythmDBEntryType — Database entry type base class</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RhythmDBEntryType.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryTypeStringFunc" title="RhythmDBEntryTypeStringFunc ()">*RhythmDBEntryTypeStringFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryTypeBooleanFunc" title="RhythmDBEntryTypeBooleanFunc ()">*RhythmDBEntryTypeBooleanFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryTypeSyncFunc" title="RhythmDBEntryTypeSyncFunc ()">*RhythmDBEntryTypeSyncFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-entry-type-get-name" title="rhythmdb_entry_type_get_name ()">rhythmdb_entry_type_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-entry-get-playback-uri" title="rhythmdb_entry_get_playback_uri ()">rhythmdb_entry_get_playback_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-entry-update-availability" title="rhythmdb_entry_update_availability ()">rhythmdb_entry_update_availability</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-entry-created" title="rhythmdb_entry_created ()">rhythmdb_entry_created</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-entry-pre-destroy" title="rhythmdb_entry_pre_destroy ()">rhythmdb_entry_pre_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-entry-can-sync-metadata" title="rhythmdb_entry_can_sync_metadata ()">rhythmdb_entry_can_sync_metadata</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-entry-sync-metadata" title="rhythmdb_entry_sync_metadata ()">rhythmdb_entry_sync_metadata</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="RhythmDBEntryType.html#RHYTHMDB-ENTRY-TYPE-SONG:CAPS" title="RHYTHMDB_ENTRY_TYPE_SONG">RHYTHMDB_ENTRY_TYPE_SONG</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="RhythmDBEntryType.html#RHYTHMDB-ENTRY-TYPE-IMPORT-ERROR:CAPS" title="RHYTHMDB_ENTRY_TYPE_IMPORT_ERROR">RHYTHMDB_ENTRY_TYPE_IMPORT_ERROR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="RhythmDBEntryType.html#RHYTHMDB-ENTRY-TYPE-IGNORE:CAPS" title="RHYTHMDB_ENTRY_TYPE_IGNORE">RHYTHMDB_ENTRY_TYPE_IGNORE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="returnvalue">RhythmDBEntryType</span></a> *
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-get-song-entry-type" title="rhythmdb_get_song_entry_type ()">rhythmdb_get_song_entry_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="returnvalue">RhythmDBEntryType</span></a> *
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-get-error-entry-type" title="rhythmdb_get_error_entry_type ()">rhythmdb_get_error_entry_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="returnvalue">RhythmDBEntryType</span></a> *
</td>
<td class="function_name">
<a class="link" href="RhythmDBEntryType.html#rhythmdb-get-ignore-entry-type" title="rhythmdb_get_ignore_entry_type ()">rhythmdb_get_ignore_entry_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RhythmDBEntryType.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryCategory" title="enum RhythmDBEntryCategory"><span class="type">RhythmDBEntryCategory</span></a></td>
<td class="property_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryType--category" title="The “category” property">category</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *</td>
<td class="property_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryType--db" title="The “db” property">db</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryType--name" title="The “name” property">name</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryType--save-to-disk" title="The “save-to-disk” property">save-to-disk</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryType--type-data-size" title="The “type-data-size” property">type-data-size</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RhythmDBEntryType.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryCategory" title="enum RhythmDBEntryCategory">RhythmDBEntryCategory</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryAvailability" title="enum RhythmDBEntryAvailability">RhythmDBEntryAvailability</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryType-struct" title="struct RhythmDBEntryType">RhythmDBEntryType</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryTypeClass" title="struct RhythmDBEntryTypeClass">RhythmDBEntryTypeClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RhythmDBEntryType.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
<span class="lineart">╰──</span> RhythmDBEntryCategory
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> RhythmDBEntryType
</pre>
</div>
<div class="refsect1">
<a name="RhythmDBEntryType.description"></a><h2>Description</h2>
<p>This is the base class for database entry type classes, which provide
some aspects of the behaviour of database entry types. There are different
entry types for songs, radio streams, podcast feeds and episodes, and so on.</p>
<p>Plugins written in Python or Vala can create new entry types by subclassing
and overriding any methods required. Plugins written in C can create a new
instance of the RhythmDBEntryType base class and use its function pointer
members rather than subclassing.</p>
</div>
<div class="refsect1">
<a name="RhythmDBEntryType.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="RhythmDBEntryTypeStringFunc"></a><h3>RhythmDBEntryTypeStringFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
<span class="c_punctuation">(</span>*RhythmDBEntryTypeStringFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> *entry_type</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.5.2.8.2.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryTypeBooleanFunc"></a><h3>RhythmDBEntryTypeBooleanFunc ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
<span class="c_punctuation">(</span>*RhythmDBEntryTypeBooleanFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> *entry_type</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.5.2.8.3.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryTypeSyncFunc"></a><h3>RhythmDBEntryTypeSyncFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*RhythmDBEntryTypeSyncFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> *entry_type</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *changes</code></em>,
<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>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-entry-type-get-name"></a><h3>rhythmdb_entry_type_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
rhythmdb_entry_type_get_name (<em class="parameter"><code><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> *etype</code></em>);</pre>
<p>Returns the name of the entry type</p>
<div class="refsect3">
<a name="id-1.5.2.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>etype</p></td>
<td class="parameter_description"><p>a <a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.8.5.6"></a><h4>Returns</h4>
<p> entry type name</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-entry-get-playback-uri"></a><h3>rhythmdb_entry_get_playback_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
rhythmdb_entry_get_playback_uri (<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>Returns an allocated string containing the playback URI for <em class="parameter"><code>entry</code></em>
,
or NULL if the entry cannot be played.</p>
<div class="refsect3">
<a name="id-1.5.2.8.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.8.6.6"></a><h4>Returns</h4>
<p> playback URI or NULL</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-entry-update-availability"></a><h3>rhythmdb_entry_update_availability ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rhythmdb_entry_update_availability (<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>,
<em class="parameter"><code><a class="link" href="RhythmDBEntryType.html#RhythmDBEntryAvailability" title="enum RhythmDBEntryAvailability"><span class="type">RhythmDBEntryAvailability</span></a> avail</code></em>);</pre>
<p>Updates <em class="parameter"><code>entry</code></em>
to reflect its new availability.</p>
<div class="refsect3">
<a name="id-1.5.2.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>avail</p></td>
<td class="parameter_description"><p>an availability event</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-entry-created"></a><h3>rhythmdb_entry_created ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rhythmdb_entry_created (<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>Calls the entry type's post-creation method for <em class="parameter"><code>entry</code></em>
.</p>
<div class="refsect3">
<a name="id-1.5.2.8.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a newly created <span class="type">RhythmDBEntry</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-entry-pre-destroy"></a><h3>rhythmdb_entry_pre_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rhythmdb_entry_pre_destroy (<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>Calls the entry type's pre-deletion method for <em class="parameter"><code>entry</code></em>
.</p>
<div class="refsect3">
<a name="id-1.5.2.8.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-entry-can-sync-metadata"></a><h3>rhythmdb_entry_can_sync_metadata ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rhythmdb_entry_can_sync_metadata (<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>Calls the entry type's method to check if it can sync metadata for <em class="parameter"><code>entry</code></em>
.
Usually this is only true for entries backed by files, where tag-writing is
enabled, and the appropriate tag-writing facilities are available.</p>
<div class="refsect3">
<a name="id-1.5.2.8.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.2.8.10.6"></a><h4>Returns</h4>
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the entry can be synced</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-entry-sync-metadata"></a><h3>rhythmdb_entry_sync_metadata ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rhythmdb_entry_sync_metadata (<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *changes</code></em>,
<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>
<p>Calls the entry type's method to sync metadata changes for <em class="parameter"><code>entry</code></em>
.</p>
<div class="refsect3">
<a name="id-1.5.2.8.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>changes</p></td>
<td class="parameter_description"><p> a list of <a class="link" href="RhythmDB.html#RhythmDBEntryChange" title="RhythmDBEntryChange"><span class="type">RhythmDBEntryChange</span></a> structures. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> RB.RhythmDBEntryChange]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>returns error information</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RHYTHMDB-ENTRY-TYPE-SONG:CAPS"></a><h3>RHYTHMDB_ENTRY_TYPE_SONG</h3>
<pre class="programlisting">#define RHYTHMDB_ENTRY_TYPE_SONG (rhythmdb_get_song_entry_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RHYTHMDB-ENTRY-TYPE-IMPORT-ERROR:CAPS"></a><h3>RHYTHMDB_ENTRY_TYPE_IMPORT_ERROR</h3>
<pre class="programlisting">#define RHYTHMDB_ENTRY_TYPE_IMPORT_ERROR (rhythmdb_get_error_entry_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RHYTHMDB-ENTRY-TYPE-IGNORE:CAPS"></a><h3>RHYTHMDB_ENTRY_TYPE_IGNORE</h3>
<pre class="programlisting">#define RHYTHMDB_ENTRY_TYPE_IGNORE (rhythmdb_get_ignore_entry_type ())
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-get-song-entry-type"></a><h3>rhythmdb_get_song_entry_type ()</h3>
<pre class="programlisting"><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="returnvalue">RhythmDBEntryType</span></a> *
rhythmdb_get_song_entry_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> for normal songs.</p>
<div class="refsect3">
<a name="id-1.5.2.8.15.5"></a><h4>Returns</h4>
<p> the entry type for normal songs. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-get-error-entry-type"></a><h3>rhythmdb_get_error_entry_type ()</h3>
<pre class="programlisting"><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="returnvalue">RhythmDBEntryType</span></a> *
rhythmdb_get_error_entry_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> for import errors</p>
<div class="refsect3">
<a name="id-1.5.2.8.16.5"></a><h4>Returns</h4>
<p> the entry type for import errors. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rhythmdb-get-ignore-entry-type"></a><h3>rhythmdb_get_ignore_entry_type ()</h3>
<pre class="programlisting"><a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="returnvalue">RhythmDBEntryType</span></a> *
rhythmdb_get_ignore_entry_type (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <a class="link" href="RhythmDBEntryType.html" title="RhythmDBEntryType"><span class="type">RhythmDBEntryType</span></a> for ignored files</p>
<div class="refsect3">
<a name="id-1.5.2.8.17.5"></a><h4>Returns</h4>
<p> the entry type for ignored files. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="RhythmDBEntryType.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RhythmDBEntryCategory"></a><h3>enum RhythmDBEntryCategory</h3>
<p>Categories used to group entry types. These are used in a few places to control
handling of entries.</p>
<div class="refsect3">
<a name="id-1.5.2.9.2.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-NORMAL:CAPS"></a>RHYTHMDB_ENTRY_NORMAL</p></td>
<td class="enum_member_description">
<p>Normal files on disk</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-STREAM:CAPS"></a>RHYTHMDB_ENTRY_STREAM</p></td>
<td class="enum_member_description">
<p>Endless streams (eg shoutcast)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-CONTAINER:CAPS"></a>RHYTHMDB_ENTRY_CONTAINER</p></td>
<td class="enum_member_description">
<p>Containers for other entries (eg podcast feeds)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-VIRTUAL:CAPS"></a>RHYTHMDB_ENTRY_VIRTUAL</p></td>
<td class="enum_member_description">
<p>Things Rhythmbox shouldn't normally deal with</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryAvailability"></a><h3>enum RhythmDBEntryAvailability</h3>
<p>Various events that can result in changes to the entry's availability.</p>
<div class="refsect3">
<a name="id-1.5.2.9.3.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-AVAIL-CHECKED:CAPS"></a>RHYTHMDB_ENTRY_AVAIL_CHECKED</p></td>
<td class="enum_member_description">
<p>File was checked and found present</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-AVAIL-MOUNTED:CAPS"></a>RHYTHMDB_ENTRY_AVAIL_MOUNTED</p></td>
<td class="enum_member_description">
<p>Filesystem holding the file was mounted</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-AVAIL-UNMOUNTED:CAPS"></a>RHYTHMDB_ENTRY_AVAIL_UNMOUNTED</p></td>
<td class="enum_member_description">
<p>Filesystem holding the file was unmounted</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RHYTHMDB-ENTRY-AVAIL-NOT-FOUND:CAPS"></a>RHYTHMDB_ENTRY_AVAIL_NOT_FOUND</p></td>
<td class="enum_member_description">
<p>File was checked or played and could not be found</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryType-struct"></a><h3>struct RhythmDBEntryType</h3>
<pre class="programlisting">struct RhythmDBEntryType;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryTypeClass"></a><h3>struct RhythmDBEntryTypeClass</h3>
<pre class="programlisting">struct RhythmDBEntryTypeClass {
GObjectClass parent_class;
/* methods */
void (*entry_created) (RhythmDBEntryType *etype, RhythmDBEntry *entry);
void (*destroy_entry) (RhythmDBEntryType *etype, RhythmDBEntry *entry);
char * (*get_playback_uri) (RhythmDBEntryType *etype, RhythmDBEntry *entry);
void (*update_availability) (RhythmDBEntryType *etype, RhythmDBEntry *entry, RhythmDBEntryAvailability avail);
gboolean (*can_sync_metadata) (RhythmDBEntryType *etype, RhythmDBEntry *entry);
void (*sync_metadata) (RhythmDBEntryType *etype, RhythmDBEntry *entry, GSList *changes, GError **error);
};
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="RhythmDBEntryType.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RhythmDBEntryType--category"></a><h3>The <code class="literal">“category”</code> property</h3>
<pre class="programlisting"> “category” <a class="link" href="RhythmDBEntryType.html#RhythmDBEntryCategory" title="enum RhythmDBEntryCategory"><span class="type">RhythmDBEntryCategory</span></a></pre>
<p>The <a class="link" href="RhythmDBEntryType.html#RhythmDBEntryCategory" title="enum RhythmDBEntryCategory"><span class="type">RhythmDBEntryCategory</span></a> that this entry type fits into.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: RHYTHMDB_ENTRY_NORMAL</p>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryType--db"></a><h3>The <code class="literal">“db”</code> property</h3>
<pre class="programlisting"> “db” <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> *</pre>
<p>The <a class="link" href="RhythmDB.html" title="RhythmDB"><span class="type">RhythmDB</span></a> instance.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryType--name"></a><h3>The <code class="literal">“name”</code> property</h3>
<pre class="programlisting"> “name” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Entry type name. This must be unique.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryType--save-to-disk"></a><h3>The <code class="literal">“save-to-disk”</code> property</h3>
<pre class="programlisting"> “save-to-disk” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>If <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, entries of this type should be written to the
on-disk database.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="RhythmDBEntryType--type-data-size"></a><h3>The <code class="literal">“type-data-size”</code> property</h3>
<pre class="programlisting"> “type-data-size” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>The size of the type-specific data structure to allocate for each
entry of this type.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|
