| blob | fb5aaceedfaf5188a3f6c273e919a27aa894c82c |
1 <!-- ##### SECTION Title ##### -->
2 rhythmdb
4 <!-- ##### SECTION Short_Description ##### -->
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
10 </para>
12 <!-- ##### SECTION See_Also ##### -->
13 <para>
15 </para>
17 <!-- ##### SECTION Stability_Level ##### -->
20 <!-- ##### MACRO RHYTHMDB_TYPE ##### -->
21 <para>
23 </para>
27 <!-- ##### MACRO RHYTHMDB ##### -->
28 <para>
30 </para>
32 @o:
35 <!-- ##### MACRO RHYTHMDB_IS ##### -->
36 <para>
38 </para>
40 @o:
43 <!-- ##### MACRO RHYTHMDB_GET_CLASS ##### -->
44 <para>
46 </para>
48 @o:
51 <!-- ##### TYPEDEF RhythmDBEntryType ##### -->
52 <para>
54 </para>
57 <!-- ##### MACRO RHYTHMDB_ENTRY_TYPE_SONG ##### -->
58 <para>
60 </para>
64 <!-- ##### MACRO RHYTHMDB_ENTRY_TYPE_IRADIO_STATION ##### -->
65 <para>
67 </para>
71 <!-- ##### ENUM RhythmDBQueryType ##### -->
72 <para>
74 </para>
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_PREFIX:
83 @RHYTHMDB_QUERY_PROP_SUFFIX:
84 @RHYTHMDB_QUERY_PROP_GREATER:
85 @RHYTHMDB_QUERY_PROP_LESS:
86 @RHYTHMDB_QUERY_PROP_CURRENT_TIME_WITHIN:
87 @RHYTHMDB_QUERY_PROP_CURRENT_TIME_NOT_WITHIN:
88 @RHYTHMDB_QUERY_PROP_YEAR_EQUALS:
89 @RHYTHMDB_QUERY_PROP_YEAR_GREATER:
90 @RHYTHMDB_QUERY_PROP_YEAR_LESS:
92 <!-- ##### ENUM RhythmDBPropType ##### -->
93 <para>
95 </para>
97 @RHYTHMDB_PROP_TYPE:
98 @RHYTHMDB_PROP_ENTRY_ID:
99 @RHYTHMDB_PROP_TITLE:
100 @RHYTHMDB_PROP_GENRE:
101 @RHYTHMDB_PROP_ARTIST:
102 @RHYTHMDB_PROP_ALBUM:
103 @RHYTHMDB_PROP_TRACK_NUMBER:
104 @RHYTHMDB_PROP_DISC_NUMBER:
105 @RHYTHMDB_PROP_DURATION:
106 @RHYTHMDB_PROP_FILE_SIZE:
107 @RHYTHMDB_PROP_LOCATION:
108 @RHYTHMDB_PROP_MOUNTPOINT:
109 @RHYTHMDB_PROP_MTIME:
110 @RHYTHMDB_PROP_FIRST_SEEN:
111 @RHYTHMDB_PROP_LAST_SEEN:
112 @RHYTHMDB_PROP_RATING:
113 @RHYTHMDB_PROP_PLAY_COUNT:
114 @RHYTHMDB_PROP_LAST_PLAYED:
115 @RHYTHMDB_PROP_BITRATE:
116 @RHYTHMDB_PROP_DATE:
117 @RHYTHMDB_PROP_TRACK_GAIN:
118 @RHYTHMDB_PROP_TRACK_PEAK:
119 @RHYTHMDB_PROP_ALBUM_GAIN:
120 @RHYTHMDB_PROP_ALBUM_PEAK:
121 @RHYTHMDB_PROP_MIMETYPE:
122 @RHYTHMDB_PROP_TITLE_SORT_KEY:
123 @RHYTHMDB_PROP_GENRE_SORT_KEY:
124 @RHYTHMDB_PROP_ARTIST_SORT_KEY:
125 @RHYTHMDB_PROP_ALBUM_SORT_KEY:
126 @RHYTHMDB_PROP_TITLE_FOLDED:
127 @RHYTHMDB_PROP_GENRE_FOLDED:
128 @RHYTHMDB_PROP_ARTIST_FOLDED:
129 @RHYTHMDB_PROP_ALBUM_FOLDED:
130 @RHYTHMDB_PROP_LAST_PLAYED_STR:
131 @RHYTHMDB_PROP_HIDDEN:
132 @RHYTHMDB_PROP_PLAYBACK_ERROR:
133 @RHYTHMDB_PROP_FIRST_SEEN_STR:
134 @RHYTHMDB_PROP_LAST_SEEN_STR:
135 @RHYTHMDB_PROP_SEARCH_MATCH:
136 @RHYTHMDB_PROP_YEAR:
137 @RHYTHMDB_PROP_STATUS:
138 @RHYTHMDB_PROP_DESCRIPTION:
139 @RHYTHMDB_PROP_SUBTITLE:
140 @RHYTHMDB_PROP_SUMMARY:
141 @RHYTHMDB_PROP_LANG:
142 @RHYTHMDB_PROP_COPYRIGHT:
143 @RHYTHMDB_PROP_IMAGE:
144 @RHYTHMDB_PROP_POST_TIME:
145 @RHYTHMDB_PROP_MUSICBRAINZ_TRACKID:
146 @RHYTHMDB_NUM_PROPERTIES:
148 <!-- ##### MACRO RHYTHMDB_TYPE_QUERY ##### -->
149 <para>
151 </para>
155 <!-- ##### STRUCT RhythmDBQueryData ##### -->
156 <para>
158 </para>
160 @type:
161 @propid:
162 @val:
163 @subquery:
165 <!-- ##### TYPEDEF RhythmDBEntry ##### -->
166 <para>
168 </para>
171 <!-- ##### STRUCT RhythmDBEntryChange ##### -->
172 <para>
174 </para>
176 @prop:
177 @old:
178 @new:
180 <!-- ##### FUNCTION rhythmdb_entry_get ##### -->
181 <para>
183 </para>
185 @db:
186 @entry:
187 @propid:
188 @val:
191 <!-- ##### FUNCTION rhythmdb_entry_get_string ##### -->
192 <para>
194 </para>
196 @entry:
197 @propid:
198 @Returns:
201 <!-- ##### FUNCTION rhythmdb_entry_get_boolean ##### -->
202 <para>
204 </para>
206 @entry:
207 @propid:
208 @Returns:
211 <!-- ##### FUNCTION rhythmdb_entry_get_uint64 ##### -->
212 <para>
214 </para>
216 @entry:
217 @propid:
218 @Returns:
221 <!-- ##### FUNCTION rhythmdb_entry_get_ulong ##### -->
222 <para>
224 </para>
226 @entry:
227 @propid:
228 @Returns:
231 <!-- ##### FUNCTION rhythmdb_entry_get_double ##### -->
232 <para>
234 </para>
236 @entry:
237 @propid:
238 @Returns:
241 <!-- ##### FUNCTION rb_refstring_get ##### -->
242 <para>
244 </para>
246 @val:
247 @Returns:
250 <!-- ##### FUNCTION rb_refstring_get_sort_key ##### -->
251 <para>
253 </para>
255 @val:
256 @Returns:
259 <!-- ##### FUNCTION rb_refstring_get_folded ##### -->
260 <para>
262 </para>
264 @val:
265 @Returns:
268 <!-- ##### ENUM RhythmDBError ##### -->
269 <para>
271 </para>
273 @RHYTHMDB_ERROR_ACCESS_FAILED:
275 <!-- ##### MACRO RHYTHMDB_ERROR ##### -->
276 <para>
278 </para>
282 <!-- ##### FUNCTION rhythmdb_error_quark ##### -->
283 <para>
285 </para>
287 @Returns:
290 <!-- ##### TYPEDEF RhythmDBPrivate ##### -->
291 <para>
293 </para>
296 <!-- ##### FUNCTION rhythmdb_get_type ##### -->
297 <para>
299 </para>
301 @Returns:
304 <!-- ##### FUNCTION rhythmdb_new ##### -->
305 <para>
307 </para>
309 @name:
310 @Returns:
313 <!-- ##### FUNCTION rhythmdb_shutdown ##### -->
314 <para>
316 </para>
318 @db:
321 <!-- ##### FUNCTION rhythmdb_load ##### -->
322 <para>
324 </para>
326 @db:
329 <!-- ##### FUNCTION rhythmdb_save ##### -->
330 <para>
332 </para>
334 @db:
337 <!-- ##### FUNCTION rhythmdb_save_async ##### -->
338 <para>
340 </para>
342 @db:
345 <!-- ##### FUNCTION rhythmdb_commit ##### -->
346 <para>
348 </para>
350 @db:
353 <!-- ##### FUNCTION rhythmdb_entry_is_editable ##### -->
354 <para>
356 </para>
358 @db:
359 @entry:
360 @Returns:
363 <!-- ##### FUNCTION rhythmdb_entry_new ##### -->
364 <para>
366 </para>
368 @db:
369 @type:
370 @uri:
371 @Returns:
374 <!-- ##### FUNCTION rhythmdb_add_uri ##### -->
375 <para>
377 </para>
379 @db:
380 @uri:
383 <!-- ##### FUNCTION rhythmdb_entry_set ##### -->
384 <para>
386 </para>
388 @db:
389 @entry:
390 @propid:
391 @value:
394 <!-- ##### FUNCTION rhythmdb_entry_delete ##### -->
395 <para>
397 </para>
399 @db:
400 @entry:
403 <!-- ##### FUNCTION rhythmdb_entry_delete_by_type ##### -->
404 <para>
406 </para>
408 @db:
409 @type:
412 <!-- ##### FUNCTION rhythmdb_entry_lookup_by_location ##### -->
413 <para>
415 </para>
417 @db:
418 @uri:
419 @Returns:
422 <!-- ##### FUNCTION rhythmdb_evaluate_query ##### -->
423 <para>
425 </para>
427 @db:
428 @query:
429 @entry:
430 @Returns:
433 <!-- ##### FUNCTION rhythmdb_entry_foreach ##### -->
434 <para>
436 </para>
438 @db:
439 @func:
440 @data:
443 <!-- ##### FUNCTION rhythmdb_do_full_query ##### -->
444 <para>
446 </para>
448 @db:
449 @results:
450 @Varargs:
453 <!-- ##### FUNCTION rhythmdb_do_full_query_parsed ##### -->
454 <para>
456 </para>
458 @db:
459 @results:
460 @query:
463 <!-- ##### FUNCTION rhythmdb_do_full_query_async ##### -->
464 <para>
466 </para>
468 @db:
469 @results:
470 @Varargs:
473 <!-- ##### FUNCTION rhythmdb_do_full_query_async_parsed ##### -->
474 <para>
476 </para>
478 @db:
479 @results:
480 @query:
483 <!-- ##### FUNCTION rhythmdb_query_parse ##### -->
484 <para>
486 </para>
488 @db:
489 @Varargs:
490 @Returns:
493 <!-- ##### FUNCTION rhythmdb_query_append ##### -->
494 <para>
496 </para>
498 @db:
499 @query:
500 @Varargs:
503 <!-- ##### FUNCTION rhythmdb_query_free ##### -->
504 <para>
506 </para>
508 @query:
511 <!-- ##### FUNCTION rhythmdb_query_copy ##### -->
512 <para>
514 </para>
516 @array:
517 @Returns:
520 <!-- ##### FUNCTION rhythmdb_query_serialize ##### -->
521 <para>
523 </para>
525 @db:
526 @query:
527 @node:
530 <!-- ##### FUNCTION rhythmdb_query_deserialize ##### -->
531 <para>
533 </para>
535 @db:
536 @node:
537 @Returns:
540 <!-- ##### FUNCTION rhythmdb_emit_entry_added ##### -->
541 <para>
543 </para>
545 @db:
546 @entry:
549 <!-- ##### FUNCTION rhythmdb_emit_entry_deleted ##### -->
550 <para>
552 </para>
554 @db:
555 @entry:
558 <!-- ##### FUNCTION rhythmdb_is_busy ##### -->
559 <para>
561 </para>
563 @db:
564 @Returns:
567 <!-- ##### FUNCTION rhythmdb_compute_status_normal ##### -->
568 <para>
570 </para>
572 @n_songs:
573 @duration:
574 @size:
575 @singular:
576 @plural:
577 @Returns:
580 <!-- ##### FUNCTION rhythmdb_entry_register_type ##### -->
581 <para>
583 </para>
585 @db:
586 @name:
587 @Returns:
590 <!-- ##### FUNCTION rhythmdb_entry_song_get_type ##### -->
591 <para>
593 </para>
595 @Returns:
598 <!-- ##### FUNCTION rhythmdb_entry_iradio_get_type ##### -->
599 <para>
601 </para>
603 @Returns:
606 <!-- ##### FUNCTION rhythmdb_get_property_type ##### -->
607 <para>
609 </para>
611 @db:
612 @property_id:
613 @Returns:
616 <!-- ##### FUNCTION rhythmdb_entry_ref ##### -->
617 <para>
619 </para>
621 @entry:
622 @Returns:
625 <!-- ##### FUNCTION rhythmdb_entry_unref ##### -->
626 <para>
628 </para>
630 @entry: