← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/reference/tmpl/rhythmdb.sgml

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/tmpl/rhythmdb.sgml
 
1
<!-- ##### SECTION Title ##### -->
 
2
rhythmdb
 
3
 
 
4
<!-- ##### SECTION Short_Description ##### -->
 
5
 
 
6
 
 
7
<!-- ##### SECTION Long_Description ##### -->
 
8
<para>
 
9
 
 
10
</para>
 
11
 
 
12
<!-- ##### SECTION See_Also ##### -->
 
13
<para>
 
14
 
 
15
</para>
 
16
 
 
17
<!-- ##### SECTION Stability_Level ##### -->
 
18
 
 
19
 
 
20
<!-- ##### MACRO RHYTHMDB_TYPE ##### -->
 
21
<para>
 
22
 
 
23
</para>
 
24
 
 
25
 
 
26
 
 
27
<!-- ##### MACRO RHYTHMDB ##### -->
 
28
<para>
 
29
 
 
30
</para>
 
31
 
 
32
@o: 
 
33
 
 
34
 
 
35
<!-- ##### MACRO RHYTHMDB_IS ##### -->
 
36
<para>
 
37
 
 
38
</para>
 
39
 
 
40
@o: 
 
41
 
 
42
 
 
43
<!-- ##### MACRO RHYTHMDB_GET_CLASS ##### -->
 
44
<para>
 
45
 
 
46
</para>
 
47
 
 
48
@o: 
 
49
 
 
50
 
 
51
<!-- ##### TYPEDEF RhythmDBEntryType ##### -->
 
52
<para>
 
53
 
 
54
</para>
 
55
 
 
56
 
 
57
<!-- ##### MACRO RHYTHMDB_ENTRY_TYPE_SONG ##### -->
 
58
<para>
 
59
 
 
60
</para>
 
61
 
 
62
 
 
63
 
 
64
<!-- ##### MACRO RHYTHMDB_ENTRY_TYPE_IRADIO_STATION ##### -->
 
65
<para>
 
66
 
 
67
</para>
 
68
 
 
69
 
 
70
 
 
71
<!-- ##### ENUM RhythmDBQueryType ##### -->
 
72
<para>
 
73
 
 
74
</para>
 
75
 
 
76
@RHYTHMDB_QUERY_END: 
 
77
@RHYTHMDB_QUERY_DISJUNCTION: 
 
78
@RHYTHMDB_QUERY_SUBQUERY: 
 
79
@RHYTHMDB_QUERY_PROP_EQUALS: 
 
80
@RHYTHMDB_QUERY_PROP_LIKE: 
 
81
@RHYTHMDB_QUERY_PROP_NOT_LIKE: 
 
82
@RHYTHMDB_QUERY_PROP_GREATER: 
 
83
@RHYTHMDB_QUERY_PROP_LESS: 
 
84
@RHYTHMDB_QUERY_PROP_CURRENT_TIME_WITHIN: 
 
85
@RHYTHMDB_QUERY_PROP_CURRENT_TIME_NOT_WITHIN: 
 
86
 
 
87
<!-- ##### ENUM RhythmDBPropType ##### -->
 
88
<para>
 
89
 
 
90
</para>
 
91
 
 
92
@RHYTHMDB_PROP_TYPE: 
 
93
@RHYTHMDB_PROP_TITLE: 
 
94
@RHYTHMDB_PROP_GENRE: 
 
95
@RHYTHMDB_PROP_ARTIST: 
 
96
@RHYTHMDB_PROP_ALBUM: 
 
97
@RHYTHMDB_PROP_TRACK_NUMBER: 
 
98
@RHYTHMDB_PROP_DISC_NUMBER: 
 
99
@RHYTHMDB_PROP_DURATION: 
 
100
@RHYTHMDB_PROP_FILE_SIZE: 
 
101
@RHYTHMDB_PROP_LOCATION: 
 
102
@RHYTHMDB_PROP_MOUNTPOINT: 
 
103
@RHYTHMDB_PROP_MTIME: 
 
104
@RHYTHMDB_PROP_FIRST_SEEN: 
 
105
@RHYTHMDB_PROP_LAST_SEEN: 
 
106
@RHYTHMDB_PROP_RATING: 
 
107
@RHYTHMDB_PROP_PLAY_COUNT: 
 
108
@RHYTHMDB_PROP_LAST_PLAYED: 
 
109
@RHYTHMDB_PROP_BITRATE: 
 
110
@RHYTHMDB_PROP_DATE: 
 
111
@RHYTHMDB_PROP_TRACK_GAIN: 
 
112
@RHYTHMDB_PROP_TRACK_PEAK: 
 
113
@RHYTHMDB_PROP_ALBUM_GAIN: 
 
114
@RHYTHMDB_PROP_ALBUM_PEAK: 
 
115
@RHYTHMDB_PROP_MIMETYPE: 
 
116
@RHYTHMDB_PROP_TITLE_SORT_KEY: 
 
117
@RHYTHMDB_PROP_GENRE_SORT_KEY: 
 
118
@RHYTHMDB_PROP_ARTIST_SORT_KEY: 
 
119
@RHYTHMDB_PROP_ALBUM_SORT_KEY: 
 
120
@RHYTHMDB_PROP_TITLE_FOLDED: 
 
121
@RHYTHMDB_PROP_GENRE_FOLDED: 
 
122
@RHYTHMDB_PROP_ARTIST_FOLDED: 
 
123
@RHYTHMDB_PROP_ALBUM_FOLDED: 
 
124
@RHYTHMDB_PROP_LAST_PLAYED_STR: 
 
125
@RHYTHMDB_PROP_HIDDEN: 
 
126
@RHYTHMDB_PROP_PLAYBACK_ERROR: 
 
127
@RHYTHMDB_PROP_FIRST_SEEN_STR: 
 
128
@RHYTHMDB_PROP_SEARCH_MATCH: 
 
129
@RHYTHMDB_PROP_DESCRIPTION: 
 
130
@RHYTHMDB_PROP_SUBTITLE: 
 
131
@RHYTHMDB_PROP_SUMMARY: 
 
132
@RHYTHMDB_PROP_LANG: 
 
133
@RHYTHMDB_PROP_COPYRIGHT: 
 
134
@RHYTHMDB_PROP_IMAGE: 
 
135
@RHYTHMDB_PROP_POST_TIME: 
 
136
@RHYTHMDB_NUM_PROPERTIES: 
 
137
 
 
138
<!-- ##### FUNCTION rhythmdb_prop_get_type ##### -->
 
139
<para>
 
140
 
 
141
</para>
 
142
 
 
143
@Returns: 
 
144
 
 
145
 
 
146
<!-- ##### MACRO RHYTHMDB_TYPE_QUERY ##### -->
 
147
<para>
 
148
 
 
149
</para>
 
150
 
 
151
 
 
152
 
 
153
<!-- ##### MACRO RHYTHMDB_TYPE_PROP ##### -->
 
154
<para>
 
155
 
 
156
</para>
 
157
 
 
158
 
 
159
 
 
160
<!-- ##### STRUCT RhythmDBQueryData ##### -->
 
161
<para>
 
162
 
 
163
</para>
 
164
 
 
165
@type: 
 
166
@propid: 
 
167
@val: 
 
168
@subquery: 
 
169
 
 
170
<!-- ##### STRUCT RhythmDBEntry ##### -->
 
171
<para>
 
172
 
 
173
</para>
 
174
 
 
175
@refcount: 
 
176
@data: 
 
177
@type: 
 
178
@title: 
 
179
@artist: 
 
180
@album: 
 
181
@genre: 
 
182
@tracknum: 
 
183
@discnum: 
 
184
@duration: 
 
185
@bitrate: 
 
186
@track_gain: 
 
187
@track_peak: 
 
188
@album_gain: 
 
189
@album_peak: 
 
190
@date: 
 
191
@location: 
 
192
@mountpoint: 
 
193
@file_size: 
 
194
@mimetype: 
 
195
@inode: 
 
196
@first_seen: 
 
197
@last_seen: 
 
198
@rating: 
 
199
@play_count: 
 
200
@last_played: 
 
201
@last_played_str: 
 
202
@first_seen_str: 
 
203
@playback_error: 
 
204
@hidden: 
 
205
@podcast: 
 
206
 
 
207
<!-- ##### STRUCT RhythmDBEntryChange ##### -->
 
208
<para>
 
209
 
 
210
</para>
 
211
 
 
212
@prop: 
 
213
@old: 
 
214
@new: 
 
215
 
 
216
<!-- ##### FUNCTION rhythmdb_entry_get ##### -->
 
217
<para>
 
218
 
 
219
</para>
 
220
 
 
221
@entry: 
 
222
@propid: 
 
223
@val: 
 
224
 
 
225
 
 
226
<!-- ##### FUNCTION rhythmdb_entry_get_string ##### -->
 
227
<para>
 
228
 
 
229
</para>
 
230
 
 
231
@entry: 
 
232
@propid: 
 
233
@Returns: 
 
234
 
 
235
 
 
236
<!-- ##### FUNCTION rhythmdb_entry_get_boolean ##### -->
 
237
<para>
 
238
 
 
239
</para>
 
240
 
 
241
@entry: 
 
242
@propid: 
 
243
@Returns: 
 
244
 
 
245
 
 
246
<!-- ##### FUNCTION rhythmdb_entry_get_uint64 ##### -->
 
247
<para>
 
248
 
 
249
</para>
 
250
 
 
251
@entry: 
 
252
@propid: 
 
253
@Returns: 
 
254
 
 
255
 
 
256
<!-- ##### FUNCTION rhythmdb_entry_get_ulong ##### -->
 
257
<para>
 
258
 
 
259
</para>
 
260
 
 
261
@entry: 
 
262
@propid: 
 
263
@Returns: 
 
264
 
 
265
 
 
266
<!-- ##### FUNCTION rhythmdb_entry_get_double ##### -->
 
267
<para>
 
268
 
 
269
</para>
 
270
 
 
271
@entry: 
 
272
@propid: 
 
273
@Returns: 
 
274
 
 
275
 
 
276
<!-- ##### FUNCTION rb_refstring_get ##### -->
 
277
<para>
 
278
 
 
279
</para>
 
280
 
 
281
@val: 
 
282
@Returns: 
 
283
 
 
284
 
 
285
<!-- ##### FUNCTION rb_refstring_get_sort_key ##### -->
 
286
<para>
 
287
 
 
288
</para>
 
289
 
 
290
@val: 
 
291
@Returns: 
 
292
 
 
293
 
 
294
<!-- ##### FUNCTION rb_refstring_get_folded ##### -->
 
295
<para>
 
296
 
 
297
</para>
 
298
 
 
299
@val: 
 
300
@Returns: 
 
301
 
 
302
 
 
303
<!-- ##### ENUM RhythmDBError ##### -->
 
304
<para>
 
305
 
 
306
</para>
 
307
 
 
308
@RHYTHMDB_ERROR_ACCESS_FAILED: 
 
309
 
 
310
<!-- ##### MACRO RHYTHMDB_ERROR ##### -->
 
311
<para>
 
312
 
 
313
</para>
 
314
 
 
315
 
 
316
 
 
317
<!-- ##### FUNCTION rhythmdb_error_quark ##### -->
 
318
<para>
 
319
 
 
320
</para>
 
321
 
 
322
@Returns: 
 
323
 
 
324
 
 
325
<!-- ##### TYPEDEF RhythmDBPrivate ##### -->
 
326
<para>
 
327
 
 
328
</para>
 
329
 
 
330
 
 
331
<!-- ##### FUNCTION rhythmdb_get_type ##### -->
 
332
<para>
 
333
 
 
334
</para>
 
335
 
 
336
@Returns: 
 
337
 
 
338
 
 
339
<!-- ##### FUNCTION rhythmdb_new ##### -->
 
340
<para>
 
341
 
 
342
</para>
 
343
 
 
344
@name: 
 
345
@Returns: 
 
346
 
 
347
 
 
348
<!-- ##### FUNCTION rhythmdb_shutdown ##### -->
 
349
<para>
 
350
 
 
351
</para>
 
352
 
 
353
@db: 
 
354
 
 
355
 
 
356
<!-- ##### FUNCTION rhythmdb_load ##### -->
 
357
<para>
 
358
 
 
359
</para>
 
360
 
 
361
@db: 
 
362
 
 
363
 
 
364
<!-- ##### FUNCTION rhythmdb_save ##### -->
 
365
<para>
 
366
 
 
367
</para>
 
368
 
 
369
@db: 
 
370
 
 
371
 
 
372
<!-- ##### FUNCTION rhythmdb_save_async ##### -->
 
373
<para>
 
374
 
 
375
</para>
 
376
 
 
377
@db: 
 
378
 
 
379
 
 
380
<!-- ##### FUNCTION rhythmdb_commit ##### -->
 
381
<para>
 
382
 
 
383
</para>
 
384
 
 
385
@db: 
 
386
 
 
387
 
 
388
<!-- ##### FUNCTION rhythmdb_entry_is_editable ##### -->
 
389
<para>
 
390
 
 
391
</para>
 
392
 
 
393
@db: 
 
394
@entry: 
 
395
@Returns: 
 
396
 
 
397
 
 
398
<!-- ##### FUNCTION rhythmdb_entry_new ##### -->
 
399
<para>
 
400
 
 
401
</para>
 
402
 
 
403
@db: 
 
404
@type: 
 
405
@uri: 
 
406
@Returns: 
 
407
 
 
408
 
 
409
<!-- ##### FUNCTION rhythmdb_add_uri ##### -->
 
410
<para>
 
411
 
 
412
</para>
 
413
 
 
414
@db: 
 
415
@uri: 
 
416
 
 
417
 
 
418
<!-- ##### FUNCTION rhythmdb_entry_set ##### -->
 
419
<para>
 
420
 
 
421
</para>
 
422
 
 
423
@db: 
 
424
@entry: 
 
425
@propid: 
 
426
@value: 
 
427
 
 
428
 
 
429
<!-- ##### FUNCTION rhythmdb_entry_set_nonotify ##### -->
 
430
<para>
 
431
 
 
432
</para>
 
433
 
 
434
@db: 
 
435
@entry: 
 
436
@propid: 
 
437
@value: 
 
438
 
 
439
 
 
440
<!-- ##### FUNCTION rhythmdb_entry_set_uninserted ##### -->
 
441
<para>
 
442
 
 
443
</para>
 
444
 
 
445
@db: 
 
446
@entry: 
 
447
@propid: 
 
448
@value: 
 
449
 
 
450
 
 
451
<!-- ##### FUNCTION rhythmdb_entry_delete ##### -->
 
452
<para>
 
453
 
 
454
</para>
 
455
 
 
456
@db: 
 
457
@entry: 
 
458
 
 
459
 
 
460
<!-- ##### FUNCTION rhythmdb_entry_delete_by_type ##### -->
 
461
<para>
 
462
 
 
463
</para>
 
464
 
 
465
@db: 
 
466
@type: 
 
467
 
 
468
 
 
469
<!-- ##### FUNCTION rhythmdb_entry_lookup_by_location ##### -->
 
470
<para>
 
471
 
 
472
</para>
 
473
 
 
474
@db: 
 
475
@uri: 
 
476
@Returns: 
 
477
 
 
478
 
 
479
<!-- ##### FUNCTION rhythmdb_evaluate_query ##### -->
 
480
<para>
 
481
 
 
482
</para>
 
483
 
 
484
@db: 
 
485
@query: 
 
486
@entry: 
 
487
@Returns: 
 
488
 
 
489
 
 
490
<!-- ##### FUNCTION rhythmdb_entry_foreach ##### -->
 
491
<para>
 
492
 
 
493
</para>
 
494
 
 
495
@db: 
 
496
@func: 
 
497
@data: 
 
498
 
 
499
 
 
500
<!-- ##### FUNCTION rhythmdb_do_full_query ##### -->
 
501
<para>
 
502
 
 
503
</para>
 
504
 
 
505
@db: 
 
506
@main_model: 
 
507
@Varargs: 
 
508
 
 
509
 
 
510
<!-- ##### FUNCTION rhythmdb_do_full_query_parsed ##### -->
 
511
<para>
 
512
 
 
513
</para>
 
514
 
 
515
@db: 
 
516
@main_model: 
 
517
@query: 
 
518
 
 
519
 
 
520
<!-- ##### FUNCTION rhythmdb_do_full_query_async ##### -->
 
521
<para>
 
522
 
 
523
</para>
 
524
 
 
525
@db: 
 
526
@main_model: 
 
527
@Varargs: 
 
528
 
 
529
 
 
530
<!-- ##### FUNCTION rhythmdb_do_full_query_async_parsed ##### -->
 
531
<para>
 
532
 
 
533
</para>
 
534
 
 
535
@db: 
 
536
@main_model: 
 
537
@query: 
 
538
 
 
539
 
 
540
<!-- ##### FUNCTION rhythmdb_query_cancel ##### -->
 
541
<para>
 
542
 
 
543
</para>
 
544
 
 
545
@db: 
 
546
@query_model: 
 
547
 
 
548
 
 
549
<!-- ##### FUNCTION rhythmdb_entry_sync_mirrored ##### -->
 
550
<para>
 
551
 
 
552
</para>
 
553
 
 
554
@db: 
 
555
@entry: 
 
556
@propid: 
 
557
 
 
558
 
 
559
<!-- ##### FUNCTION rhythmdb_query_parse ##### -->
 
560
<para>
 
561
 
 
562
</para>
 
563
 
 
564
@db: 
 
565
@Varargs: 
 
566
@Returns: 
 
567
 
 
568
 
 
569
<!-- ##### FUNCTION rhythmdb_query_append ##### -->
 
570
<para>
 
571
 
 
572
</para>
 
573
 
 
574
@db: 
 
575
@query: 
 
576
@Varargs: 
 
577
 
 
578
 
 
579
<!-- ##### FUNCTION rhythmdb_query_free ##### -->
 
580
<para>
 
581
 
 
582
</para>
 
583
 
 
584
@query: 
 
585
 
 
586
 
 
587
<!-- ##### FUNCTION rhythmdb_query_copy ##### -->
 
588
<para>
 
589
 
 
590
</para>
 
591
 
 
592
@array: 
 
593
@Returns: 
 
594
 
 
595
 
 
596
<!-- ##### FUNCTION rhythmdb_query_serialize ##### -->
 
597
<para>
 
598
 
 
599
</para>
 
600
 
 
601
@db: 
 
602
@query: 
 
603
@node: 
 
604
 
 
605
 
 
606
<!-- ##### FUNCTION rhythmdb_query_deserialize ##### -->
 
607
<para>
 
608
 
 
609
</para>
 
610
 
 
611
@db: 
 
612
@node: 
 
613
@Returns: 
 
614
 
 
615
 
 
616
<!-- ##### FUNCTION rhythmdb_emit_entry_added ##### -->
 
617
<para>
 
618
 
 
619
</para>
 
620
 
 
621
@db: 
 
622
@entry: 
 
623
 
 
624
 
 
625
<!-- ##### FUNCTION rhythmdb_emit_entry_deleted ##### -->
 
626
<para>
 
627
 
 
628
</para>
 
629
 
 
630
@db: 
 
631
@entry: 
 
632
 
 
633
 
 
634
<!-- ##### FUNCTION rhythmdb_is_busy ##### -->
 
635
<para>
 
636
 
 
637
</para>
 
638
 
 
639
@db: 
 
640
@Returns: 
 
641
 
 
642
 
 
643
<!-- ##### FUNCTION rhythmdb_compute_status_normal ##### -->
 
644
<para>
 
645
 
 
646
</para>
 
647
 
 
648
@n_songs: 
 
649
@duration: 
 
650
@size: 
 
651
@Returns: 
 
652
 
 
653
 
 
654
<!-- ##### FUNCTION rhythmdb_entry_register_type ##### -->
 
655
<para>
 
656
 
 
657
</para>
 
658
 
 
659
@Returns: 
 
660
 
 
661
 
 
662
<!-- ##### FUNCTION rhythmdb_entry_song_get_type ##### -->
 
663
<para>
 
664
 
 
665
</para>
 
666
 
 
667
@Returns: 
 
668
 
 
669
 
 
670
<!-- ##### FUNCTION rhythmdb_entry_iradio_get_type ##### -->
 
671
<para>
 
672
 
 
673
</para>
 
674
 
 
675
@Returns: 
 
676
 
 
677
 
 
678
<!-- ##### FUNCTION rhythmdb_entry_icecast_get_type ##### -->
 
679
<para>
 
680
 
 
681
</para>
 
682
 
 
683
@Returns: 
 
684
 
 
685
 
 
686
<!-- ##### FUNCTION rhythmdb_get_property_type ##### -->
 
687
<para>
 
688
 
 
689
</para>
 
690
 
 
691
@db: 
 
692
@property_id: 
 
693
@Returns: 
 
694
 
 
695
 
 
696
<!-- ##### FUNCTION rhythmdb_entry_ref ##### -->
 
697
<para>
 
698
 
 
699
</para>
 
700
 
 
701
@db: 
 
702
@entry: 
 
703
 
 
704
 
 
705
<!-- ##### FUNCTION rhythmdb_entry_unref ##### -->
 
706
<para>
 
707
 
 
708
</para>
 
709
 
 
710
@db: 
 
711
@entry: 
 
712
 
 
713