← 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-source-recorder.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-source-recorder.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-source-recorder">
 
5
<refmeta>
 
6
<refentrytitle>rb-playlist-source-recorder</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-playlist-source-recorder</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
typedef     <link linkend="RBPlaylistSourceRecorderPrivate">RBPlaylistSourceRecorderPrivate</link>;
 
22
<link linkend="void">void</link>        (<link linkend="RBPlaylistSourceIterFunc">*RBPlaylistSourceIterFunc</link>)     (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
 
23
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter,
 
24
                                             <link linkend="char">char</link> **uri,
 
25
                                             <link linkend="char">char</link> **artist,
 
26
                                             <link linkend="char">char</link> **title,
 
27
                                             <link linkend="gulong">gulong</link> *duration);
 
28
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="rb-playlist-source-recorder-new">rb_playlist_source_recorder_new</link> (<link linkend="GtkWidget">GtkWidget</link> *parent,
 
29
                                             <link linkend="RBShell">RBShell</link> *shell,
 
30
                                             const <link linkend="char">char</link> *name);
 
31
<link linkend="void">void</link>        <link linkend="rb-playlist-source-recorder-set-name">rb_playlist_source_recorder_set_name</link>
 
32
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
33
                                             const <link linkend="char">char</link> *name,
 
34
                                             <link linkend="GError">GError</link> **error);
 
35
<link linkend="void">void</link>        <link linkend="rb-playlist-source-recorder-add-from-model">rb_playlist_source_recorder_add_from_model</link>
 
36
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
37
                                             <link linkend="GtkTreeModel">GtkTreeModel</link> *model,
 
38
                                             <link linkend="RBPlaylistSourceIterFunc">RBPlaylistSourceIterFunc</link> func,
 
39
                                             <link linkend="GError">GError</link> **error);
 
40
<link linkend="void">void</link>        <link linkend="rb-playlist-source-recorder-add-uri">rb_playlist_source_recorder_add_uri</link>
 
41
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
42
                                             const <link linkend="char">char</link> *uri,
 
43
                                             <link linkend="GError">GError</link> **error);
 
44
<link linkend="void">void</link>        <link linkend="rb-playlist-source-recorder-start">rb_playlist_source_recorder_start</link>
 
45
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
46
                                             <link linkend="GError">GError</link> **error);
 
47
<link linkend="void">void</link>        <link linkend="rb-playlist-source-recorder-stop">rb_playlist_source_recorder_stop</link>
 
48
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
49
                                             <link linkend="GError">GError</link> **error);
 
50
 
 
51
</synopsis>
 
52
</refsynopsisdiv>
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
 
 
62
<refsect1>
 
63
<title>Description</title>
 
64
<para>
 
65
 
 
66
</para>
 
67
</refsect1>
 
68
 
 
69
<refsect1>
 
70
<title>Details</title>
 
71
<refsect2>
 
72
<title><anchor id="RBPlaylistSourceRecorderPrivate"/>RBPlaylistSourceRecorderPrivate</title>
 
73
<indexterm><primary>RBPlaylistSourceRecorderPrivate</primary></indexterm><programlisting>typedef struct RBPlaylistSourceRecorderPrivate RBPlaylistSourceRecorderPrivate;
 
74
</programlisting>
 
75
<para>
 
76
 
 
77
</para></refsect2>
 
78
<refsect2>
 
79
<title><anchor id="RBPlaylistSourceIterFunc"/>RBPlaylistSourceIterFunc ()</title>
 
80
<indexterm><primary>RBPlaylistSourceIterFunc</primary></indexterm><programlisting><link linkend="void">void</link>        (*RBPlaylistSourceIterFunc)     (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
 
81
                                             <link linkend="GtkTreeIter">GtkTreeIter</link> *iter,
 
82
                                             <link linkend="char">char</link> **uri,
 
83
                                             <link linkend="char">char</link> **artist,
 
84
                                             <link linkend="char">char</link> **title,
 
85
                                             <link linkend="gulong">gulong</link> *duration);</programlisting>
 
86
<para>
 
87
 
 
88
</para><variablelist role="params">
 
89
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
90
<listitem><simpara>
 
91
</simpara></listitem></varlistentry>
 
92
<varlistentry><term><parameter>iter</parameter>&nbsp;:</term>
 
93
<listitem><simpara>
 
94
</simpara></listitem></varlistentry>
 
95
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
96
<listitem><simpara>
 
97
</simpara></listitem></varlistentry>
 
98
<varlistentry><term><parameter>artist</parameter>&nbsp;:</term>
 
99
<listitem><simpara>
 
100
</simpara></listitem></varlistentry>
 
101
<varlistentry><term><parameter>title</parameter>&nbsp;:</term>
 
102
<listitem><simpara>
 
103
</simpara></listitem></varlistentry>
 
104
<varlistentry><term><parameter>duration</parameter>&nbsp;:</term>
 
105
<listitem><simpara>
 
106
 
 
107
 
 
108
</simpara></listitem></varlistentry>
 
109
</variablelist></refsect2>
 
110
<refsect2>
 
111
<title><anchor id="rb-playlist-source-recorder-new"/>rb_playlist_source_recorder_new ()</title>
 
112
<indexterm><primary>rb_playlist_source_recorder_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  rb_playlist_source_recorder_new (<link linkend="GtkWidget">GtkWidget</link> *parent,
 
113
                                             <link linkend="RBShell">RBShell</link> *shell,
 
114
                                             const <link linkend="char">char</link> *name);</programlisting>
 
115
<para>
 
116
 
 
117
</para><variablelist role="params">
 
118
<varlistentry><term><parameter>parent</parameter>&nbsp;:</term>
 
119
<listitem><simpara>
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><parameter>shell</parameter>&nbsp;:</term>
 
122
<listitem><simpara>
 
123
</simpara></listitem></varlistentry>
 
124
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
125
<listitem><simpara>
 
126
</simpara></listitem></varlistentry>
 
127
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
128
 
 
129
 
 
130
</simpara></listitem></varlistentry>
 
131
</variablelist></refsect2>
 
132
<refsect2>
 
133
<title><anchor id="rb-playlist-source-recorder-set-name"/>rb_playlist_source_recorder_set_name ()</title>
 
134
<indexterm><primary>rb_playlist_source_recorder_set_name</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_source_recorder_set_name
 
135
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
136
                                             const <link linkend="char">char</link> *name,
 
137
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
138
<para>
 
139
 
 
140
</para><variablelist role="params">
 
141
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
142
<listitem><simpara>
 
143
</simpara></listitem></varlistentry>
 
144
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
145
<listitem><simpara>
 
146
</simpara></listitem></varlistentry>
 
147
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
148
<listitem><simpara>
 
149
 
 
150
 
 
151
</simpara></listitem></varlistentry>
 
152
</variablelist></refsect2>
 
153
<refsect2>
 
154
<title><anchor id="rb-playlist-source-recorder-add-from-model"/>rb_playlist_source_recorder_add_from_model ()</title>
 
155
<indexterm><primary>rb_playlist_source_recorder_add_from_model</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_source_recorder_add_from_model
 
156
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
157
                                             <link linkend="GtkTreeModel">GtkTreeModel</link> *model,
 
158
                                             <link linkend="RBPlaylistSourceIterFunc">RBPlaylistSourceIterFunc</link> func,
 
159
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
160
<para>
 
161
 
 
162
</para><variablelist role="params">
 
163
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
164
<listitem><simpara>
 
165
</simpara></listitem></varlistentry>
 
166
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
 
167
<listitem><simpara>
 
168
</simpara></listitem></varlistentry>
 
169
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
 
170
<listitem><simpara>
 
171
</simpara></listitem></varlistentry>
 
172
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
173
<listitem><simpara>
 
174
 
 
175
 
 
176
</simpara></listitem></varlistentry>
 
177
</variablelist></refsect2>
 
178
<refsect2>
 
179
<title><anchor id="rb-playlist-source-recorder-add-uri"/>rb_playlist_source_recorder_add_uri ()</title>
 
180
<indexterm><primary>rb_playlist_source_recorder_add_uri</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_source_recorder_add_uri
 
181
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
182
                                             const <link linkend="char">char</link> *uri,
 
183
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
184
<para>
 
185
 
 
186
</para><variablelist role="params">
 
187
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
188
<listitem><simpara>
 
189
</simpara></listitem></varlistentry>
 
190
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
191
<listitem><simpara>
 
192
</simpara></listitem></varlistentry>
 
193
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
194
<listitem><simpara>
 
195
 
 
196
 
 
197
</simpara></listitem></varlistentry>
 
198
</variablelist></refsect2>
 
199
<refsect2>
 
200
<title><anchor id="rb-playlist-source-recorder-start"/>rb_playlist_source_recorder_start ()</title>
 
201
<indexterm><primary>rb_playlist_source_recorder_start</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_source_recorder_start
 
202
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
203
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
204
<para>
 
205
 
 
206
</para><variablelist role="params">
 
207
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
208
<listitem><simpara>
 
209
</simpara></listitem></varlistentry>
 
210
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
211
<listitem><simpara>
 
212
 
 
213
 
 
214
</simpara></listitem></varlistentry>
 
215
</variablelist></refsect2>
 
216
<refsect2>
 
217
<title><anchor id="rb-playlist-source-recorder-stop"/>rb_playlist_source_recorder_stop ()</title>
 
218
<indexterm><primary>rb_playlist_source_recorder_stop</primary></indexterm><programlisting><link linkend="void">void</link>        rb_playlist_source_recorder_stop
 
219
                                            (<link linkend="RBPlaylistSourceRecorder">RBPlaylistSourceRecorder</link> *recorder,
 
220
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
221
<para>
 
222
 
 
223
</para><variablelist role="params">
 
224
<varlistentry><term><parameter>recorder</parameter>&nbsp;:</term>
 
225
<listitem><simpara>
 
226
</simpara></listitem></varlistentry>
 
227
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
228
<listitem><simpara>
 
229
 
 
230
 
 
231
</simpara></listitem></varlistentry>
 
232
</variablelist></refsect2>
 
233
 
 
234
</refsect1>
 
235
 
 
236
 
 
237
 
 
238
 
 
239
</refentry>