3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<title>rb-playlist-source</title>
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<link rel="start" href="index.html" title="Rhythmbox Development Reference Manual">
7
<link rel="up" href="ch07.html" title="Sources">
8
<link rel="prev" href="rhythmbox-rb-playlist-source-recorder.html" title="rb-playlist-source-recorder">
9
<link rel="next" href="rhythmbox-rb-sourcelist-model.html" title="rb-sourcelist-model">
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
11
<link rel="stylesheet" href="style.css" type="text/css">
12
<link rel="chapter" href="ch01.html" title="IRadio UI">
13
<link rel="chapter" href="ch02.html" title="Lib">
14
<link rel="chapter" href="ch03.html" title="Metadata">
15
<link rel="chapter" href="ch04.html" title="Player">
16
<link rel="chapter" href="ch05.html" title="RhythmDB">
17
<link rel="chapter" href="ch06.html" title="Shell">
18
<link rel="chapter" href="ch07.html" title="Sources">
19
<link rel="chapter" href="ch08.html" title="Widgets">
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
22
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
23
<td><a accesskey="p" href="rhythmbox-rb-playlist-source-recorder.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
24
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
26
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
27
<td><a accesskey="n" href="rhythmbox-rb-sourcelist-model.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
29
<div class="refentry" lang="en">
30
<a name="rhythmbox-rb-playlist-source"></a><div class="titlepage"></div>
31
<div class="refnamediv"><table width="100%"><tr>
33
<h2><span class="refentrytitle">rb-playlist-source</span></h2>
34
<p>rb-playlist-source — </p>
36
<td valign="top" align="right"></td>
38
<div class="refsynopsisdiv">
40
<pre class="synopsis">
44
typedef <a href="rhythmbox-rb-playlist-source.html#RBPlaylistSourcePrivate">RBPlaylistSourcePrivate</a>;
45
RBSource* <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-new">rb_playlist_source_new</a> (RBShell *shell,
48
<a href="rhythmbox-rhythmdb.html#RhythmDBEntryType">RhythmDBEntryType</a> entry_type);
49
RBSource* <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-new-from-xml">rb_playlist_source_new_from_xml</a> (RBShell *shell,
51
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-set-query">rb_playlist_source_set_query</a> (RBPlaylistSource *source,
58
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-get-query">rb_playlist_source_get_query</a> (RBPlaylistSource *source,
63
const char **sort_key,
65
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-save-playlist">rb_playlist_source_save_playlist</a>
66
(RBPlaylistSource *source,
68
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-save-to-xml">rb_playlist_source_save_to_xml</a> (RBPlaylistSource *source,
70
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-burn-playlist">rb_playlist_source_burn_playlist</a>
71
(RBPlaylistSource *source);
72
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-add-entry">rb_playlist_source_add_entry</a> (RBPlaylistSource *source,
73
<a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);
74
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-remove-entry">rb_playlist_source_remove_entry</a> (RBPlaylistSource *source,
75
<a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);
76
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-add-location">rb_playlist_source_add_location</a> (RBPlaylistSource *source,
77
const char *location);
78
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-add-locations">rb_playlist_source_add_locations</a>
79
(RBPlaylistSource *source,
81
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-remove-location">rb_playlist_source_remove_location</a>
82
(RBPlaylistSource *source,
83
const char *location);
84
void <a href="rhythmbox-rb-playlist-source.html#rb-playlist-source-delete">rb_playlist_source_delete</a> (RBPlaylistSource *source);
88
<div class="refsect1" lang="en">
89
<a name="id2591179"></a><h2>Description</h2>
94
<div class="refsect1" lang="en">
95
<a name="id2591190"></a><h2>Details</h2>
96
<div class="refsect2" lang="en">
97
<a name="id2591197"></a><h3>
98
<a name="RBPlaylistSourcePrivate"></a>RBPlaylistSourcePrivate</h3>
99
<a class="indexterm" name="id2591206"></a><pre class="programlisting">typedef struct RBPlaylistSourcePrivate RBPlaylistSourcePrivate;
106
<div class="refsect2" lang="en">
107
<a name="id2571034"></a><h3>
108
<a name="rb-playlist-source-new"></a>rb_playlist_source_new ()</h3>
109
<a class="indexterm" name="id2571043"></a><pre class="programlisting">RBSource* rb_playlist_source_new (RBShell *shell,
112
<a href="rhythmbox-rhythmdb.html#RhythmDBEntryType">RhythmDBEntryType</a> entry_type);</pre>
116
<div class="variablelist"><table border="0">
117
<col align="left" valign="top">
121
<span class="term"><em class="parameter"><code>shell</code></em> :</span></td>
127
<span class="term"><em class="parameter"><code>smart</code></em> :</span></td>
133
<span class="term"><em class="parameter"><code>local</code></em> :</span></td>
139
<span class="term"><em class="parameter"><code>entry_type</code></em> :</span></td>
145
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
155
<div class="refsect2" lang="en">
156
<a name="id2571162"></a><h3>
157
<a name="rb-playlist-source-new-from-xml"></a>rb_playlist_source_new_from_xml ()</h3>
158
<a class="indexterm" name="id2571171"></a><pre class="programlisting">RBSource* rb_playlist_source_new_from_xml (RBShell *shell,
159
xmlNodePtr node);</pre>
163
<div class="variablelist"><table border="0">
164
<col align="left" valign="top">
168
<span class="term"><em class="parameter"><code>shell</code></em> :</span></td>
174
<span class="term"><em class="parameter"><code>node</code></em> :</span></td>
180
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
190
<div class="refsect2" lang="en">
191
<a name="id2571248"></a><h3>
192
<a name="rb-playlist-source-set-query"></a>rb_playlist_source_set_query ()</h3>
193
<a class="indexterm" name="id2571259"></a><pre class="programlisting">void rb_playlist_source_set_query (RBPlaylistSource *source,
198
const char *sort_key,
199
gint sort_order);</pre>
203
<div class="variablelist"><table border="0">
204
<col align="left" valign="top">
208
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
214
<span class="term"><em class="parameter"><code>query</code></em> :</span></td>
220
<span class="term"><em class="parameter"><code>limit_count</code></em> :</span></td>
226
<span class="term"><em class="parameter"><code>limit_mb</code></em> :</span></td>
232
<span class="term"><em class="parameter"><code>limit_time</code></em> :</span></td>
238
<span class="term"><em class="parameter"><code>sort_key</code></em> :</span></td>
244
<span class="term"><em class="parameter"><code>sort_order</code></em> :</span></td>
254
<div class="refsect2" lang="en">
255
<a name="id2571431"></a><h3>
256
<a name="rb-playlist-source-get-query"></a>rb_playlist_source_get_query ()</h3>
257
<a class="indexterm" name="id2571442"></a><pre class="programlisting">void rb_playlist_source_get_query (RBPlaylistSource *source,
262
const char **sort_key,
263
gint *sort_order);</pre>
267
<div class="variablelist"><table border="0">
268
<col align="left" valign="top">
272
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
278
<span class="term"><em class="parameter"><code>query</code></em> :</span></td>
284
<span class="term"><em class="parameter"><code>limit_count</code></em> :</span></td>
290
<span class="term"><em class="parameter"><code>limit_mb</code></em> :</span></td>
296
<span class="term"><em class="parameter"><code>limit_time</code></em> :</span></td>
302
<span class="term"><em class="parameter"><code>sort_key</code></em> :</span></td>
308
<span class="term"><em class="parameter"><code>sort_order</code></em> :</span></td>
318
<div class="refsect2" lang="en">
319
<a name="id2592528"></a><h3>
320
<a name="rb-playlist-source-save-playlist"></a>rb_playlist_source_save_playlist ()</h3>
321
<a class="indexterm" name="id2592538"></a><pre class="programlisting">void rb_playlist_source_save_playlist
322
(RBPlaylistSource *source,
323
const char *uri);</pre>
327
<div class="variablelist"><table border="0">
328
<col align="left" valign="top">
332
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
338
<span class="term"><em class="parameter"><code>uri</code></em> :</span></td>
348
<div class="refsect2" lang="en">
349
<a name="id2592606"></a><h3>
350
<a name="rb-playlist-source-save-to-xml"></a>rb_playlist_source_save_to_xml ()</h3>
351
<a class="indexterm" name="id2592617"></a><pre class="programlisting">void rb_playlist_source_save_to_xml (RBPlaylistSource *source,
352
xmlNodePtr node);</pre>
356
<div class="variablelist"><table border="0">
357
<col align="left" valign="top">
361
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
367
<span class="term"><em class="parameter"><code>node</code></em> :</span></td>
377
<div class="refsect2" lang="en">
378
<a name="id2592684"></a><h3>
379
<a name="rb-playlist-source-burn-playlist"></a>rb_playlist_source_burn_playlist ()</h3>
380
<a class="indexterm" name="id2592695"></a><pre class="programlisting">void rb_playlist_source_burn_playlist
381
(RBPlaylistSource *source);</pre>
385
<div class="variablelist"><table border="0">
386
<col align="left" valign="top">
389
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
398
<div class="refsect2" lang="en">
399
<a name="id2592742"></a><h3>
400
<a name="rb-playlist-source-add-entry"></a>rb_playlist_source_add_entry ()</h3>
401
<a class="indexterm" name="id2592753"></a><pre class="programlisting">void rb_playlist_source_add_entry (RBPlaylistSource *source,
402
<a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);</pre>
406
<div class="variablelist"><table border="0">
407
<col align="left" valign="top">
411
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
417
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
427
<div class="refsect2" lang="en">
428
<a name="id2592821"></a><h3>
429
<a name="rb-playlist-source-remove-entry"></a>rb_playlist_source_remove_entry ()</h3>
430
<a class="indexterm" name="id2592832"></a><pre class="programlisting">void rb_playlist_source_remove_entry (RBPlaylistSource *source,
431
<a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);</pre>
435
<div class="variablelist"><table border="0">
436
<col align="left" valign="top">
440
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
446
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
456
<div class="refsect2" lang="en">
457
<a name="id2592900"></a><h3>
458
<a name="rb-playlist-source-add-location"></a>rb_playlist_source_add_location ()</h3>
459
<a class="indexterm" name="id2592910"></a><pre class="programlisting">void rb_playlist_source_add_location (RBPlaylistSource *source,
460
const char *location);</pre>
464
<div class="variablelist"><table border="0">
465
<col align="left" valign="top">
469
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
475
<span class="term"><em class="parameter"><code>location</code></em> :</span></td>
485
<div class="refsect2" lang="en">
486
<a name="id2592978"></a><h3>
487
<a name="rb-playlist-source-add-locations"></a>rb_playlist_source_add_locations ()</h3>
488
<a class="indexterm" name="id2592989"></a><pre class="programlisting">void rb_playlist_source_add_locations
489
(RBPlaylistSource *source,
490
GList *locations);</pre>
494
<div class="variablelist"><table border="0">
495
<col align="left" valign="top">
499
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
505
<span class="term"><em class="parameter"><code>locations</code></em> :</span></td>
515
<div class="refsect2" lang="en">
516
<a name="id2593058"></a><h3>
517
<a name="rb-playlist-source-remove-location"></a>rb_playlist_source_remove_location ()</h3>
518
<a class="indexterm" name="id2593069"></a><pre class="programlisting">void rb_playlist_source_remove_location
519
(RBPlaylistSource *source,
520
const char *location);</pre>
524
<div class="variablelist"><table border="0">
525
<col align="left" valign="top">
529
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
535
<span class="term"><em class="parameter"><code>location</code></em> :</span></td>
545
<div class="refsect2" lang="en">
546
<a name="id2593137"></a><h3>
547
<a name="rb-playlist-source-delete"></a>rb_playlist_source_delete ()</h3>
548
<a class="indexterm" name="id2593147"></a><pre class="programlisting">void rb_playlist_source_delete (RBPlaylistSource *source);</pre>
552
<div class="variablelist"><table border="0">
553
<col align="left" valign="top">
556
<span class="term"><em class="parameter"><code>source</code></em> :</span></td>
566
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
567
<td align="left"><a accesskey="p" href="rhythmbox-rb-playlist-source-recorder.html"><b><< rb-playlist-source-recorder</b></a></td>
568
<td align="right"><a accesskey="n" href="rhythmbox-rb-sourcelist-model.html"><b>rb-sourcelist-model >></b></a></td>