← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/reference/html/rhythmbox-rb-player.html

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/html/rhythmbox-rb-player.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>rb-player</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="ch04.html" title="Player">
 
8
<link rel="prev" href="ch04.html" title="Player">
 
9
<link rel="next" href="rhythmbox-rb-recorder.html" title="rb-recorder">
 
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">
 
20
</head>
 
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="ch04.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="ch04.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-recorder.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
28
</tr></table>
 
29
<div class="refentry" lang="en">
 
30
<a name="rhythmbox-rb-player"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle">rb-player</span></h2>
 
34
<p>rb-player &#8212; </p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
 
 
42
 
 
43
 
 
44
enum        <a href="rhythmbox-rb-player.html#RBPlayerError">RBPlayerError</a>;
 
45
#define     <a href="rhythmbox-rb-player.html#RB-PLAYER-TICK-HZ:CAPS">RB_PLAYER_TICK_HZ</a>
 
46
#define     <a href="rhythmbox-rb-player.html#RB-PLAYER-ERROR:CAPS">RB_PLAYER_ERROR</a>
 
47
GQuark      <a href="rhythmbox-rb-player.html#rb-player-error-quark">rb_player_error_quark</a>           (void);
 
48
typedef     <a href="rhythmbox-rb-player.html#RBPlayerPrivate">RBPlayerPrivate</a>;
 
49
RBPlayer*   <a href="rhythmbox-rb-player.html#rb-player-new">rb_player_new</a>                   (GError **error);
 
50
gboolean    <a href="rhythmbox-rb-player.html#rb-player-open">rb_player_open</a>                  (RBPlayer *mp,
 
51
                                             const char *uri,
 
52
                                             GError **error);
 
53
gboolean    <a href="rhythmbox-rb-player.html#rb-player-opened">rb_player_opened</a>                (RBPlayer *mp);
 
54
gboolean    <a href="rhythmbox-rb-player.html#rb-player-close">rb_player_close</a>                 (RBPlayer *mp,
 
55
                                             GError **error);
 
56
gboolean    <a href="rhythmbox-rb-player.html#rb-player-play">rb_player_play</a>                  (RBPlayer *mp,
 
57
                                             GError **error);
 
58
void        <a href="rhythmbox-rb-player.html#rb-player-pause">rb_player_pause</a>                 (RBPlayer *mp);
 
59
gboolean    <a href="rhythmbox-rb-player.html#rb-player-playing">rb_player_playing</a>               (RBPlayer *mp);
 
60
void        <a href="rhythmbox-rb-player.html#rb-player-set-volume">rb_player_set_volume</a>            (RBPlayer *mp,
 
61
                                             float volume);
 
62
float       <a href="rhythmbox-rb-player.html#rb-player-get-volume">rb_player_get_volume</a>            (RBPlayer *mp);
 
63
void        <a href="rhythmbox-rb-player.html#rb-player-set-replaygain">rb_player_set_replaygain</a>        (RBPlayer *mp,
 
64
                                             double track_gain,
 
65
                                             double track_peak,
 
66
                                             double album_gain,
 
67
                                             double album_peak);
 
68
gboolean    <a href="rhythmbox-rb-player.html#rb-player-seekable">rb_player_seekable</a>              (RBPlayer *mp);
 
69
void        <a href="rhythmbox-rb-player.html#rb-player-set-time">rb_player_set_time</a>              (RBPlayer *mp,
 
70
                                             long time);
 
71
long        <a href="rhythmbox-rb-player.html#rb-player-get-time">rb_player_get_time</a>              (RBPlayer *mp);
 
72
 
 
73
</pre>
 
74
</div>
 
75
<div class="refsect1" lang="en">
 
76
<a name="id2519370"></a><h2>Description</h2>
 
77
<p>
 
78
 
 
79
</p>
 
80
</div>
 
81
<div class="refsect1" lang="en">
 
82
<a name="id2519381"></a><h2>Details</h2>
 
83
<div class="refsect2" lang="en">
 
84
<a name="id2519387"></a><h3>
 
85
<a name="RBPlayerError"></a>enum RBPlayerError</h3>
 
86
<a class="indexterm" name="id2519397"></a><pre class="programlisting">typedef enum
 
87
{
 
88
        RB_PLAYER_ERROR_NO_INPUT_PLUGIN,
 
89
        RB_PLAYER_ERROR_NO_QUEUE_PLUGIN,
 
90
        RB_PLAYER_ERROR_NO_TYPEFIND_PLUGIN,
 
91
        RB_PLAYER_ERROR_NO_DEMUX_PLUGIN,
 
92
        RB_PLAYER_ERROR_NO_VOLUME_PLUGIN,
 
93
        RB_PLAYER_ERROR_DEMUX_FAILED,
 
94
        RB_PLAYER_ERROR_NO_AUDIO,
 
95
        RB_PLAYER_ERROR_GENERAL,
 
96
        RB_PLAYER_ERROR_INTERNAL
 
97
} RBPlayerError;
 
98
</pre>
 
99
<p>
 
100
 
 
101
</p>
 
102
</div>
 
103
<hr>
 
104
<div class="refsect2" lang="en">
 
105
<a name="id2519418"></a><h3>
 
106
<a name="RB-PLAYER-TICK-HZ:CAPS"></a>RB_PLAYER_TICK_HZ</h3>
 
107
<a class="indexterm" name="id2519428"></a><pre class="programlisting">#define RB_PLAYER_TICK_HZ 5
 
108
</pre>
 
109
<p>
 
110
 
 
111
</p>
 
112
</div>
 
113
<hr>
 
114
<div class="refsect2" lang="en">
 
115
<a name="id2519443"></a><h3>
 
116
<a name="RB-PLAYER-ERROR:CAPS"></a>RB_PLAYER_ERROR</h3>
 
117
<a class="indexterm" name="id2519452"></a><pre class="programlisting">#define RB_PLAYER_ERROR rb_player_error_quark ()
 
118
</pre>
 
119
<p>
 
120
 
 
121
</p>
 
122
</div>
 
123
<hr>
 
124
<div class="refsect2" lang="en">
 
125
<a name="id2519469"></a><h3>
 
126
<a name="rb-player-error-quark"></a>rb_player_error_quark ()</h3>
 
127
<a class="indexterm" name="id2519478"></a><pre class="programlisting">GQuark      rb_player_error_quark           (void);</pre>
 
128
<p>
 
129
 
 
130
</p>
 
131
<div class="variablelist"><table border="0">
 
132
<col align="left" valign="top">
 
133
<tbody><tr>
 
134
<td>
 
135
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
136
<td>
 
137
 
 
138
 
 
139
</td>
 
140
</tr></tbody>
 
141
</table></div>
 
142
</div>
 
143
<hr>
 
144
<div class="refsect2" lang="en">
 
145
<a name="id2519514"></a><h3>
 
146
<a name="RBPlayerPrivate"></a>RBPlayerPrivate</h3>
 
147
<a class="indexterm" name="id2519524"></a><pre class="programlisting">typedef struct RBPlayerPrivate RBPlayerPrivate;
 
148
</pre>
 
149
<p>
 
150
 
 
151
</p>
 
152
</div>
 
153
<hr>
 
154
<div class="refsect2" lang="en">
 
155
<a name="id2519540"></a><h3>
 
156
<a name="rb-player-new"></a>rb_player_new ()</h3>
 
157
<a class="indexterm" name="id2519550"></a><pre class="programlisting">RBPlayer*   rb_player_new                   (GError **error);</pre>
 
158
<p>
 
159
 
 
160
</p>
 
161
<div class="variablelist"><table border="0">
 
162
<col align="left" valign="top">
 
163
<tbody>
 
164
<tr>
 
165
<td>
 
166
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
167
<td>
 
168
</td>
 
169
</tr>
 
170
<tr>
 
171
<td>
 
172
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
173
<td>
 
174
 
 
175
 
 
176
</td>
 
177
</tr>
 
178
</tbody>
 
179
</table></div>
 
180
</div>
 
181
<hr>
 
182
<div class="refsect2" lang="en">
 
183
<a name="id2519606"></a><h3>
 
184
<a name="rb-player-open"></a>rb_player_open ()</h3>
 
185
<a class="indexterm" name="id2519616"></a><pre class="programlisting">gboolean    rb_player_open                  (RBPlayer *mp,
 
186
                                             const char *uri,
 
187
                                             GError **error);</pre>
 
188
<p>
 
189
 
 
190
</p>
 
191
<div class="variablelist"><table border="0">
 
192
<col align="left" valign="top">
 
193
<tbody>
 
194
<tr>
 
195
<td>
 
196
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
197
<td>
 
198
</td>
 
199
</tr>
 
200
<tr>
 
201
<td>
 
202
<span class="term"><em class="parameter"><code>uri</code></em>&#160;:</span></td>
 
203
<td>
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td>
 
208
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
209
<td>
 
210
</td>
 
211
</tr>
 
212
<tr>
 
213
<td>
 
214
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
215
<td>
 
216
 
 
217
 
 
218
</td>
 
219
</tr>
 
220
</tbody>
 
221
</table></div>
 
222
</div>
 
223
<hr>
 
224
<div class="refsect2" lang="en">
 
225
<a name="id2538275"></a><h3>
 
226
<a name="rb-player-opened"></a>rb_player_opened ()</h3>
 
227
<a class="indexterm" name="id2538285"></a><pre class="programlisting">gboolean    rb_player_opened                (RBPlayer *mp);</pre>
 
228
<p>
 
229
 
 
230
</p>
 
231
<div class="variablelist"><table border="0">
 
232
<col align="left" valign="top">
 
233
<tbody>
 
234
<tr>
 
235
<td>
 
236
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
237
<td>
 
238
</td>
 
239
</tr>
 
240
<tr>
 
241
<td>
 
242
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
243
<td>
 
244
 
 
245
 
 
246
</td>
 
247
</tr>
 
248
</tbody>
 
249
</table></div>
 
250
</div>
 
251
<hr>
 
252
<div class="refsect2" lang="en">
 
253
<a name="id2538341"></a><h3>
 
254
<a name="rb-player-close"></a>rb_player_close ()</h3>
 
255
<a class="indexterm" name="id2538351"></a><pre class="programlisting">gboolean    rb_player_close                 (RBPlayer *mp,
 
256
                                             GError **error);</pre>
 
257
<p>
 
258
 
 
259
</p>
 
260
<div class="variablelist"><table border="0">
 
261
<col align="left" valign="top">
 
262
<tbody>
 
263
<tr>
 
264
<td>
 
265
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
266
<td>
 
267
</td>
 
268
</tr>
 
269
<tr>
 
270
<td>
 
271
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
272
<td>
 
273
</td>
 
274
</tr>
 
275
<tr>
 
276
<td>
 
277
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
278
<td>
 
279
 
 
280
 
 
281
</td>
 
282
</tr>
 
283
</tbody>
 
284
</table></div>
 
285
</div>
 
286
<hr>
 
287
<div class="refsect2" lang="en">
 
288
<a name="id2538428"></a><h3>
 
289
<a name="rb-player-play"></a>rb_player_play ()</h3>
 
290
<a class="indexterm" name="id2538438"></a><pre class="programlisting">gboolean    rb_player_play                  (RBPlayer *mp,
 
291
                                             GError **error);</pre>
 
292
<p>
 
293
 
 
294
</p>
 
295
<div class="variablelist"><table border="0">
 
296
<col align="left" valign="top">
 
297
<tbody>
 
298
<tr>
 
299
<td>
 
300
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
301
<td>
 
302
</td>
 
303
</tr>
 
304
<tr>
 
305
<td>
 
306
<span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
307
<td>
 
308
</td>
 
309
</tr>
 
310
<tr>
 
311
<td>
 
312
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
313
<td>
 
314
 
 
315
 
 
316
</td>
 
317
</tr>
 
318
</tbody>
 
319
</table></div>
 
320
</div>
 
321
<hr>
 
322
<div class="refsect2" lang="en">
 
323
<a name="id2565195"></a><h3>
 
324
<a name="rb-player-pause"></a>rb_player_pause ()</h3>
 
325
<a class="indexterm" name="id2565203"></a><pre class="programlisting">void        rb_player_pause                 (RBPlayer *mp);</pre>
 
326
<p>
 
327
 
 
328
</p>
 
329
<div class="variablelist"><table border="0">
 
330
<col align="left" valign="top">
 
331
<tbody><tr>
 
332
<td>
 
333
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
334
<td>
 
335
 
 
336
 
 
337
</td>
 
338
</tr></tbody>
 
339
</table></div>
 
340
</div>
 
341
<hr>
 
342
<div class="refsect2" lang="en">
 
343
<a name="id2565243"></a><h3>
 
344
<a name="rb-player-playing"></a>rb_player_playing ()</h3>
 
345
<a class="indexterm" name="id2565251"></a><pre class="programlisting">gboolean    rb_player_playing               (RBPlayer *mp);</pre>
 
346
<p>
 
347
 
 
348
</p>
 
349
<div class="variablelist"><table border="0">
 
350
<col align="left" valign="top">
 
351
<tbody>
 
352
<tr>
 
353
<td>
 
354
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
355
<td>
 
356
</td>
 
357
</tr>
 
358
<tr>
 
359
<td>
 
360
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
361
<td>
 
362
 
 
363
 
 
364
</td>
 
365
</tr>
 
366
</tbody>
 
367
</table></div>
 
368
</div>
 
369
<hr>
 
370
<div class="refsect2" lang="en">
 
371
<a name="id2565304"></a><h3>
 
372
<a name="rb-player-set-volume"></a>rb_player_set_volume ()</h3>
 
373
<a class="indexterm" name="id2565313"></a><pre class="programlisting">void        rb_player_set_volume            (RBPlayer *mp,
 
374
                                             float volume);</pre>
 
375
<p>
 
376
 
 
377
</p>
 
378
<div class="variablelist"><table border="0">
 
379
<col align="left" valign="top">
 
380
<tbody>
 
381
<tr>
 
382
<td>
 
383
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
384
<td>
 
385
</td>
 
386
</tr>
 
387
<tr>
 
388
<td>
 
389
<span class="term"><em class="parameter"><code>volume</code></em>&#160;:</span></td>
 
390
<td>
 
391
 
 
392
 
 
393
</td>
 
394
</tr>
 
395
</tbody>
 
396
</table></div>
 
397
</div>
 
398
<hr>
 
399
<div class="refsect2" lang="en">
 
400
<a name="id2565380"></a><h3>
 
401
<a name="rb-player-get-volume"></a>rb_player_get_volume ()</h3>
 
402
<a class="indexterm" name="id2565388"></a><pre class="programlisting">float       rb_player_get_volume            (RBPlayer *mp);</pre>
 
403
<p>
 
404
 
 
405
</p>
 
406
<div class="variablelist"><table border="0">
 
407
<col align="left" valign="top">
 
408
<tbody>
 
409
<tr>
 
410
<td>
 
411
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
412
<td>
 
413
</td>
 
414
</tr>
 
415
<tr>
 
416
<td>
 
417
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
418
<td>
 
419
 
 
420
 
 
421
</td>
 
422
</tr>
 
423
</tbody>
 
424
</table></div>
 
425
</div>
 
426
<hr>
 
427
<div class="refsect2" lang="en">
 
428
<a name="id2565445"></a><h3>
 
429
<a name="rb-player-set-replaygain"></a>rb_player_set_replaygain ()</h3>
 
430
<a class="indexterm" name="id2565454"></a><pre class="programlisting">void        rb_player_set_replaygain        (RBPlayer *mp,
 
431
                                             double track_gain,
 
432
                                             double track_peak,
 
433
                                             double album_gain,
 
434
                                             double album_peak);</pre>
 
435
<p>
 
436
 
 
437
</p>
 
438
<div class="variablelist"><table border="0">
 
439
<col align="left" valign="top">
 
440
<tbody>
 
441
<tr>
 
442
<td>
 
443
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
444
<td>
 
445
</td>
 
446
</tr>
 
447
<tr>
 
448
<td>
 
449
<span class="term"><em class="parameter"><code>track_gain</code></em>&#160;:</span></td>
 
450
<td>
 
451
</td>
 
452
</tr>
 
453
<tr>
 
454
<td>
 
455
<span class="term"><em class="parameter"><code>track_peak</code></em>&#160;:</span></td>
 
456
<td>
 
457
</td>
 
458
</tr>
 
459
<tr>
 
460
<td>
 
461
<span class="term"><em class="parameter"><code>album_gain</code></em>&#160;:</span></td>
 
462
<td>
 
463
</td>
 
464
</tr>
 
465
<tr>
 
466
<td>
 
467
<span class="term"><em class="parameter"><code>album_peak</code></em>&#160;:</span></td>
 
468
<td>
 
469
 
 
470
 
 
471
</td>
 
472
</tr>
 
473
</tbody>
 
474
</table></div>
 
475
</div>
 
476
<hr>
 
477
<div class="refsect2" lang="en">
 
478
<a name="id2565583"></a><h3>
 
479
<a name="rb-player-seekable"></a>rb_player_seekable ()</h3>
 
480
<a class="indexterm" name="id2565593"></a><pre class="programlisting">gboolean    rb_player_seekable              (RBPlayer *mp);</pre>
 
481
<p>
 
482
 
 
483
</p>
 
484
<div class="variablelist"><table border="0">
 
485
<col align="left" valign="top">
 
486
<tbody>
 
487
<tr>
 
488
<td>
 
489
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
490
<td>
 
491
</td>
 
492
</tr>
 
493
<tr>
 
494
<td>
 
495
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
496
<td>
 
497
 
 
498
 
 
499
</td>
 
500
</tr>
 
501
</tbody>
 
502
</table></div>
 
503
</div>
 
504
<hr>
 
505
<div class="refsect2" lang="en">
 
506
<a name="id2565650"></a><h3>
 
507
<a name="rb-player-set-time"></a>rb_player_set_time ()</h3>
 
508
<a class="indexterm" name="id2565660"></a><pre class="programlisting">void        rb_player_set_time              (RBPlayer *mp,
 
509
                                             long time);</pre>
 
510
<p>
 
511
 
 
512
</p>
 
513
<div class="variablelist"><table border="0">
 
514
<col align="left" valign="top">
 
515
<tbody>
 
516
<tr>
 
517
<td>
 
518
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
519
<td>
 
520
</td>
 
521
</tr>
 
522
<tr>
 
523
<td>
 
524
<span class="term"><em class="parameter"><code>Param2</code></em>&#160;:</span></td>
 
525
<td>
 
526
 
 
527
 
 
528
</td>
 
529
</tr>
 
530
</tbody>
 
531
</table></div>
 
532
</div>
 
533
<hr>
 
534
<div class="refsect2" lang="en">
 
535
<a name="id2565726"></a><h3>
 
536
<a name="rb-player-get-time"></a>rb_player_get_time ()</h3>
 
537
<a class="indexterm" name="id2565736"></a><pre class="programlisting">long        rb_player_get_time              (RBPlayer *mp);</pre>
 
538
<p>
 
539
 
 
540
</p>
 
541
<div class="variablelist"><table border="0">
 
542
<col align="left" valign="top">
 
543
<tbody>
 
544
<tr>
 
545
<td>
 
546
<span class="term"><em class="parameter"><code>mp</code></em>&#160;:</span></td>
 
547
<td>
 
548
</td>
 
549
</tr>
 
550
<tr>
 
551
<td>
 
552
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
553
<td>
 
554
 
 
555
 
 
556
</td>
 
557
</tr>
 
558
</tbody>
 
559
</table></div>
 
560
</div>
 
561
</div>
 
562
</div>
 
563
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
564
<td align="left"><a accesskey="p" href="ch04.html"><b>&lt;&lt;&#160;Player</b></a></td>
 
565
<td align="right"><a accesskey="n" href="rhythmbox-rb-recorder.html"><b>rb-recorder&#160;&gt;&gt;</b></a></td>
 
566
</tr></table>
 
567
</body>
 
568
</html>