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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="RBShellPlayer">
<refmeta>
<refentrytitle role="top_of_page" id="RBShellPlayer.top_of_page">rb-shell-player</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rb-shell-player</refname>
<refpurpose>playback state management</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="RBShellPlayer.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="RBShellPlayer-struct">RBShellPlayer</link>;
<link linkend="RBShellPlayerClass">RBShellPlayerClass</link>;
enum <link linkend="RBShellPlayerError">RBShellPlayerError</link>;
<link linkend="RBShellPlayer">RBShellPlayer</link>* <link linkend="rb-shell-player-new">rb_shell_player_new</link> (<link linkend="RhythmDB">RhythmDB</link> *db,
<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
<link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup);
<link linkend="void">void</link> <link linkend="rb-shell-player-set-selected-source">rb_shell_player_set_selected_source</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RBSource">RBSource</link> *source);
<link linkend="void">void</link> <link linkend="rb-shell-player-set-playing-source">rb_shell_player_set_playing_source</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RBSource">RBSource</link> *source);
<link linkend="RBSource">RBSource</link>* <link linkend="rb-shell-player-get-playing-source">rb_shell_player_get_playing_source</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="RBSource">RBSource</link>* <link linkend="rb-shell-player-get-active-source">rb_shell_player_get_active_source</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="void">void</link> <link linkend="rb-shell-player-jump-to-current">rb_shell_player_jump_to_current</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="void">void</link> <link linkend="rb-shell-player-play-entry">rb_shell_player_play_entry</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
<link linkend="RBSource">RBSource</link> *source);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-play">rb_shell_player_play</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-pause">rb_shell_player_pause</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-playpause">rb_shell_player_playpause</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> unused,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="rb-shell-player-stop">rb_shell_player_stop</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-do-previous">rb_shell_player_do_previous</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-do-next">rb_shell_player_do_next</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);
<link linkend="char">char</link>* <link linkend="rb-shell-player-get-playing-time-string">rb_shell_player_get_playing_time_string</link>
(<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-get-playing-time">rb_shell_player_get_playing_time</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="guint">guint</link> *time,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-set-playing-time">rb_shell_player_set_playing_time</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="guint">guint</link> time,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="rb-shell-player-seek">rb_shell_player_seek</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
long <link linkend="offset">offset</link> );
<link linkend="long">long</link> <link linkend="rb-shell-player-get-playing-song-duration">rb_shell_player_get_playing_song_duration</link>
(<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-get-playing">rb_shell_player_get_playing</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> *playing,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-get-playing-path">rb_shell_player_get_playing_path</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
const <link linkend="gchar">gchar</link> **path,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="rb-shell-player-set-playback-state">rb_shell_player_set_playback_state</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> shuffle,
<link linkend="gboolean">gboolean</link> repeat);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-get-playback-state">rb_shell_player_get_playback_state</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> *shuffle,
<link linkend="gboolean">gboolean</link> *repeat);
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-shell-player-get-playing-entry">rb_shell_player_get_playing_entry</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="void">void</link> <link linkend="rb-shell-player-toggle-mute">rb_shell_player_toggle_mute</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-set-volume">rb_shell_player_set_volume</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gdouble">gdouble</link> volume,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-get-volume">rb_shell_player_get_volume</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gdouble">gdouble</link> *volume,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-set-volume-relative">rb_shell_player_set_volume_relative</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gdouble">gdouble</link> delta,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-set-mute">rb_shell_player_set_mute</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> mute,
<link linkend="GError">GError</link> **error);
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-player-get-mute">rb_shell_player_get_mute</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> *mute,
<link linkend="GError">GError</link> **error);
<link linkend="void">void</link> <link linkend="rb-shell-player-add-play-order">rb_shell_player_add_play_order</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *description,
<link linkend="GType">GType</link> order_type,
<link linkend="gboolean">gboolean</link> hidden);
<link linkend="void">void</link> <link linkend="rb-shell-player-remove-play-order">rb_shell_player_remove_play_order</link> (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
const <link linkend="char">char</link> *name);
</synopsis>
</refsynopsisdiv>
<refsect1 id="RBShellPlayer.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkHBox">GtkHBox</link>
+----RBShellPlayer
</synopsis>
</refsect1>
<refsect1 id="RBShellPlayer.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
RBShellPlayer implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>
<refsect1 id="RBShellPlayer.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="RBShellPlayer--action-group">action-group</link>" <link linkend="GtkActionGroup">GtkActionGroup</link>* : Read / Write / Construct Only
"<link linkend="RBShellPlayer--db">db</link>" <link linkend="RhythmDB">RhythmDB</link>* : Read / Write / Construct Only
"<link linkend="RBShellPlayer--play-order">play-order</link>" <link linkend="gchar">gchar</link>* : Read
"<link linkend="RBShellPlayer--player">player</link>" <link linkend="GObject">GObject</link>* : Read
"<link linkend="RBShellPlayer--playing">playing</link>" <link linkend="gboolean">gboolean</link> : Read
"<link linkend="RBShellPlayer--playing-from-queue">playing-from-queue</link>" <link linkend="gboolean">gboolean</link> : Read
"<link linkend="RBShellPlayer--queue-only">queue-only</link>" <link linkend="gboolean">gboolean</link> : Read / Write
"<link linkend="RBShellPlayer--queue-source">queue-source</link>" <link linkend="RBPlaylistSource">RBPlaylistSource</link>* : Read / Write
"<link linkend="RBShellPlayer--source">source</link>" <link linkend="RBSource">RBSource</link>* : Read / Write
"<link linkend="RBShellPlayer--statusbar">statusbar</link>" <link linkend="RBStatusbar">RBStatusbar</link>* : Read / Write
"<link linkend="RBShellPlayer--ui-manager">ui-manager</link>" <link linkend="GtkUIManager">GtkUIManager</link>* : Read / Write / Construct Only
"<link linkend="RBShellPlayer--volume">volume</link>" <link linkend="gfloat">gfloat</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="RBShellPlayer.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="RBShellPlayer-elapsed-changed">elapsed-changed</link>" : Run Last
"<link linkend="RBShellPlayer-missing-plugins">missing-plugins</link>" : Run Last
"<link linkend="RBShellPlayer-playing-changed">playing-changed</link>" : Run Last
"<link linkend="RBShellPlayer-playing-song-changed">playing-song-changed</link>" : Run Last
"<link linkend="RBShellPlayer-playing-song-property-changed">playing-song-property-changed</link>" : Run Last
"<link linkend="RBShellPlayer-playing-source-changed">playing-source-changed</link>" : Run Last
"<link linkend="RBShellPlayer-playing-uri-changed">playing-uri-changed</link>" : Run Last
"<link linkend="RBShellPlayer-window-title-changed">window-title-changed</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="RBShellPlayer.description" role="desc">
<title role="desc.title">Description</title>
<para>
The shell player (or player shell, depending on who you're talking to)
manages the <link linkend="RBPlayer"><type>RBPlayer</type></link> instance, tracks the current playing <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link>,
and manages the various <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link> instances. It provides simple operations
such as next, previous, play/pause, and seek.
</para>
<para>
When playing internet radio streams, it first attempts to read the straem URL
as a playlist. If this succeeds, the URLs from the playlist are stored in a
list and tried in turn in case of errors. If the playlist parsing fails, the
stream URL is played directly.
</para>
<para>
The mapping from the separate shuffle and repeat settings to an <link linkend="RBPlayOrder"><type>RBPlayOrder</type></link>
instance occurs in here. The play order logic can also support a number of
additional play orders not accessible via the shuffle and repeat buttons.
</para>
<para>
If the player backend supports multiple streams, the shell player crossfades
between streams by watching the elapsed time of the current stream and simulating
an end-of-stream event when it gets within the crossfade duration of the actual
end.</para>
<para>
</para>
</refsect1>
<refsect1 id="RBShellPlayer.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="RBShellPlayer-struct" role="struct">
<title>RBShellPlayer</title>
<indexterm zone="RBShellPlayer-struct"><primary>RBShellPlayer</primary></indexterm><programlisting>typedef struct _RBShellPlayer RBShellPlayer;</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBShellPlayerClass" role="struct">
<title>RBShellPlayerClass</title>
<indexterm zone="RBShellPlayerClass"><primary>RBShellPlayerClass</primary></indexterm><programlisting>typedef struct {
GtkHBoxClass parent_class;
void (*window_title_changed) (RBShellPlayer *player, const char *window_title);
void (*elapsed_changed) (RBShellPlayer *player, guint elapsed);
void (*playing_changed) (RBShellPlayer *player, gboolean playing);
void (*playing_source_changed) (RBShellPlayer *player, RBSource *source);
void (*playing_uri_changed) (RBShellPlayer *player, const char *uri);
void (*playing_song_changed) (RBShellPlayer *player, RhythmDBEntry *entry);
void (*playing_song_property_changed) (RBShellPlayer *player,
const char *uri,
const char *property,
GValue *old,
GValue *newValue);
} RBShellPlayerClass;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="RBShellPlayerError" role="enum">
<title>enum RBShellPlayerError</title>
<indexterm zone="RBShellPlayerError"><primary>RBShellPlayerError</primary></indexterm><programlisting>typedef enum
{
RB_SHELL_PLAYER_ERROR_PLAYLIST_PARSE_ERROR,
RB_SHELL_PLAYER_ERROR_END_OF_PLAYLIST,
RB_SHELL_PLAYER_ERROR_NOT_PLAYING,
RB_SHELL_PLAYER_ERROR_NOT_SEEKABLE,
RB_SHELL_PLAYER_ERROR_POSITION_NOT_AVAILABLE,
} RBShellPlayerError;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="rb-shell-player-new" role="function">
<title>rb_shell_player_new ()</title>
<indexterm zone="rb-shell-player-new"><primary>rb_shell_player_new</primary></indexterm><programlisting><link linkend="RBShellPlayer">RBShellPlayer</link>* rb_shell_player_new (<link linkend="RhythmDB">RhythmDB</link> *db,
<link linkend="GtkUIManager">GtkUIManager</link> *mgr,
<link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup);</programlisting>
<para>
Creates the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>db</parameter> :</term>
<listitem><simpara> the <link linkend="RhythmDB"><type>RhythmDB</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mgr</parameter> :</term>
<listitem><simpara> the <link linkend="GtkUIManager"><type>GtkUIManager</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>actiongroup</parameter> :</term>
<listitem><simpara> the <link linkend="GtkActionGroup"><type>GtkActionGroup</type></link> to use
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link> instance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-set-selected-source" role="function">
<title>rb_shell_player_set_selected_source ()</title>
<indexterm zone="rb-shell-player-set-selected-source"><primary>rb_shell_player_set_selected_source</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_set_selected_source (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Updates the player to reflect a new source being selected.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> to select
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-set-playing-source" role="function">
<title>rb_shell_player_set_playing_source ()</title>
<indexterm zone="rb-shell-player-set-playing-source"><primary>rb_shell_player_set_playing_source</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_set_playing_source (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Replaces the current playing source.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the new playing <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playing-source" role="function">
<title>rb_shell_player_get_playing_source ()</title>
<indexterm zone="rb-shell-player-get-playing-source"><primary>rb_shell_player_get_playing_source</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>* rb_shell_player_get_playing_source (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Retrieves the current playing source. That is, the source from
which the current song was drawn. This differs from
<link linkend="rb-shell-player-get-active-source"><type>rb_shell_player_get_active_source</type></link> when the current song came
from the play queue.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current playing <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-active-source" role="function">
<title>rb_shell_player_get_active_source ()</title>
<indexterm zone="rb-shell-player-get-active-source"><primary>rb_shell_player_get_active_source</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>* rb_shell_player_get_active_source (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Retrieves the active source. This is the source that the user
selected for playback.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the active <link linkend="RBSource"><type>RBSource</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-jump-to-current" role="function">
<title>rb_shell_player_jump_to_current ()</title>
<indexterm zone="rb-shell-player-jump-to-current"><primary>rb_shell_player_jump_to_current</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_jump_to_current (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Scrolls the <link linkend="RBEntryView"><type>RBEntryView</type></link> for the current playing source so that
the current playing entry is visible and selects the row for the
entry. If there is no current playing entry, the selection is
cleared instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-play-entry" role="function">
<title>rb_shell_player_play_entry ()</title>
<indexterm zone="rb-shell-player-play-entry"><primary>rb_shell_player_play_entry</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_play_entry (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
<link linkend="RBSource">RBSource</link> *source);</programlisting>
<para>
Plays a specified entry.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara> the <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link> to play
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the new <link linkend="RBSource"><type>RBSource</type></link> to set as playing (or NULL to use the
selected source)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-play" role="function">
<title>rb_shell_player_play ()</title>
<indexterm zone="rb-shell-player-play"><primary>rb_shell_player_play</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_play (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Starts playback, if it is not already playing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> error return
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> whether playback is now occurring (TRUE when successfully started
or already playing).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-pause" role="function">
<title>rb_shell_player_pause ()</title>
<indexterm zone="rb-shell-player-pause"><primary>rb_shell_player_pause</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_pause (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Pauses playback if possible, completely stopping if not.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> error return
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> whether playback is not occurring (TRUE when successfully
paused/stopped or playback was not occurring).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-playpause" role="function">
<title>rb_shell_player_playpause ()</title>
<indexterm zone="rb-shell-player-playpause"><primary>rb_shell_player_playpause</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_playpause (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> unused,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Toggles between playing and paused state. If there is no playing
entry, chooses an entry from (in order of preference) the play queue,
the selection in the current source, or the play order.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unused</parameter> :</term>
<listitem><simpara> nothing
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-stop" role="function">
<title>rb_shell_player_stop ()</title>
<indexterm zone="rb-shell-player-stop"><primary>rb_shell_player_stop</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_stop (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Completely stops playback, freeing resources and unloading the file.
</para>
<para>
In general <link linkend="rb-shell-player-pause"><function>rb_shell_player_pause()</function></link> should be used instead, as it stops the
audio, but does not completely free resources.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-do-previous" role="function">
<title>rb_shell_player_do_previous ()</title>
<indexterm zone="rb-shell-player-do-previous"><primary>rb_shell_player_do_previous</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_do_previous (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
If the current song has been playing for more than 3 seconds,
restarts it, otherwise, goes back to the previous song.
Fails if there is no current song, or if inside the first
3 seconds of the first song in the play order.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns any error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-do-next" role="function">
<title>rb_shell_player_do_next ()</title>
<indexterm zone="rb-shell-player-do-next"><primary>rb_shell_player_do_next</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_do_next (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Skips to the next song. Consults the play queue and handles
transitions between the play queue and the active source.
Fails if there is no entry to play after the current one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playing-time-string" role="function">
<title>rb_shell_player_get_playing_time_string ()</title>
<indexterm zone="rb-shell-player-get-playing-time-string"><primary>rb_shell_player_get_playing_time_string</primary></indexterm><programlisting><link linkend="char">char</link>* rb_shell_player_get_playing_time_string
(<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Constructs a string showing the current playback position,
taking the time display settings into account.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> allocated playing time string
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playing-time" role="function">
<title>rb_shell_player_get_playing_time ()</title>
<indexterm zone="rb-shell-player-get-playing-time"><primary>rb_shell_player_get_playing_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_get_playing_time (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="guint">guint</link> *time,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Retrieves the current playback position. Fails if
the player currently cannot provide the playback
position.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> returns the current playback position
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-set-playing-time" role="function">
<title>rb_shell_player_set_playing_time ()</title>
<indexterm zone="rb-shell-player-set-playing-time"><primary>rb_shell_player_set_playing_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_set_playing_time (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="guint">guint</link> time,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Attempts to set the playback position. Fails if the
current song is not seekable.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>time</parameter> :</term>
<listitem><simpara> the target playback position (in seconds)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-seek" role="function">
<title>rb_shell_player_seek ()</title>
<indexterm zone="rb-shell-player-seek"><primary>rb_shell_player_seek</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_seek (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
long <link linkend="offset">offset</link> );</programlisting>
<para>
Seeks forwards or backwards in the current playing song.
Does not return error information.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playing-song-duration" role="function">
<title>rb_shell_player_get_playing_song_duration ()</title>
<indexterm zone="rb-shell-player-get-playing-song-duration"><primary>rb_shell_player_get_playing_song_duration</primary></indexterm><programlisting><link linkend="long">long</link> rb_shell_player_get_playing_song_duration
(<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Retrieves the duration of the current playing song.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> duration, or -1 if not playing
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playing" role="function">
<title>rb_shell_player_get_playing ()</title>
<indexterm zone="rb-shell-player-get-playing"><primary>rb_shell_player_get_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_get_playing (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> *playing,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Reports whether playback is occuring by setting <link linkend="playing"><type>playing</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> a <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>playing</parameter> :</term>
<listitem><simpara> playback state return
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> error return
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playing-path" role="function">
<title>rb_shell_player_get_playing_path ()</title>
<indexterm zone="rb-shell-player-get-playing-path"><primary>rb_shell_player_get_playing_path</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_get_playing_path (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
const <link linkend="gchar">gchar</link> **path,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Retrieves the URI of the current playing entry. The
caller must not free the returned string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>path</parameter> :</term>
<listitem><simpara> returns the URI of the current playing entry
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-set-playback-state" role="function">
<title>rb_shell_player_set_playback_state ()</title>
<indexterm zone="rb-shell-player-set-playback-state"><primary>rb_shell_player_set_playback_state</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_set_playback_state (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> shuffle,
<link linkend="gboolean">gboolean</link> repeat);</programlisting>
<para>
Sets the state of the shuffle and repeat settings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>shuffle</parameter> :</term>
<listitem><simpara> whether to enable the shuffle setting
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>repeat</parameter> :</term>
<listitem><simpara> whether to enable the repeat setting
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playback-state" role="function">
<title>rb_shell_player_get_playback_state ()</title>
<indexterm zone="rb-shell-player-get-playback-state"><primary>rb_shell_player_get_playback_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_get_playback_state (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> *shuffle,
<link linkend="gboolean">gboolean</link> *repeat);</programlisting>
<para>
Retrieves the current state of the shuffle and repeat settings.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>shuffle</parameter> :</term>
<listitem><simpara> returns the current shuffle setting
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>repeat</parameter> :</term>
<listitem><simpara> returns the current repeat setting
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-playing-entry" role="function">
<title>rb_shell_player_get_playing_entry ()</title>
<indexterm zone="rb-shell-player-get-playing-entry"><primary>rb_shell_player_get_playing_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_shell_player_get_playing_entry (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Retrieves the currently playing <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link>, or NULL if
nothing is playing. The caller must unref the entry
(using <link linkend="rhythmdb-entry-unref"><type>rhythmdb_entry_unref</type></link>) when it is no longer needed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the currently playing <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link>, or NULL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-toggle-mute" role="function">
<title>rb_shell_player_toggle_mute ()</title>
<indexterm zone="rb-shell-player-toggle-mute"><primary>rb_shell_player_toggle_mute</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_toggle_mute (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
<para>
Toggles the mute setting on the player.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-set-volume" role="function">
<title>rb_shell_player_set_volume ()</title>
<indexterm zone="rb-shell-player-set-volume"><primary>rb_shell_player_set_volume</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_set_volume (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gdouble">gdouble</link> volume,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Sets the playback volume level.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>volume</parameter> :</term>
<listitem><simpara> the volume level (between 0 and 1)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns the error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-volume" role="function">
<title>rb_shell_player_get_volume ()</title>
<indexterm zone="rb-shell-player-get-volume"><primary>rb_shell_player_get_volume</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_get_volume (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gdouble">gdouble</link> *volume,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>volume</parameter> :</term>
<listitem><simpara> returns the volume level
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current volume level.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-set-volume-relative" role="function">
<title>rb_shell_player_set_volume_relative ()</title>
<indexterm zone="rb-shell-player-set-volume-relative"><primary>rb_shell_player_set_volume_relative</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_set_volume_relative (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gdouble">gdouble</link> delta,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Adds the specified value to the current volume level.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>delta</parameter> :</term>
<listitem><simpara> difference to apply to the volume level (between -1 and 1)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> on success
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-set-mute" role="function">
<title>rb_shell_player_set_mute ()</title>
<indexterm zone="rb-shell-player-set-mute"><primary>rb_shell_player_set_mute</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_set_mute (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> mute,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
Updates the mute setting on the player.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mute</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to mute playback
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if successful
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-get-mute" role="function">
<title>rb_shell_player_get_mute ()</title>
<indexterm zone="rb-shell-player-get-mute"><primary>rb_shell_player_get_mute</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_player_get_mute (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> *mute,
<link linkend="GError">GError</link> **error);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mute</parameter> :</term>
<listitem><simpara> returns the current mute setting
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> returns error information
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if currently muted
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-add-play-order" role="function">
<title>rb_shell_player_add_play_order ()</title>
<indexterm zone="rb-shell-player-add-play-order"><primary>rb_shell_player_add_play_order</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_add_play_order (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
const <link linkend="char">char</link> *name,
const <link linkend="char">char</link> *description,
<link linkend="GType">GType</link> order_type,
<link linkend="gboolean">gboolean</link> hidden);</programlisting>
<para>
Adds a new play order to the set of available play orders.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the new play order
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>description</parameter> :</term>
<listitem><simpara> description of the new play order
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>order_type</parameter> :</term>
<listitem><simpara> the <link linkend="GType"><type>GType</type></link> of the play order class
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hidden</parameter> :</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, don't display the play order in the UI
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="rb-shell-player-remove-play-order" role="function">
<title>rb_shell_player_remove_play_order ()</title>
<indexterm zone="rb-shell-player-remove-play-order"><primary>rb_shell_player_remove_play_order</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_player_remove_play_order (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
const <link linkend="char">char</link> *name);</programlisting>
<para>
Removes a play order previously added with <link linkend="rb-shell-player-add-play-order"><type>rb_shell_player_add_play_order</type></link>
from the set of available play orders.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> name of the play order to remove
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="RBShellPlayer.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="RBShellPlayer--action-group"><title>The <literal>"action-group"</literal> property</title>
<indexterm zone="RBShellPlayer--action-group"><primary>RBShellPlayer:action-group</primary></indexterm><programlisting> "action-group" <link linkend="GtkActionGroup">GtkActionGroup</link>* : Read / Write / Construct Only</programlisting>
<para>GtkActionGroup object.</para></refsect2>
<refsect2 id="RBShellPlayer--db"><title>The <literal>"db"</literal> property</title>
<indexterm zone="RBShellPlayer--db"><primary>RBShellPlayer:db</primary></indexterm><programlisting> "db" <link linkend="RhythmDB">RhythmDB</link>* : Read / Write / Construct Only</programlisting>
<para>RhythmDB object.</para></refsect2>
<refsect2 id="RBShellPlayer--play-order"><title>The <literal>"play-order"</literal> property</title>
<indexterm zone="RBShellPlayer--play-order"><primary>RBShellPlayer:play-order</primary></indexterm><programlisting> "play-order" <link linkend="gchar">gchar</link>* : Read</programlisting>
<para>What play order to use.</para><para>Default value: "linear"</para>
</refsect2>
<refsect2 id="RBShellPlayer--player"><title>The <literal>"player"</literal> property</title>
<indexterm zone="RBShellPlayer--player"><primary>RBShellPlayer:player</primary></indexterm><programlisting> "player" <link linkend="GObject">GObject</link>* : Read</programlisting>
<para>RBPlayer object.</para></refsect2>
<refsect2 id="RBShellPlayer--playing"><title>The <literal>"playing"</literal> property</title>
<indexterm zone="RBShellPlayer--playing"><primary>RBShellPlayer:playing</primary></indexterm><programlisting> "playing" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>Whether Rhythmbox is currently playing.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="RBShellPlayer--playing-from-queue"><title>The <literal>"playing-from-queue"</literal> property</title>
<indexterm zone="RBShellPlayer--playing-from-queue"><primary>RBShellPlayer:playing-from-queue</primary></indexterm><programlisting> "playing-from-queue" <link linkend="gboolean">gboolean</link> : Read</programlisting>
<para>Whether playing from the play queue or not.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="RBShellPlayer--queue-only"><title>The <literal>"queue-only"</literal> property</title>
<indexterm zone="RBShellPlayer--queue-only"><primary>RBShellPlayer:queue-only</primary></indexterm><programlisting> "queue-only" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Activation only adds to queue.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="RBShellPlayer--queue-source"><title>The <literal>"queue-source"</literal> property</title>
<indexterm zone="RBShellPlayer--queue-source"><primary>RBShellPlayer:queue-source</primary></indexterm><programlisting> "queue-source" <link linkend="RBPlaylistSource">RBPlaylistSource</link>* : Read / Write</programlisting>
<para>RBPlaylistSource object.</para></refsect2>
<refsect2 id="RBShellPlayer--source"><title>The <literal>"source"</literal> property</title>
<indexterm zone="RBShellPlayer--source"><primary>RBShellPlayer:source</primary></indexterm><programlisting> "source" <link linkend="RBSource">RBSource</link>* : Read / Write</programlisting>
<para>RBSource object.</para></refsect2>
<refsect2 id="RBShellPlayer--statusbar"><title>The <literal>"statusbar"</literal> property</title>
<indexterm zone="RBShellPlayer--statusbar"><primary>RBShellPlayer:statusbar</primary></indexterm><programlisting> "statusbar" <link linkend="RBStatusbar">RBStatusbar</link>* : Read / Write</programlisting>
<para>RBStatusbar object.</para></refsect2>
<refsect2 id="RBShellPlayer--ui-manager"><title>The <literal>"ui-manager"</literal> property</title>
<indexterm zone="RBShellPlayer--ui-manager"><primary>RBShellPlayer:ui-manager</primary></indexterm><programlisting> "ui-manager" <link linkend="GtkUIManager">GtkUIManager</link>* : Read / Write / Construct Only</programlisting>
<para>GtkUIManager object.</para></refsect2>
<refsect2 id="RBShellPlayer--volume"><title>The <literal>"volume"</literal> property</title>
<indexterm zone="RBShellPlayer--volume"><primary>RBShellPlayer:volume</primary></indexterm><programlisting> "volume" <link linkend="gfloat">gfloat</link> : Read / Write</programlisting>
<para>Current playback volume.</para><para>Allowed values: [0,1]</para>
<para>Default value: 1</para>
</refsect2>
</refsect1>
<refsect1 id="RBShellPlayer.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="RBShellPlayer-elapsed-changed"><title>The <literal>"elapsed-changed"</literal> signal</title>
<indexterm zone="RBShellPlayer-elapsed-changed"><primary>RBShellPlayer::elapsed-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="guint">guint</link> elapsed,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the playback position changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>elapsed</parameter> :</term>
<listitem><simpara> the new playback position in seconds
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBShellPlayer-missing-plugins"><title>The <literal>"missing-plugins"</literal> signal</title>
<indexterm zone="RBShellPlayer-missing-plugins"><primary>RBShellPlayer::missing-plugins</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="GStrv">GStrv</link> *details,
<link linkend="GStrv">GStrv</link> *descriptions,
<link linkend="GClosure">GClosure</link> *closure,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the player backend requires some plugins to be installed in
order to play the current playing song. When the closure included in the
signal args is called, playback will be attempted again.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>details</parameter> :</term>
<listitem><simpara> the list of plugin detail strings describing the missing plugins
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>descriptions</parameter> :</term>
<listitem><simpara> the list of descriptions for the missing plugins
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>closure</parameter> :</term>
<listitem><simpara> a <link linkend="GClosure"><type>GClosure</type></link> to be called when the plugin installation is complete
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBShellPlayer-playing-changed"><title>The <literal>"playing-changed"</literal> signal</title>
<indexterm zone="RBShellPlayer-playing-changed"><primary>RBShellPlayer::playing-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gboolean">gboolean</link> playing,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when playback either stops or starts.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>playing</parameter> :</term>
<listitem><simpara> flag indicating playback state
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBShellPlayer-playing-song-changed"><title>The <literal>"playing-song-changed"</literal> signal</title>
<indexterm zone="RBShellPlayer-playing-song-changed"><primary>RBShellPlayer::playing-song-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the playing database entry changes</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara> the new playing <link linkend="RhythmDBEntry"><type>RhythmDBEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBShellPlayer-playing-song-property-changed"><title>The <literal>"playing-song-property-changed"</literal> signal</title>
<indexterm zone="RBShellPlayer-playing-song-property-changed"><primary>RBShellPlayer::playing-song-property-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gchar">gchar</link> *uri,
<link linkend="gchar">gchar</link> *property,
<link linkend="GValue">GValue</link> *old,
<link linkend="GValue">GValue</link> *newvalue,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when a property of the playing database entry changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> the URI of the playing entry
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>property</parameter> :</term>
<listitem><simpara> the name of the property that changed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>old</parameter> :</term>
<listitem><simpara> the previous value for the property
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>newvalue</parameter> :</term>
<listitem><simpara> the new value of the property
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBShellPlayer-playing-source-changed"><title>The <literal>"playing-source-changed"</literal> signal</title>
<indexterm zone="RBShellPlayer-playing-source-changed"><primary>RBShellPlayer::playing-source-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="RBSource">RBSource</link> *source,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when a new <link linkend="RBSource"><type>RBSource</type></link> instance starts playing</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>source</parameter> :</term>
<listitem><simpara> the <link linkend="RBSource"><type>RBSource</type></link> that is now playing
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBShellPlayer-playing-uri-changed"><title>The <literal>"playing-uri-changed"</literal> signal</title>
<indexterm zone="RBShellPlayer-playing-uri-changed"><primary>RBShellPlayer::playing-uri-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gchar">gchar</link> *uri,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the playing database entry changes, providing the
URI of the entry.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> the URI of the new playing entry
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="RBShellPlayer-window-title-changed"><title>The <literal>"window-title-changed"</literal> signal</title>
<indexterm zone="RBShellPlayer-window-title-changed"><primary>RBShellPlayer::window-title-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
<link linkend="gchar">gchar</link> *title,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
Emitted when the main window title text should be changed</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter> :</term>
<listitem><simpara> the <link linkend="RBShellPlayer"><type>RBShellPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>title</parameter> :</term>
<listitem><simpara> the new window title
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
