← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-playlist-manager.xml

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/xml/rb-playlist-manager.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="rhythmbox-rb-playlist-manager">
 
5
<refmeta>
 
6
<refentrytitle>rb-playlist-manager</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-playlist-manager</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
enum        <link linkend="RBPlaylistManagerError">RBPlaylistManagerError</link>;
 
22
#define     <link linkend="RB-PLAYLIST-MANAGER-ERROR:CAPS">RB_PLAYLIST_MANAGER_ERROR</link>
 
23
<link linkend="GQuark">GQuark</link>      <link linkend="rb-playlist-manager-error-quark">rb_playlist_manager_error_quark</link> (void);
 
24
typedef     <link linkend="RBPlaylistManagerPrivate">RBPlaylistManagerPrivate</link>;
 
25
<link linkend="RBPlaylistManager">RBPlaylistManager</link>* <link linkend="rb-playlist-manager-new">rb_playlist_manager_new</link>  (<link linkend="RBShell">RBShell</link> *shell,
 
26
                                             <link linkend="RBSourceList">RBSourceList</link> *sourcelist,
 
27
                                             <link linkend="RBLibrarySource">RBLibrarySource</link> *libsource,
 
28
                                             <link linkend="RBIRadioSource">RBIRadioSource</link> *iradio_source);
 
29
<link linkend="gboolean">gboolean</link>    <link linkend="rb-playlist-manager-parse-file">rb_playlist_manager_parse_file</link>  (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
30
                                             const <link linkend="char">char</link> *uri,
 
31
                                             <link linkend="GError">GError</link> **error);
 
32
<link linkend="void">void</link>        <link linkend="rb-playlist-manager-set-source">rb_playlist_manager_set_source</link>  (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
33
                                             <link linkend="RBSource">RBSource</link> *player);
 
34
<link linkend="void">void</link>        <link linkend="rb-playlist-manager-load-legacy-playlists">rb_playlist_manager_load_legacy_playlists</link>
 
35
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr);
 
36
<link linkend="void">void</link>        <link linkend="rb-playlist-manager-load-playlists">rb_playlist_manager_load_playlists</link>
 
37
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr);
 
38
<link linkend="void">void</link>        <link linkend="rb-playlist-manager-save-playlists">rb_playlist_manager_save_playlists</link>
 
39
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
40
                                             <link linkend="gboolean">gboolean</link> force);
 
41
<link linkend="RBSource">RBSource</link>*   <link linkend="rb-playlist-manager-new-playlist">rb_playlist_manager_new_playlist</link>
 
42
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
43
                                             const <link linkend="char">char</link> *suggested_name,
 
44
                                             <link linkend="gboolean">gboolean</link> automatic);
 
45
<link linkend="GList">GList</link>*      <link linkend="rb-playlist-manager-get-playlists">rb_playlist_manager_get_playlists</link>
 
46
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *manager);
 
47
 
 
48
</synopsis>
 
49
</refsynopsisdiv>
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
<refsect1>
 
60
<title>Description</title>
 
61
<para>
 
62
 
 
63
</para>
 
64
</refsect1>
 
65
 
 
66
<refsect1>
 
67
<title>Details</title>
 
68
<refsect2>
 
69
<title><anchor id="RBPlaylistManagerError"/>enum RBPlaylistManagerError</title>
 
70
<indexterm><primary>RBPlaylistManagerError</primary></indexterm><programlisting>typedef enum
 
71
{
 
72
        RB_PLAYLIST_MANAGER_ERROR_PARSE
 
73
} RBPlaylistManagerError;
 
74
</programlisting>
 
75
<para>
 
76
 
 
77
</para></refsect2>
 
78
<refsect2>
 
79
<title><anchor id="RB-PLAYLIST-MANAGER-ERROR:CAPS"/>RB_PLAYLIST_MANAGER_ERROR</title>
 
80
<indexterm><primary>RB_PLAYLIST_MANAGER_ERROR</primary></indexterm><programlisting>#define RB_PLAYLIST_MANAGER_ERROR rb_playlist_manager_error_quark ()
 
81
</programlisting>
 
82
<para>
 
83
 
 
84
</para></refsect2>
 
85
<refsect2>
 
86
<title><anchor id="rb-playlist-manager-error-quark"/>rb_playlist_manager_error_quark ()</title>
 
87
<indexterm><primary>rb_playlist_manager_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>      rb_playlist_manager_error_quark (void);</programlisting>
 
88
<para>
 
89
 
 
90
</para><variablelist role="params">
 
91
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
92
 
 
93
 
 
94
</simpara></listitem></varlistentry>
 
95
</variablelist></refsect2>
 
96
<refsect2>
 
97
<title><anchor id="RBPlaylistManagerPrivate"/>RBPlaylistManagerPrivate</title>
 
98
<indexterm><primary>RBPlaylistManagerPrivate</primary></indexterm><programlisting>typedef struct RBPlaylistManagerPrivate RBPlaylistManagerPrivate;
 
99
</programlisting>
 
100
<para>
 
101
 
 
102
</para></refsect2>
 
103
<refsect2>
 
104
<title><anchor id="rb-playlist-manager-new"/>rb_playlist_manager_new ()</title>
 
105
<indexterm><primary>rb_playlist_manager_new</primary></indexterm><programlisting><link linkend="RBPlaylistManager">RBPlaylistManager</link>* rb_playlist_manager_new  (<link linkend="RBShell">RBShell</link> *shell,
 
106
                                             <link linkend="RBSourceList">RBSourceList</link> *sourcelist,
 
107
                                             <link linkend="RBLibrarySource">RBLibrarySource</link> *libsource,
 
108
                                             <link linkend="RBIRadioSource">RBIRadioSource</link> *iradio_source);</programlisting>
 
109
<para>
 
110
 
 
111
</para><variablelist role="params">
 
112
<varlistentry><term><parameter>shell</parameter>&nbsp;:</term>
 
113
<listitem><simpara>
 
114
</simpara></listitem></varlistentry>
 
115
<varlistentry><term><parameter>sourcelist</parameter>&nbsp;:</term>
 
116
<listitem><simpara>
 
117
</simpara></listitem></varlistentry>
 
118
<varlistentry><term><parameter>libsource</parameter>&nbsp;:</term>
 
119
<listitem><simpara>
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><parameter>iradio_source</parameter>&nbsp;:</term>
 
122
<listitem><simpara>
 
123
</simpara></listitem></varlistentry>
 
124
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
125
 
 
126
 
 
127
</simpara></listitem></varlistentry>
 
128
</variablelist></refsect2>
 
129
<refsect2>
 
130
<title><anchor id="rb-playlist-manager-parse-file"/>rb_playlist_manager_parse_file ()</title>
 
131
<indexterm><primary>rb_playlist_manager_parse_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_playlist_manager_parse_file  (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
132
                                             const <link linkend="char">char</link> *uri,
 
133
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
134
<para>
 
135
 
 
136
</para><variablelist role="params">
 
137
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
 
138
<listitem><simpara>
 
139
</simpara></listitem></varlistentry>
 
140
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
141
<listitem><simpara>
 
142
</simpara></listitem></varlistentry>
 
143
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
144
<listitem><simpara>
 
145
</simpara></listitem></varlistentry>
 
146
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
147
 
 
148
 
 
149
</simpara></listitem></varlistentry>
 
150
</variablelist></refsect2>
 
151
<refsect2>
 
152
<title><anchor id="rb-playlist-manager-set-source"/>rb_playlist_manager_set_source ()</title>
 
153
<indexterm><primary>rb_playlist_manager_set_source</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_manager_set_source  (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
154
                                             <link linkend="RBSource">RBSource</link> *player);</programlisting>
 
155
<para>
 
156
 
 
157
</para><variablelist role="params">
 
158
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
 
159
<listitem><simpara>
 
160
</simpara></listitem></varlistentry>
 
161
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
162
<listitem><simpara>
 
163
 
 
164
 
 
165
</simpara></listitem></varlistentry>
 
166
</variablelist></refsect2>
 
167
<refsect2>
 
168
<title><anchor id="rb-playlist-manager-load-legacy-playlists"/>rb_playlist_manager_load_legacy_playlists ()</title>
 
169
<indexterm><primary>rb_playlist_manager_load_legacy_playlists</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_manager_load_legacy_playlists
 
170
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr);</programlisting>
 
171
<para>
 
172
 
 
173
</para><variablelist role="params">
 
174
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
 
175
<listitem><simpara>
 
176
 
 
177
 
 
178
</simpara></listitem></varlistentry>
 
179
</variablelist></refsect2>
 
180
<refsect2>
 
181
<title><anchor id="rb-playlist-manager-load-playlists"/>rb_playlist_manager_load_playlists ()</title>
 
182
<indexterm><primary>rb_playlist_manager_load_playlists</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_manager_load_playlists
 
183
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr);</programlisting>
 
184
<para>
 
185
 
 
186
</para><variablelist role="params">
 
187
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
 
188
<listitem><simpara>
 
189
 
 
190
 
 
191
</simpara></listitem></varlistentry>
 
192
</variablelist></refsect2>
 
193
<refsect2>
 
194
<title><anchor id="rb-playlist-manager-save-playlists"/>rb_playlist_manager_save_playlists ()</title>
 
195
<indexterm><primary>rb_playlist_manager_save_playlists</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_manager_save_playlists
 
196
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
197
                                             <link linkend="gboolean">gboolean</link> force);</programlisting>
 
198
<para>
 
199
 
 
200
</para><variablelist role="params">
 
201
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
 
202
<listitem><simpara>
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>force</parameter>&nbsp;:</term>
 
205
<listitem><simpara>
 
206
 
 
207
 
 
208
</simpara></listitem></varlistentry>
 
209
</variablelist></refsect2>
 
210
<refsect2>
 
211
<title><anchor id="rb-playlist-manager-new-playlist"/>rb_playlist_manager_new_playlist ()</title>
 
212
<indexterm><primary>rb_playlist_manager_new_playlist</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>*   rb_playlist_manager_new_playlist
 
213
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *mgr,
 
214
                                             const <link linkend="char">char</link> *suggested_name,
 
215
                                             <link linkend="gboolean">gboolean</link> automatic);</programlisting>
 
216
<para>
 
217
 
 
218
</para><variablelist role="params">
 
219
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
 
220
<listitem><simpara>
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><parameter>suggested_name</parameter>&nbsp;:</term>
 
223
<listitem><simpara>
 
224
</simpara></listitem></varlistentry>
 
225
<varlistentry><term><parameter>automatic</parameter>&nbsp;:</term>
 
226
<listitem><simpara>
 
227
</simpara></listitem></varlistentry>
 
228
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
229
 
 
230
 
 
231
</simpara></listitem></varlistentry>
 
232
</variablelist></refsect2>
 
233
<refsect2>
 
234
<title><anchor id="rb-playlist-manager-get-playlists"/>rb_playlist_manager_get_playlists ()</title>
 
235
<indexterm><primary>rb_playlist_manager_get_playlists</primary></indexterm><programlisting><link linkend="GList">GList</link>*      rb_playlist_manager_get_playlists
 
236
                                            (<link linkend="RBPlaylistManager">RBPlaylistManager</link> *manager);</programlisting>
 
237
<para>
 
238
 
 
239
</para><variablelist role="params">
 
240
<varlistentry><term><parameter>manager</parameter>&nbsp;:</term>
 
241
<listitem><simpara>
 
242
</simpara></listitem></varlistentry>
 
243
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
244
 
 
245
 
 
246
</simpara></listitem></varlistentry>
 
247
</variablelist></refsect2>
 
248
 
 
249
</refsect1>
 
250
 
 
251
 
 
252
 
 
253
 
 
254
</refentry>