~ubuntu-branches/ubuntu/precise/rhythmbox/precise-201203091205

« back to all changes in this revision

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

Tags: upstream-0.9.2cvs20060102
ImportĀ upstreamĀ versionĀ 0.9.2cvs20060102

Show diffs side-by-side

added added

removed removed

Lines of Context:
79
79
                                             long offset);
80
80
long        <a href="rhythmbox-rb-shell-player.html#rb-shell-player-get-playing-song-duration">rb_shell_player_get_playing_song_duration</a>
81
81
                                            (RBShellPlayer *player);
82
 
RBPlayer*   <a href="rhythmbox-rb-shell-player.html#rb-shell-player-get-mm-player">rb_shell_player_get_mm_player</a>   (RBShellPlayer *shell_player);
83
82
gboolean    <a href="rhythmbox-rb-shell-player.html#rb-shell-player-get-playing">rb_shell_player_get_playing</a>     (RBShellPlayer *shell_player,
84
83
                                             gboolean *playing,
85
84
                                             GError **error);
105
104
</pre>
106
105
</div>
107
106
<div class="refsect1" lang="en">
108
 
<a name="id2581783"></a><h2>Description</h2>
 
107
<a name="id2583763"></a><h2>Description</h2>
109
108
<p>
110
109
 
111
110
</p>
112
111
</div>
113
112
<div class="refsect1" lang="en">
114
 
<a name="id2581794"></a><h2>Details</h2>
 
113
<a name="id2572457"></a><h2>Details</h2>
115
114
<div class="refsect2" lang="en">
116
 
<a name="id2581800"></a><h3>
 
115
<a name="id2572463"></a><h3>
117
116
<a name="RBShellPlayerError"></a>enum RBShellPlayerError</h3>
118
 
<a class="indexterm" name="id2581810"></a><pre class="programlisting">typedef enum
 
117
<a class="indexterm" name="id2572472"></a><pre class="programlisting">typedef enum
119
118
{
120
119
        RB_SHELL_PLAYER_ERROR_PLAYLIST_PARSE_ERROR,
121
120
        RB_SHELL_PLAYER_ERROR_END_OF_PLAYLIST,
129
128
</div>
130
129
<hr>
131
130
<div class="refsect2" lang="en">
132
 
<a name="id2581829"></a><h3>
 
131
<a name="id2572491"></a><h3>
133
132
<a name="RB-SHELL-PLAYER-ERROR:CAPS"></a>RB_SHELL_PLAYER_ERROR</h3>
134
 
<a class="indexterm" name="id2581838"></a><pre class="programlisting">#define RB_SHELL_PLAYER_ERROR rb_shell_player_error_quark ()
 
133
<a class="indexterm" name="id2572500"></a><pre class="programlisting">#define RB_SHELL_PLAYER_ERROR rb_shell_player_error_quark ()
135
134
</pre>
136
135
<p>
137
136
 
139
138
</div>
140
139
<hr>
141
140
<div class="refsect2" lang="en">
142
 
<a name="id2581854"></a><h3>
 
141
<a name="id2572516"></a><h3>
143
142
<a name="rb-shell-player-error-quark"></a>rb_shell_player_error_quark ()</h3>
144
 
<a class="indexterm" name="id2581864"></a><pre class="programlisting">GQuark      rb_shell_player_error_quark     (void);</pre>
 
143
<a class="indexterm" name="id2572526"></a><pre class="programlisting">GQuark      rb_shell_player_error_quark     (void);</pre>
145
144
<p>
146
145
 
147
146
</p>
159
158
</div>
160
159
<hr>
161
160
<div class="refsect2" lang="en">
162
 
<a name="id2581900"></a><h3>
 
161
<a name="id2572562"></a><h3>
163
162
<a name="RBShellPlayerPrivate"></a>RBShellPlayerPrivate</h3>
164
 
<a class="indexterm" name="id2581909"></a><pre class="programlisting">typedef struct RBShellPlayerPrivate RBShellPlayerPrivate;
 
163
<a class="indexterm" name="id2572571"></a><pre class="programlisting">typedef struct RBShellPlayerPrivate RBShellPlayerPrivate;
165
164
</pre>
166
165
<p>
167
166
 
169
168
</div>
170
169
<hr>
171
170
<div class="refsect2" lang="en">
172
 
<a name="id2581925"></a><h3>
 
171
<a name="id2572587"></a><h3>
173
172
<a name="rb-shell-player-new"></a>rb_shell_player_new ()</h3>
174
 
<a class="indexterm" name="id2581935"></a><pre class="programlisting">RBShellPlayer* rb_shell_player_new          (RhythmDB *db,
 
173
<a class="indexterm" name="id2572597"></a><pre class="programlisting">RBShellPlayer* rb_shell_player_new          (RhythmDB *db,
175
174
                                             GtkUIManager *mgr,
176
175
                                             GtkActionGroup *actiongroup);</pre>
177
176
<p>
211
210
</div>
212
211
<hr>
213
212
<div class="refsect2" lang="en">
214
 
<a name="id2582034"></a><h3>
 
213
<a name="id2572696"></a><h3>
215
214
<a name="rb-shell-player-set-selected-source"></a>rb_shell_player_set_selected_source ()</h3>
216
 
<a class="indexterm" name="id2585611"></a><pre class="programlisting">void        rb_shell_player_set_selected_source
 
215
<a class="indexterm" name="id2572707"></a><pre class="programlisting">void        rb_shell_player_set_selected_source
217
216
                                            (RBShellPlayer *shell_player,
218
217
                                             RBSource *player);</pre>
219
218
<p>
241
240
</div>
242
241
<hr>
243
242
<div class="refsect2" lang="en">
244
 
<a name="id2585671"></a><h3>
 
243
<a name="id2585916"></a><h3>
245
244
<a name="rb-shell-player-set-playing-source"></a>rb_shell_player_set_playing_source ()</h3>
246
 
<a class="indexterm" name="id2585680"></a><pre class="programlisting">void        rb_shell_player_set_playing_source
 
245
<a class="indexterm" name="id2585924"></a><pre class="programlisting">void        rb_shell_player_set_playing_source
247
246
                                            (RBShellPlayer *player,
248
247
                                             RBSource *source);</pre>
249
248
<p>
271
270
</div>
272
271
<hr>
273
272
<div class="refsect2" lang="en">
274
 
<a name="id2585742"></a><h3>
 
273
<a name="id2585985"></a><h3>
275
274
<a name="rb-shell-player-get-playing-source"></a>rb_shell_player_get_playing_source ()</h3>
276
 
<a class="indexterm" name="id2585753"></a><pre class="programlisting">RBSource*   rb_shell_player_get_playing_source
 
275
<a class="indexterm" name="id2585996"></a><pre class="programlisting">RBSource*   rb_shell_player_get_playing_source
277
276
                                            (RBShellPlayer *shell_player);</pre>
278
277
<p>
279
278
 
300
299
</div>
301
300
<hr>
302
301
<div class="refsect2" lang="en">
303
 
<a name="id2585810"></a><h3>
 
302
<a name="id2586052"></a><h3>
304
303
<a name="rb-shell-player-jump-to-current"></a>rb_shell_player_jump_to_current ()</h3>
305
 
<a class="indexterm" name="id2585821"></a><pre class="programlisting">void        rb_shell_player_jump_to_current (RBShellPlayer *player);</pre>
 
304
<a class="indexterm" name="id2586063"></a><pre class="programlisting">void        rb_shell_player_jump_to_current (RBShellPlayer *player);</pre>
306
305
<p>
307
306
 
308
307
</p>
320
319
</div>
321
320
<hr>
322
321
<div class="refsect2" lang="en">
323
 
<a name="id2585867"></a><h3>
 
322
<a name="id2586109"></a><h3>
324
323
<a name="rb-shell-player-play-entry"></a>rb_shell_player_play_entry ()</h3>
325
 
<a class="indexterm" name="id2585877"></a><pre class="programlisting">void        rb_shell_player_play_entry      (RBShellPlayer *player,
 
324
<a class="indexterm" name="id2586119"></a><pre class="programlisting">void        rb_shell_player_play_entry      (RBShellPlayer *player,
326
325
                                             <a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a> *entry);</pre>
327
326
<p>
328
327
 
349
348
</div>
350
349
<hr>
351
350
<div class="refsect2" lang="en">
352
 
<a name="id2585944"></a><h3>
 
351
<a name="id2586186"></a><h3>
353
352
<a name="rb-shell-player-playpause"></a>rb_shell_player_playpause ()</h3>
354
 
<a class="indexterm" name="id2585954"></a><pre class="programlisting">gboolean    rb_shell_player_playpause       (RBShellPlayer *player,
 
353
<a class="indexterm" name="id2586195"></a><pre class="programlisting">gboolean    rb_shell_player_playpause       (RBShellPlayer *player,
355
354
                                             gboolean ignore_stop,
356
355
                                             GError **error);</pre>
357
356
<p>
391
390
</div>
392
391
<hr>
393
392
<div class="refsect2" lang="en">
394
 
<a name="id2586052"></a><h3>
 
393
<a name="id2586294"></a><h3>
395
394
<a name="rb-shell-player-stop"></a>rb_shell_player_stop ()</h3>
396
 
<a class="indexterm" name="id2586061"></a><pre class="programlisting">void        rb_shell_player_stop            (RBShellPlayer *player);</pre>
 
395
<a class="indexterm" name="id2586303"></a><pre class="programlisting">void        rb_shell_player_stop            (RBShellPlayer *player);</pre>
397
396
<p>
398
397
 
399
398
</p>
411
410
</div>
412
411
<hr>
413
412
<div class="refsect2" lang="en">
414
 
<a name="id2586107"></a><h3>
 
413
<a name="id2586348"></a><h3>
415
414
<a name="rb-shell-player-do-previous"></a>rb_shell_player_do_previous ()</h3>
416
 
<a class="indexterm" name="id2586116"></a><pre class="programlisting">gboolean    rb_shell_player_do_previous     (RBShellPlayer *player,
 
415
<a class="indexterm" name="id2586358"></a><pre class="programlisting">gboolean    rb_shell_player_do_previous     (RBShellPlayer *player,
417
416
                                             GError **error);</pre>
418
417
<p>
419
418
 
446
445
</div>
447
446
<hr>
448
447
<div class="refsect2" lang="en">
449
 
<a name="id2586194"></a><h3>
 
448
<a name="id2586436"></a><h3>
450
449
<a name="rb-shell-player-do-next"></a>rb_shell_player_do_next ()</h3>
451
 
<a class="indexterm" name="id2586203"></a><pre class="programlisting">gboolean    rb_shell_player_do_next         (RBShellPlayer *player,
 
450
<a class="indexterm" name="id2586444"></a><pre class="programlisting">gboolean    rb_shell_player_do_next         (RBShellPlayer *player,
452
451
                                             GError **error);</pre>
453
452
<p>
454
453
 
481
480
</div>
482
481
<hr>
483
482
<div class="refsect2" lang="en">
484
 
<a name="id2586280"></a><h3>
 
483
<a name="id2586522"></a><h3>
485
484
<a name="rb-shell-player-get-playing-time"></a>rb_shell_player_get_playing_time ()</h3>
486
 
<a class="indexterm" name="id2586291"></a><pre class="programlisting">gboolean    rb_shell_player_get_playing_time
 
485
<a class="indexterm" name="id2586533"></a><pre class="programlisting">gboolean    rb_shell_player_get_playing_time
487
486
                                            (RBShellPlayer *player,
488
487
                                             guint *time,
489
488
                                             GError **error);</pre>
524
523
</div>
525
524
<hr>
526
525
<div class="refsect2" lang="en">
527
 
<a name="id2586391"></a><h3>
 
526
<a name="id2586633"></a><h3>
528
527
<a name="rb-shell-player-set-playing-time"></a>rb_shell_player_set_playing_time ()</h3>
529
 
<a class="indexterm" name="id2586402"></a><pre class="programlisting">gboolean    rb_shell_player_set_playing_time
 
528
<a class="indexterm" name="id2586644"></a><pre class="programlisting">gboolean    rb_shell_player_set_playing_time
530
529
                                            (RBShellPlayer *player,
531
530
                                             guint time,
532
531
                                             GError **error);</pre>
565
564
</div>
566
565
<hr>
567
566
<div class="refsect2" lang="en">
568
 
<a name="id2586502"></a><h3>
 
567
<a name="id2586744"></a><h3>
569
568
<a name="rb-shell-player-seek"></a>rb_shell_player_seek ()</h3>
570
 
<a class="indexterm" name="id2586511"></a><pre class="programlisting">void        rb_shell_player_seek            (RBShellPlayer *player,
 
569
<a class="indexterm" name="id2586752"></a><pre class="programlisting">void        rb_shell_player_seek            (RBShellPlayer *player,
571
570
                                             long offset);</pre>
572
571
<p>
573
572
 
594
593
</div>
595
594
<hr>
596
595
<div class="refsect2" lang="en">
597
 
<a name="id2586578"></a><h3>
 
596
<a name="id2586819"></a><h3>
598
597
<a name="rb-shell-player-get-playing-song-duration"></a>rb_shell_player_get_playing_song_duration ()</h3>
599
 
<a class="indexterm" name="id2586590"></a><pre class="programlisting">long        rb_shell_player_get_playing_song_duration
 
598
<a class="indexterm" name="id2586832"></a><pre class="programlisting">long        rb_shell_player_get_playing_song_duration
600
599
                                            (RBShellPlayer *player);</pre>
601
600
<p>
602
601
 
623
622
</div>
624
623
<hr>
625
624
<div class="refsect2" lang="en">
626
 
<a name="id2586647"></a><h3>
627
 
<a name="rb-shell-player-get-mm-player"></a>rb_shell_player_get_mm_player ()</h3>
628
 
<a class="indexterm" name="id2586658"></a><pre class="programlisting">RBPlayer*   rb_shell_player_get_mm_player   (RBShellPlayer *shell_player);</pre>
629
 
<p>
630
 
 
631
 
</p>
632
 
<div class="variablelist"><table border="0">
633
 
<col align="left" valign="top">
634
 
<tbody>
635
 
<tr>
636
 
<td>
637
 
<span class="term"><em class="parameter"><code>shell_player</code></em>&#160;:</span></td>
638
 
<td>
639
 
</td>
640
 
</tr>
641
 
<tr>
642
 
<td>
643
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
644
 
<td>
645
 
 
646
 
 
647
 
</td>
648
 
</tr>
649
 
</tbody>
650
 
</table></div>
651
 
</div>
652
 
<hr>
653
 
<div class="refsect2" lang="en">
654
 
<a name="id2586716"></a><h3>
 
625
<a name="id2586889"></a><h3>
655
626
<a name="rb-shell-player-get-playing"></a>rb_shell_player_get_playing ()</h3>
656
 
<a class="indexterm" name="id2586725"></a><pre class="programlisting">gboolean    rb_shell_player_get_playing     (RBShellPlayer *shell_player,
 
627
<a class="indexterm" name="id2586898"></a><pre class="programlisting">gboolean    rb_shell_player_get_playing     (RBShellPlayer *shell_player,
657
628
                                             gboolean *playing,
658
629
                                             GError **error);</pre>
659
630
<p>
693
664
</div>
694
665
<hr>
695
666
<div class="refsect2" lang="en">
696
 
<a name="id2586824"></a><h3>
 
667
<a name="id2586997"></a><h3>
697
668
<a name="rb-shell-player-get-playing-path"></a>rb_shell_player_get_playing_path ()</h3>
698
 
<a class="indexterm" name="id2586835"></a><pre class="programlisting">gboolean    rb_shell_player_get_playing_path
 
669
<a class="indexterm" name="id2587008"></a><pre class="programlisting">gboolean    rb_shell_player_get_playing_path
699
670
                                            (RBShellPlayer *shell_player,
700
671
                                             const gchar **path,
701
672
                                             GError **error);</pre>
736
707
</div>
737
708
<hr>
738
709
<div class="refsect2" lang="en">
739
 
<a name="id2586935"></a><h3>
 
710
<a name="id2587108"></a><h3>
740
711
<a name="rb-shell-player-sync-buttons"></a>rb_shell_player_sync_buttons ()</h3>
741
 
<a class="indexterm" name="id2586946"></a><pre class="programlisting">void        rb_shell_player_sync_buttons    (RBShellPlayer *player);</pre>
 
712
<a class="indexterm" name="id2587119"></a><pre class="programlisting">void        rb_shell_player_sync_buttons    (RBShellPlayer *player);</pre>
742
713
<p>
743
714
 
744
715
</p>
756
727
</div>
757
728
<hr>
758
729
<div class="refsect2" lang="en">
759
 
<a name="id2586992"></a><h3>
 
730
<a name="id2587166"></a><h3>
760
731
<a name="rb-shell-player-set-playback-state"></a>rb_shell_player_set_playback_state ()</h3>
761
 
<a class="indexterm" name="id2587004"></a><pre class="programlisting">void        rb_shell_player_set_playback_state
 
732
<a class="indexterm" name="id2587177"></a><pre class="programlisting">void        rb_shell_player_set_playback_state
762
733
                                            (RBShellPlayer *player,
763
734
                                             gboolean shuffle,
764
735
                                             gboolean repeat);</pre>
793
764
</div>
794
765
<hr>
795
766
<div class="refsect2" lang="en">
796
 
<a name="id2587093"></a><h3>
 
767
<a name="id2587266"></a><h3>
797
768
<a name="rb-shell-player-get-playback-state"></a>rb_shell_player_get_playback_state ()</h3>
798
 
<a class="indexterm" name="id2587104"></a><pre class="programlisting">gboolean    rb_shell_player_get_playback_state
 
769
<a class="indexterm" name="id2587278"></a><pre class="programlisting">gboolean    rb_shell_player_get_playback_state
799
770
                                            (RBShellPlayer *player,
800
771
                                             gboolean *shuffle,
801
772
                                             gboolean *repeat);</pre>
836
807
</div>
837
808
<hr>
838
809
<div class="refsect2" lang="en">
839
 
<a name="id2587204"></a><h3>
 
810
<a name="id2587377"></a><h3>
840
811
<a name="rb-shell-player-get-playing-entry"></a>rb_shell_player_get_playing_entry ()</h3>
841
 
<a class="indexterm" name="id2587216"></a><pre class="programlisting"><a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a>* rb_shell_player_get_playing_entry
 
812
<a class="indexterm" name="id2587389"></a><pre class="programlisting"><a href="rhythmbox-rhythmdb.html#RhythmDBEntry">RhythmDBEntry</a>* rb_shell_player_get_playing_entry
842
813
                                            (RBShellPlayer *player);</pre>
843
814
<p>
844
815
 
865
836
</div>
866
837
<hr>
867
838
<div class="refsect2" lang="en">
868
 
<a name="id2587251"></a><h3>
 
839
<a name="id2587446"></a><h3>
869
840
<a name="rb-shell-player-toggle-mute"></a>rb_shell_player_toggle_mute ()</h3>
870
 
<a class="indexterm" name="id2587260"></a><pre class="programlisting">void        rb_shell_player_toggle_mute     (RBShellPlayer *player);</pre>
 
841
<a class="indexterm" name="id2587456"></a><pre class="programlisting">void        rb_shell_player_toggle_mute     (RBShellPlayer *player);</pre>
871
842
<p>
872
843
 
873
844
</p>
885
856
</div>
886
857
<hr>
887
858
<div class="refsect2" lang="en">
888
 
<a name="id2587300"></a><h3>
 
859
<a name="id2587502"></a><h3>
889
860
<a name="rb-shell-player-handle-key"></a>rb_shell_player_handle_key ()</h3>
890
 
<a class="indexterm" name="id2587309"></a><pre class="programlisting">gboolean    rb_shell_player_handle_key      (RBShellPlayer *player,
 
861
<a class="indexterm" name="id2587511"></a><pre class="programlisting">gboolean    rb_shell_player_handle_key      (RBShellPlayer *player,
891
862
                                             guint keyval);</pre>
892
863
<p>
893
864