← 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-player.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-player.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-player">
 
5
<refmeta>
 
6
<refentrytitle>rb-player</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-player</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
enum        <link linkend="RBPlayerError">RBPlayerError</link>;
 
22
#define     <link linkend="RB-PLAYER-TICK-HZ:CAPS">RB_PLAYER_TICK_HZ</link>
 
23
#define     <link linkend="RB-PLAYER-ERROR:CAPS">RB_PLAYER_ERROR</link>
 
24
<link linkend="GQuark">GQuark</link>      <link linkend="rb-player-error-quark">rb_player_error_quark</link>           (void);
 
25
typedef     <link linkend="RBPlayerPrivate">RBPlayerPrivate</link>;
 
26
<link linkend="RBPlayer">RBPlayer</link>*   <link linkend="rb-player-new">rb_player_new</link>                   (<link linkend="GError">GError</link> **error);
 
27
<link linkend="gboolean">gboolean</link>    <link linkend="rb-player-open">rb_player_open</link>                  (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
28
                                             const <link linkend="char">char</link> *uri,
 
29
                                             <link linkend="GError">GError</link> **error);
 
30
<link linkend="gboolean">gboolean</link>    <link linkend="rb-player-opened">rb_player_opened</link>                (<link linkend="RBPlayer">RBPlayer</link> *mp);
 
31
<link linkend="gboolean">gboolean</link>    <link linkend="rb-player-close">rb_player_close</link>                 (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
32
                                             <link linkend="GError">GError</link> **error);
 
33
<link linkend="gboolean">gboolean</link>    <link linkend="rb-player-play">rb_player_play</link>                  (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
34
                                             <link linkend="GError">GError</link> **error);
 
35
<link linkend="void">void</link>        <link linkend="rb-player-pause">rb_player_pause</link>                 (<link linkend="RBPlayer">RBPlayer</link> *mp);
 
36
<link linkend="gboolean">gboolean</link>    <link linkend="rb-player-playing">rb_player_playing</link>               (<link linkend="RBPlayer">RBPlayer</link> *mp);
 
37
<link linkend="void">void</link>        <link linkend="rb-player-set-volume">rb_player_set_volume</link>            (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
38
                                             <link linkend="float">float</link> volume);
 
39
<link linkend="float">float</link>       <link linkend="rb-player-get-volume">rb_player_get_volume</link>            (<link linkend="RBPlayer">RBPlayer</link> *mp);
 
40
<link linkend="void">void</link>        <link linkend="rb-player-set-replaygain">rb_player_set_replaygain</link>        (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
41
                                             <link linkend="double">double</link> track_gain,
 
42
                                             <link linkend="double">double</link> track_peak,
 
43
                                             <link linkend="double">double</link> album_gain,
 
44
                                             <link linkend="double">double</link> album_peak);
 
45
<link linkend="gboolean">gboolean</link>    <link linkend="rb-player-seekable">rb_player_seekable</link>              (<link linkend="RBPlayer">RBPlayer</link> *mp);
 
46
<link linkend="void">void</link>        <link linkend="rb-player-set-time">rb_player_set_time</link>              (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
47
                                             <link linkend="long-time">long time</link>);
 
48
<link linkend="long">long</link>        <link linkend="rb-player-get-time">rb_player_get_time</link>              (<link linkend="RBPlayer">RBPlayer</link> *mp);
 
49
 
 
50
</synopsis>
 
51
</refsynopsisdiv>
 
52
 
 
53
 
 
54
 
 
55
 
 
56
 
 
57
 
 
58
 
 
59
 
 
60
 
 
61
<refsect1>
 
62
<title>Description</title>
 
63
<para>
 
64
 
 
65
</para>
 
66
</refsect1>
 
67
 
 
68
<refsect1>
 
69
<title>Details</title>
 
70
<refsect2>
 
71
<title><anchor id="RBPlayerError"/>enum RBPlayerError</title>
 
72
<indexterm><primary>RBPlayerError</primary></indexterm><programlisting>typedef enum
 
73
{
 
74
        RB_PLAYER_ERROR_NO_INPUT_PLUGIN,
 
75
        RB_PLAYER_ERROR_NO_QUEUE_PLUGIN,
 
76
        RB_PLAYER_ERROR_NO_TYPEFIND_PLUGIN,
 
77
        RB_PLAYER_ERROR_NO_DEMUX_PLUGIN,
 
78
        RB_PLAYER_ERROR_NO_VOLUME_PLUGIN,
 
79
        RB_PLAYER_ERROR_DEMUX_FAILED,
 
80
        RB_PLAYER_ERROR_NO_AUDIO,
 
81
        RB_PLAYER_ERROR_GENERAL,
 
82
        RB_PLAYER_ERROR_INTERNAL
 
83
} RBPlayerError;
 
84
</programlisting>
 
85
<para>
 
86
 
 
87
</para></refsect2>
 
88
<refsect2>
 
89
<title><anchor id="RB-PLAYER-TICK-HZ:CAPS"/>RB_PLAYER_TICK_HZ</title>
 
90
<indexterm><primary>RB_PLAYER_TICK_HZ</primary></indexterm><programlisting>#define RB_PLAYER_TICK_HZ 5
 
91
</programlisting>
 
92
<para>
 
93
 
 
94
</para></refsect2>
 
95
<refsect2>
 
96
<title><anchor id="RB-PLAYER-ERROR:CAPS"/>RB_PLAYER_ERROR</title>
 
97
<indexterm><primary>RB_PLAYER_ERROR</primary></indexterm><programlisting>#define RB_PLAYER_ERROR rb_player_error_quark ()
 
98
</programlisting>
 
99
<para>
 
100
 
 
101
</para></refsect2>
 
102
<refsect2>
 
103
<title><anchor id="rb-player-error-quark"/>rb_player_error_quark ()</title>
 
104
<indexterm><primary>rb_player_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>      rb_player_error_quark           (void);</programlisting>
 
105
<para>
 
106
 
 
107
</para><variablelist role="params">
 
108
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
109
 
 
110
 
 
111
</simpara></listitem></varlistentry>
 
112
</variablelist></refsect2>
 
113
<refsect2>
 
114
<title><anchor id="RBPlayerPrivate"/>RBPlayerPrivate</title>
 
115
<indexterm><primary>RBPlayerPrivate</primary></indexterm><programlisting>typedef struct RBPlayerPrivate RBPlayerPrivate;
 
116
</programlisting>
 
117
<para>
 
118
 
 
119
</para></refsect2>
 
120
<refsect2>
 
121
<title><anchor id="rb-player-new"/>rb_player_new ()</title>
 
122
<indexterm><primary>rb_player_new</primary></indexterm><programlisting><link linkend="RBPlayer">RBPlayer</link>*   rb_player_new                   (<link linkend="GError">GError</link> **error);</programlisting>
 
123
<para>
 
124
 
 
125
</para><variablelist role="params">
 
126
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
127
<listitem><simpara>
 
128
</simpara></listitem></varlistentry>
 
129
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
130
 
 
131
 
 
132
</simpara></listitem></varlistentry>
 
133
</variablelist></refsect2>
 
134
<refsect2>
 
135
<title><anchor id="rb-player-open"/>rb_player_open ()</title>
 
136
<indexterm><primary>rb_player_open</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_player_open                  (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
137
                                             const <link linkend="char">char</link> *uri,
 
138
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
139
<para>
 
140
 
 
141
</para><variablelist role="params">
 
142
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
143
<listitem><simpara>
 
144
</simpara></listitem></varlistentry>
 
145
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
 
146
<listitem><simpara>
 
147
</simpara></listitem></varlistentry>
 
148
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
149
<listitem><simpara>
 
150
</simpara></listitem></varlistentry>
 
151
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
152
 
 
153
 
 
154
</simpara></listitem></varlistentry>
 
155
</variablelist></refsect2>
 
156
<refsect2>
 
157
<title><anchor id="rb-player-opened"/>rb_player_opened ()</title>
 
158
<indexterm><primary>rb_player_opened</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_player_opened                (<link linkend="RBPlayer">RBPlayer</link> *mp);</programlisting>
 
159
<para>
 
160
 
 
161
</para><variablelist role="params">
 
162
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
163
<listitem><simpara>
 
164
</simpara></listitem></varlistentry>
 
165
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
166
 
 
167
 
 
168
</simpara></listitem></varlistentry>
 
169
</variablelist></refsect2>
 
170
<refsect2>
 
171
<title><anchor id="rb-player-close"/>rb_player_close ()</title>
 
172
<indexterm><primary>rb_player_close</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_player_close                 (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
173
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
174
<para>
 
175
 
 
176
</para><variablelist role="params">
 
177
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
178
<listitem><simpara>
 
179
</simpara></listitem></varlistentry>
 
180
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
181
<listitem><simpara>
 
182
</simpara></listitem></varlistentry>
 
183
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
184
 
 
185
 
 
186
</simpara></listitem></varlistentry>
 
187
</variablelist></refsect2>
 
188
<refsect2>
 
189
<title><anchor id="rb-player-play"/>rb_player_play ()</title>
 
190
<indexterm><primary>rb_player_play</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_player_play                  (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
191
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
192
<para>
 
193
 
 
194
</para><variablelist role="params">
 
195
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
196
<listitem><simpara>
 
197
</simpara></listitem></varlistentry>
 
198
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
199
<listitem><simpara>
 
200
</simpara></listitem></varlistentry>
 
201
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
202
 
 
203
 
 
204
</simpara></listitem></varlistentry>
 
205
</variablelist></refsect2>
 
206
<refsect2>
 
207
<title><anchor id="rb-player-pause"/>rb_player_pause ()</title>
 
208
<indexterm><primary>rb_player_pause</primary></indexterm><programlisting><link linkend="void">void</link>        rb_player_pause                 (<link linkend="RBPlayer">RBPlayer</link> *mp);</programlisting>
 
209
<para>
 
210
 
 
211
</para><variablelist role="params">
 
212
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
213
<listitem><simpara>
 
214
 
 
215
 
 
216
</simpara></listitem></varlistentry>
 
217
</variablelist></refsect2>
 
218
<refsect2>
 
219
<title><anchor id="rb-player-playing"/>rb_player_playing ()</title>
 
220
<indexterm><primary>rb_player_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_player_playing               (<link linkend="RBPlayer">RBPlayer</link> *mp);</programlisting>
 
221
<para>
 
222
 
 
223
</para><variablelist role="params">
 
224
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
225
<listitem><simpara>
 
226
</simpara></listitem></varlistentry>
 
227
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
228
 
 
229
 
 
230
</simpara></listitem></varlistentry>
 
231
</variablelist></refsect2>
 
232
<refsect2>
 
233
<title><anchor id="rb-player-set-volume"/>rb_player_set_volume ()</title>
 
234
<indexterm><primary>rb_player_set_volume</primary></indexterm><programlisting><link linkend="void">void</link>        rb_player_set_volume            (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
235
                                             <link linkend="float">float</link> volume);</programlisting>
 
236
<para>
 
237
 
 
238
</para><variablelist role="params">
 
239
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
240
<listitem><simpara>
 
241
</simpara></listitem></varlistentry>
 
242
<varlistentry><term><parameter>volume</parameter>&nbsp;:</term>
 
243
<listitem><simpara>
 
244
 
 
245
 
 
246
</simpara></listitem></varlistentry>
 
247
</variablelist></refsect2>
 
248
<refsect2>
 
249
<title><anchor id="rb-player-get-volume"/>rb_player_get_volume ()</title>
 
250
<indexterm><primary>rb_player_get_volume</primary></indexterm><programlisting><link linkend="float">float</link>       rb_player_get_volume            (<link linkend="RBPlayer">RBPlayer</link> *mp);</programlisting>
 
251
<para>
 
252
 
 
253
</para><variablelist role="params">
 
254
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
255
<listitem><simpara>
 
256
</simpara></listitem></varlistentry>
 
257
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
258
 
 
259
 
 
260
</simpara></listitem></varlistentry>
 
261
</variablelist></refsect2>
 
262
<refsect2>
 
263
<title><anchor id="rb-player-set-replaygain"/>rb_player_set_replaygain ()</title>
 
264
<indexterm><primary>rb_player_set_replaygain</primary></indexterm><programlisting><link linkend="void">void</link>        rb_player_set_replaygain        (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
265
                                             <link linkend="double">double</link> track_gain,
 
266
                                             <link linkend="double">double</link> track_peak,
 
267
                                             <link linkend="double">double</link> album_gain,
 
268
                                             <link linkend="double">double</link> album_peak);</programlisting>
 
269
<para>
 
270
 
 
271
</para><variablelist role="params">
 
272
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
273
<listitem><simpara>
 
274
</simpara></listitem></varlistentry>
 
275
<varlistentry><term><parameter>track_gain</parameter>&nbsp;:</term>
 
276
<listitem><simpara>
 
277
</simpara></listitem></varlistentry>
 
278
<varlistentry><term><parameter>track_peak</parameter>&nbsp;:</term>
 
279
<listitem><simpara>
 
280
</simpara></listitem></varlistentry>
 
281
<varlistentry><term><parameter>album_gain</parameter>&nbsp;:</term>
 
282
<listitem><simpara>
 
283
</simpara></listitem></varlistentry>
 
284
<varlistentry><term><parameter>album_peak</parameter>&nbsp;:</term>
 
285
<listitem><simpara>
 
286
 
 
287
 
 
288
</simpara></listitem></varlistentry>
 
289
</variablelist></refsect2>
 
290
<refsect2>
 
291
<title><anchor id="rb-player-seekable"/>rb_player_seekable ()</title>
 
292
<indexterm><primary>rb_player_seekable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_player_seekable              (<link linkend="RBPlayer">RBPlayer</link> *mp);</programlisting>
 
293
<para>
 
294
 
 
295
</para><variablelist role="params">
 
296
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
297
<listitem><simpara>
 
298
</simpara></listitem></varlistentry>
 
299
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
300
 
 
301
 
 
302
</simpara></listitem></varlistentry>
 
303
</variablelist></refsect2>
 
304
<refsect2>
 
305
<title><anchor id="rb-player-set-time"/>rb_player_set_time ()</title>
 
306
<indexterm><primary>rb_player_set_time</primary></indexterm><programlisting><link linkend="void">void</link>        rb_player_set_time              (<link linkend="RBPlayer">RBPlayer</link> *mp,
 
307
                                             <link linkend="long-time">long time</link>);</programlisting>
 
308
<para>
 
309
 
 
310
</para><variablelist role="params">
 
311
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
312
<listitem><simpara>
 
313
</simpara></listitem></varlistentry>
 
314
<varlistentry><term><parameter>Param2</parameter>&nbsp;:</term>
 
315
<listitem><simpara>
 
316
 
 
317
 
 
318
</simpara></listitem></varlistentry>
 
319
</variablelist></refsect2>
 
320
<refsect2>
 
321
<title><anchor id="rb-player-get-time"/>rb_player_get_time ()</title>
 
322
<indexterm><primary>rb_player_get_time</primary></indexterm><programlisting><link linkend="long">long</link>        rb_player_get_time              (<link linkend="RBPlayer">RBPlayer</link> *mp);</programlisting>
 
323
<para>
 
324
 
 
325
</para><variablelist role="params">
 
326
<varlistentry><term><parameter>mp</parameter>&nbsp;:</term>
 
327
<listitem><simpara>
 
328
</simpara></listitem></varlistentry>
 
329
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
330
 
 
331
 
 
332
</simpara></listitem></varlistentry>
 
333
</variablelist></refsect2>
 
334
 
 
335
</refsect1>
 
336
 
 
337
 
 
338
 
 
339
 
 
340
</refentry>