1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Rhythmbox Development Reference Manual: RBPlayer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch01.html" title="Backends">
<link rel="prev" href="ch01.html" title="Backends">
<link rel="next" href="RBPlayerGstDataTee.html" title="RBPlayerGstDataTee">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#RBPlayer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#RBPlayer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#RBPlayer.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RBPlayerGstDataTee.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RBPlayer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBPlayer.top_of_page"></a>RBPlayer</span></h2>
<p>RBPlayer — playback backend interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RBPlayer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="returnvalue">RBPlayer</span></a> *
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-new" title="rb_player_new ()">rb_player_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-open" title="rb_player_open ()">rb_player_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-opened" title="rb_player_opened ()">rb_player_opened</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-close" title="rb_player_close ()">rb_player_close</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-play" title="rb_player_play ()">rb_player_play</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-pause" title="rb_player_pause ()">rb_player_pause</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-playing" title="rb_player_playing ()">rb_player_playing</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-set-volume" title="rb_player_set_volume ()">rb_player_set_volume</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">float</span>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-get-volume" title="rb_player_get_volume ()">rb_player_get_volume</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-seekable" title="rb_player_seekable ()">rb_player_seekable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-set-time" title="rb_player_set_time ()">rb_player_set_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-get-time" title="rb_player_get_time ()">rb_player_get_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="RBPlayer.html#rb-player-multiple-open" title="rb_player_multiple_open ()">rb_player_multiple_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBPlayer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-buffering" title="The “buffering” signal">buffering</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-eos" title="The “eos” signal">eos</a></td>
<td class="signal_flags">No Recursion</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-error" title="The “error” signal">error</a></td>
<td class="signal_flags">No Recursion</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-event" title="The “event” signal">event</a></td>
<td class="signal_flags">Has Details</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-image" title="The “image” signal">image</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-info" title="The “info” signal">info</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-playing-stream" title="The “playing-stream” signal">playing-stream</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-redirect" title="The “redirect” signal">redirect</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-tick" title="The “tick” signal">tick</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBPlayer.html#RBPlayer-volume-changed" title="The “volume-changed” signal">volume-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBPlayer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="RBPlayer.html#RBPlayer-struct" title="RBPlayer">RBPlayer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RBPlayer.html#RBPlayerIface" title="struct RBPlayerIface">RBPlayerIface</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="RBPlayer.html#RBPlayerPlayType" title="enum RBPlayerPlayType">RBPlayerPlayType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="RBPlayer.html#RBPlayerError" title="enum RBPlayerError">RBPlayerError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBPlayer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
<span class="lineart">╰──</span> RBPlayerError
<a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> RBPlayer
</pre>
</div>
<div class="refsect1">
<a name="RBPlayer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <rb-player.h>
</pre>
</div>
<div class="refsect1">
<a name="RBPlayer.description"></a><h2>Description</h2>
<p>This is the interface implemented by the rhythmbox playback backends.
It allows the caller to control playback (open, play, pause, close),
seek (set_time), control volume (get_volume, set_volume)
and receive playback state information (get_time, various signals).</p>
<p>The playback interface allows for multiple streams to be playing (or at
least open) concurrently. The caller associates some data with each stream
it opens (<a class="link" href="RBPlayer.html#rb-player-open" title="rb_player_open ()"><span class="type">rb_player_open</span></a>), which is included in the paramters with each
signal emitted. The caller should not assume that the new stream is playing
immediately upon returning from <a class="link" href="RBPlayer.html#rb-player-play" title="rb_player_play ()"><span class="type">rb_player_play</span></a>. Instead, it should use
the 'playing-stream' signal to determine that.</p>
<p>The player implementation should emit signals for metadata extracted from the
stream using the 'info' signal</p>
<p>While playing, the player implementation should emit 'tick' signals frequently
enough to update an elapsed/remaining time display consistently. The duration
value included in tick signal emissions is used to prepare the next stream before
the current stream reaches EOS, so it should be updated for each emission to account
for variable bitrate streams that produce inaccurate duration estimates early on.</p>
<p>When playing a stream from the network, the player can report buffering status
using the 'buffering' signal. The value included in the signal indicates the
percentage of the buffer that has been filled.</p>
<p>The 'event' signal can be used to communicate events from the player to the application.
For GStreamer-based player implementations, events are triggered by elements in the
pipeline posting application messages. The name of the message becomes the name of the
event.</p>
</div>
<div class="refsect1">
<a name="RBPlayer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-player-new"></a><h3>rb_player_new ()</h3>
<pre class="programlisting"><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="returnvalue">RBPlayer</span></a> *
rb_player_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> want_crossfade</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates a new player object.</p>
<div class="refsect3">
<a name="id-1.2.2.9.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>want_crossfade</p></td>
<td class="parameter_description"><p>if TRUE, try to use a backend that supports
crossfading and other track transitions.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>returns error information</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.2.6"></a><h4>Returns</h4>
<p> new player object. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-open"></a><h3>rb_player_open ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_player_open (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> stream_data_destroy</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Prepares a stream for playback. Depending on the player
implementation, this may stop any existing stream being
played. The stream preparation process may continue
asynchronously, in which case errors may be reported from
<a class="link" href="RBPlayer.html#rb-player-play" title="rb_player_play ()"><span class="type">rb_player_play</span></a> or using the 'error' signal.</p>
<div class="refsect3">
<a name="id-1.2.2.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>URI to open</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>arbitrary data to associate with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data_destroy</p></td>
<td class="parameter_description"><p>function to call to destroy the stream data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>returns error information</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.3.6"></a><h4>Returns</h4>
<p> TRUE if the stream preparation was not unsuccessful</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-opened"></a><h3>rb_player_opened ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_player_opened (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>);</pre>
<p>Determines whether a stream has been prepared for playback.</p>
<div class="refsect3">
<a name="id-1.2.2.9.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.4.6"></a><h4>Returns</h4>
<p> TRUE if a stream is prepared for playback</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-close"></a><h3>rb_player_close ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_player_close (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>If a URI is specified, this will close the stream corresponding
to that URI and free any resources related resources. If <em class="parameter"><code>uri</code></em>
is NULL, this will close all streams.</p>
<p>If no streams remain open after this call, the audio device will
be released.</p>
<div class="refsect3">
<a name="id-1.2.2.9.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>optionally, the URI of the stream to close</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>returns error information</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.5.7"></a><h4>Returns</h4>
<p> TRUE if a stream was found and closed</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-play"></a><h3>rb_player_play ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_player_play (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>,
<em class="parameter"><code><a class="link" href="RBPlayer.html#RBPlayerPlayType" title="enum RBPlayerPlayType"><span class="type">RBPlayerPlayType</span></a> play_type</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> crossfade</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Starts playback of the most recently opened stream.
if <em class="parameter"><code>play_type</code></em>
is <a class="link" href="RBPlayer.html#RB-PLAYER-PLAY-CROSSFADE:CAPS"><span class="type">RB_PLAYER_PLAY_CROSSFADE</span></a>, the player
may attempt to crossfade the new stream with any existing
streams. If it does this, the it will use <em class="parameter"><code>crossfade</code></em>
as the
duration of the fade.</p>
<p>If <em class="parameter"><code>play_type</code></em>
is <a class="link" href="RBPlayer.html#RB-PLAYER-PLAY-AFTER-EOS:CAPS"><span class="type">RB_PLAYER_PLAY_AFTER_EOS</span></a>, the player may
attempt to start the stream immediately after the current
playing stream reaches EOS. This may or may not result in
the phenomemon known as 'gapless playback'.</p>
<p>If <em class="parameter"><code>play_type</code></em>
is <a class="link" href="RBPlayer.html#RB-PLAYER-PLAY-REPLACE:CAPS"><span class="type">RB_PLAYER_PLAY_REPLACE</span></a>, the player will stop any
existing stream before starting the new stream. It may do
this anyway, regardless of the value of <em class="parameter"><code>play_type</code></em>
.</p>
<p>The 'playing-stream' signal will be emitted when the new stream
is actually playing. This may be before or after control returns
to the caller.</p>
<div class="refsect3">
<a name="id-1.2.2.9.6.8"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>play_type</p></td>
<td class="parameter_description"><p>requested playback start type</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>crossfade</p></td>
<td class="parameter_description"><p>requested crossfade duration (nanoseconds)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>returns error information</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.6.9"></a><h4>Returns</h4>
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if playback started successfully</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-pause"></a><h3>rb_player_pause ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_player_pause (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>);</pre>
<p>Pauses playback of the most recently started stream. Any
streams being faded out may continue until the fade is
complete.</p>
<div class="refsect3">
<a name="id-1.2.2.9.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-playing"></a><h3>rb_player_playing ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_player_playing (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>);</pre>
<p>Determines whether the player is currently playing a stream.
A stream is playing if it's not paused or being faded out.</p>
<div class="refsect3">
<a name="id-1.2.2.9.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.8.6"></a><h4>Returns</h4>
<p> TRUE if playing</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-set-volume"></a><h3>rb_player_set_volume ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_player_set_volume (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>,
<em class="parameter"><code><span class="type">float</span> volume</code></em>);</pre>
<p>Adjusts the output volume level. This affects all streams.
The player may use a hardware volume control to implement
this volume adjustment.</p>
<div class="refsect3">
<a name="id-1.2.2.9.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>volume</p></td>
<td class="parameter_description"><p>new output volume level</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-get-volume"></a><h3>rb_player_get_volume ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>
rb_player_get_volume (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>);</pre>
<p>Returns the current volume level, between 0.0 and 1.0.</p>
<div class="refsect3">
<a name="id-1.2.2.9.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.10.6"></a><h4>Returns</h4>
<p> current output volume level</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-seekable"></a><h3>rb_player_seekable ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_player_seekable (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>);</pre>
<p>Determines whether seeking is supported for the current stream.</p>
<div class="refsect3">
<a name="id-1.2.2.9.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.11.6"></a><h4>Returns</h4>
<p> TRUE if the current stream is seekable</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-set-time"></a><h3>rb_player_set_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_player_set_time (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> newtime</code></em>);</pre>
<p>Attempts to seek in the current stream. The player
may ignore this if the stream is not seekable.
The seek may take place asynchronously.</p>
<div class="refsect3">
<a name="id-1.2.2.9.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>newtime</p></td>
<td class="parameter_description"><p>seek target position in seconds</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-get-time"></a><h3>rb_player_get_time ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="returnvalue">gint64</span></a>
rb_player_get_time (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>);</pre>
<p>Returns the current playback for the current stream in nanoseconds.</p>
<div class="refsect3">
<a name="id-1.2.2.9.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.13.6"></a><h4>Returns</h4>
<p> playback position</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-player-multiple-open"></a><h3>rb_player_multiple_open ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_player_multiple_open (<em class="parameter"><code><a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player</code></em>);</pre>
<p>Determines whether the player supports multiple open streams.</p>
<div class="refsect3">
<a name="id-1.2.2.9.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.9.14.6"></a><h4>Returns</h4>
<p> TRUE if multiple open is supported</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="RBPlayer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBPlayer-struct"></a><h3>RBPlayer</h3>
<pre class="programlisting">typedef struct _RBPlayer RBPlayer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayerIface"></a><h3>struct RBPlayerIface</h3>
<pre class="programlisting">struct RBPlayerIface {
GTypeInterface g_iface;
/* virtual functions */
gboolean (*open) (RBPlayer *player,
const char *uri,
gpointer stream_data,
GDestroyNotify stream_data_destroy,
GError **error);
gboolean (*opened) (RBPlayer *player);
gboolean (*close) (RBPlayer *player,
const char *uri,
GError **error);
gboolean (*play) (RBPlayer *player,
RBPlayerPlayType play_type,
gint64 crossfade,
GError **error);
void (*pause) (RBPlayer *player);
gboolean (*playing) (RBPlayer *player);
void (*set_volume) (RBPlayer *player,
float volume);
float (*get_volume) (RBPlayer *player);
gboolean (*seekable) (RBPlayer *player);
void (*set_time) (RBPlayer *player,
gint64 newtime);
gint64 (*get_time) (RBPlayer *player);
gboolean (*multiple_open) (RBPlayer *player);
/* signals */
void (*playing_stream) (RBPlayer *player,
gpointer stream_data);
void (*eos) (RBPlayer *player,
gpointer stream_data,
gboolean early);
void (*info) (RBPlayer *player,
gpointer stream_data,
RBMetaDataField field,
GValue *value);
void (*buffering) (RBPlayer *player,
gpointer stream_data,
guint progress);
void (*error) (RBPlayer *player,
gpointer stream_data,
GError *error);
void (*tick) (RBPlayer *player,
gpointer stream_data,
gint64 elapsed,
gint64 duration);
void (*event) (RBPlayer *player,
gpointer stream_data,
gpointer data);
void (*volume_changed) (RBPlayer *player,
float volume);
void (*image) (RBPlayer *player,
gpointer stream_data,
GdkPixbuf *image);
void (*redirect) (RBPlayer *player,
gpointer stream_data,
const gchar *uri);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayerPlayType"></a><h3>enum RBPlayerPlayType</h3>
<div class="refsect3">
<a name="id-1.2.2.10.4.3"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="RB-PLAYER-PLAY-REPLACE:CAPS"></a>RB_PLAYER_PLAY_REPLACE</p></td>
<td class="enum_member_description">
<p>Replace the existing stream</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-PLAYER-PLAY-AFTER-EOS:CAPS"></a>RB_PLAYER_PLAY_AFTER_EOS</p></td>
<td class="enum_member_description">
<p>Start the new stream after the current stream ends</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-PLAYER-PLAY-CROSSFADE:CAPS"></a>RB_PLAYER_PLAY_CROSSFADE</p></td>
<td class="enum_member_description">
<p>Crossfade between the existing stream and the new stream</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayerError"></a><h3>enum RBPlayerError</h3>
<div class="refsect3">
<a name="id-1.2.2.10.5.3"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="RB-PLAYER-ERROR-NO-AUDIO:CAPS"></a>RB_PLAYER_ERROR_NO_AUDIO</p></td>
<td class="enum_member_description">
<p>Audio playback not available</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-PLAYER-ERROR-GENERAL:CAPS"></a>RB_PLAYER_ERROR_GENERAL</p></td>
<td class="enum_member_description">
<p>Nonspecific error</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-PLAYER-ERROR-INTERNAL:CAPS"></a>RB_PLAYER_ERROR_INTERNAL</p></td>
<td class="enum_member_description">
<p>Internal error</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="RB-PLAYER-ERROR-NOT-FOUND:CAPS"></a>RB_PLAYER_ERROR_NOT_FOUND</p></td>
<td class="enum_member_description">
<p>The resource could not be found</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RBPlayer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RBPlayer-buffering"></a><h3>The <code class="literal">“buffering”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> progress,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'buffering' signal is emitted while a stream is paused so
that a buffer can be filled. The progress value typically varies
from 0 to 100, and once it reaches 100, playback resumes.</p>
<div class="refsect3">
<a name="id-1.2.2.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>the data associated with the buffering stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>progress</p></td>
<td class="parameter_description"><p>buffering percentage</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-eos"></a><h3>The <code class="literal">“eos”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> early,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'eos' signal is emitted when a stream finishes, or in some cases, when it
is about to finish (with <em class="parameter"><code>early</code></em>
set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>) to allow for a new track to be
played immediately afterwards.</p>
<div class="refsect3">
<a name="id-1.2.2.11.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>the data associated with the stream that finished</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>early</p></td>
<td class="parameter_description"><p>if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the EOS notification should only be used for track changes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: No Recursion</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-error"></a><h3>The <code class="literal">“error”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> error,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'error' signal is emitted when an error is encountered
while opening or playing a stream.</p>
<div class="refsect3">
<a name="id-1.2.2.11.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>the data associated with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>description of the error</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: No Recursion</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-event"></a><h3>The <code class="literal">“event”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'event' signal provides a means for custom GStreamer
elements to communicate events back to the rest of the
application. The GStreamer element posts an application
message on the GStreamer bus, which is translated into an
event signal with the detail of the signal set to the name
of the structure found in the message.</p>
<div class="refsect3">
<a name="id-1.2.2.11.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>data associated with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>event data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Has Details</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-image"></a><h3>The <code class="literal">“image”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *image,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'image' signal is emitted to provide access to images extracted
from the stream.</p>
<div class="refsect3">
<a name="id-1.2.2.11.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>data associated with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>image</p></td>
<td class="parameter_description"><p>the image extracted from the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-info"></a><h3>The <code class="literal">“info”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> field,
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'info' signal is emitted when a metadata value is found in
the stream.</p>
<div class="refsect3">
<a name="id-1.2.2.11.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>the data associated with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>field</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBMetaData.html#RBMetaDataField" title="enum RBMetaDataField"><span class="type">RBMetaDataField</span></a> corresponding to the stream info</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the value of the stream info field</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-playing-stream"></a><h3>The <code class="literal">“playing-stream”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'playing-stream' signal is emitted when the main playing stream
changes. It should be used to update the UI to show the new
stream. It can either be emitted before or after <a class="link" href="RBPlayer.html#rb-player-play" title="rb_player_play ()"><span class="type">rb_player_play</span></a> returns,
depending on the player backend.</p>
<div class="refsect3">
<a name="id-1.2.2.11.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>data associated with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-redirect"></a><h3>The <code class="literal">“redirect”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'redirect' signal is emitted to indicate when a stream has change URI.</p>
<div class="refsect3">
<a name="id-1.2.2.11.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>data associated with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>URI to redirect to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-tick"></a><h3>The <code class="literal">“tick”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> stream_data,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> elapsed,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a> duration,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'tick' signal is emitted repeatedly while the stream is
playing. Signal handlers can use this to update UI and to
prepare new streams for crossfade or gapless playback.</p>
<div class="refsect3">
<a name="id-1.2.2.11.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stream_data</p></td>
<td class="parameter_description"><p>the data associated with the stream</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>elapsed</p></td>
<td class="parameter_description"><p>playback position in the stream (in nanoseconds)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>duration</p></td>
<td class="parameter_description"><p>current estimate of the duration of the stream
(in nanoseconds)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="RBPlayer-volume-changed"></a><h3>The <code class="literal">“volume-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a> *player,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> volume,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The 'volume-changed' signal is emitted when the output stream volume is
changed externally.</p>
<div class="refsect3">
<a name="id-1.2.2.11.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>player</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBPlayer.html" title="RBPlayer"><span class="type">RBPlayer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>volume</p></td>
<td class="parameter_description"><p>the new volume level</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|
