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

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-shell-player.xml

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
<refentry id="rhythmbox-rb-shell-player">
 
5
<refmeta>
 
6
<refentrytitle>rb-shell-player</refentrytitle>
 
7
<manvolnum>3</manvolnum>
 
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
 
9
</refmeta>
 
10
 
 
11
<refnamediv>
 
12
<refname>rb-shell-player</refname><refpurpose></refpurpose>
 
13
</refnamediv>
 
14
 
 
15
<refsynopsisdiv><title>Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
 
 
20
 
 
21
enum        <link linkend="RBShellPlayerError">RBShellPlayerError</link>;
 
22
#define     <link linkend="RB-SHELL-PLAYER-ERROR:CAPS">RB_SHELL_PLAYER_ERROR</link>
 
23
<link linkend="GQuark">GQuark</link>      <link linkend="rb-shell-player-error-quark">rb_shell_player_error_quark</link>     (void);
 
24
typedef     <link linkend="RBShellPlayerPrivate">RBShellPlayerPrivate</link>;
 
25
<link linkend="RBShellPlayer">RBShellPlayer</link>* <link linkend="rb-shell-player-new">rb_shell_player_new</link>          (<link linkend="RhythmDB">RhythmDB</link> *db,
 
26
                                             <link linkend="GtkUIManager">GtkUIManager</link> *mgr,
 
27
                                             <link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup);
 
28
<link linkend="void">void</link>        <link linkend="rb-shell-player-set-selected-source">rb_shell_player_set_selected_source</link>
 
29
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
 
30
                                             <link linkend="RBSource">RBSource</link> *player);
 
31
<link linkend="void">void</link>        <link linkend="rb-shell-player-set-playing-source">rb_shell_player_set_playing_source</link>
 
32
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
33
                                             <link linkend="RBSource">RBSource</link> *source);
 
34
<link linkend="RBSource">RBSource</link>*   <link linkend="rb-shell-player-get-playing-source">rb_shell_player_get_playing_source</link>
 
35
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player);
 
36
<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);
 
37
<link linkend="void">void</link>        <link linkend="rb-shell-player-play-entry">rb_shell_player_play_entry</link>      (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
38
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);
 
39
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-playpause">rb_shell_player_playpause</link>       (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
40
                                             <link linkend="gboolean">gboolean</link> ignore_stop,
 
41
                                             <link linkend="GError">GError</link> **error);
 
42
<link linkend="void">void</link>        <link linkend="rb-shell-player-stop">rb_shell_player_stop</link>            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
 
43
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-do-previous">rb_shell_player_do_previous</link>     (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
44
                                             <link linkend="GError">GError</link> **error);
 
45
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-do-next">rb_shell_player_do_next</link>         (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
46
                                             <link linkend="GError">GError</link> **error);
 
47
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-get-playing-time">rb_shell_player_get_playing_time</link>
 
48
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
49
                                             <link linkend="guint">guint</link> *time,
 
50
                                             <link linkend="GError">GError</link> **error);
 
51
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-set-playing-time">rb_shell_player_set_playing_time</link>
 
52
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
53
                                             <link linkend="guint">guint</link> time,
 
54
                                             <link linkend="GError">GError</link> **error);
 
55
<link linkend="void">void</link>        <link linkend="rb-shell-player-seek">rb_shell_player_seek</link>            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
56
                                             <link linkend="long-offset">long offset</link>);
 
57
<link linkend="long">long</link>        <link linkend="rb-shell-player-get-playing-song-duration">rb_shell_player_get_playing_song_duration</link>
 
58
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
 
59
<link linkend="RBPlayer">RBPlayer</link>*   <link linkend="rb-shell-player-get-mm-player">rb_shell_player_get_mm_player</link>   (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player);
 
60
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-get-playing">rb_shell_player_get_playing</link>     (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
 
61
                                             <link linkend="gboolean">gboolean</link> *playing,
 
62
                                             <link linkend="GError">GError</link> **error);
 
63
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-get-playing-path">rb_shell_player_get_playing_path</link>
 
64
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
 
65
                                             const <link linkend="gchar">gchar</link> **path,
 
66
                                             <link linkend="GError">GError</link> **error);
 
67
<link linkend="void">void</link>        <link linkend="rb-shell-player-sync-buttons">rb_shell_player_sync_buttons</link>    (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
 
68
<link linkend="void">void</link>        <link linkend="rb-shell-player-set-playback-state">rb_shell_player_set_playback_state</link>
 
69
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
70
                                             <link linkend="gboolean">gboolean</link> shuffle,
 
71
                                             <link linkend="gboolean">gboolean</link> repeat);
 
72
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-get-playback-state">rb_shell_player_get_playback_state</link>
 
73
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
74
                                             <link linkend="gboolean">gboolean</link> *shuffle,
 
75
                                             <link linkend="gboolean">gboolean</link> *repeat);
 
76
<link linkend="RhythmDBEntry">RhythmDBEntry</link>* <link linkend="rb-shell-player-get-playing-entry">rb_shell_player_get_playing_entry</link>
 
77
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
 
78
<link linkend="void">void</link>        <link linkend="rb-shell-player-toggle-mute">rb_shell_player_toggle_mute</link>     (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);
 
79
<link linkend="gboolean">gboolean</link>    <link linkend="rb-shell-player-handle-key">rb_shell_player_handle_key</link>      (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
80
                                             <link linkend="guint">guint</link> keyval);
 
81
 
 
82
</synopsis>
 
83
</refsynopsisdiv>
 
84
 
 
85
 
 
86
 
 
87
 
 
88
 
 
89
 
 
90
 
 
91
 
 
92
 
 
93
<refsect1>
 
94
<title>Description</title>
 
95
<para>
 
96
 
 
97
</para>
 
98
</refsect1>
 
99
 
 
100
<refsect1>
 
101
<title>Details</title>
 
102
<refsect2>
 
103
<title><anchor id="RBShellPlayerError"/>enum RBShellPlayerError</title>
 
104
<indexterm><primary>RBShellPlayerError</primary></indexterm><programlisting>typedef enum
 
105
{
 
106
        RB_SHELL_PLAYER_ERROR_PLAYLIST_PARSE_ERROR,
 
107
        RB_SHELL_PLAYER_ERROR_END_OF_PLAYLIST,
 
108
        RB_SHELL_PLAYER_ERROR_NOT_PLAYING,
 
109
        RB_SHELL_PLAYER_ERROR_NOT_SEEKABLE,
 
110
} RBShellPlayerError;
 
111
</programlisting>
 
112
<para>
 
113
 
 
114
</para></refsect2>
 
115
<refsect2>
 
116
<title><anchor id="RB-SHELL-PLAYER-ERROR:CAPS"/>RB_SHELL_PLAYER_ERROR</title>
 
117
<indexterm><primary>RB_SHELL_PLAYER_ERROR</primary></indexterm><programlisting>#define RB_SHELL_PLAYER_ERROR rb_shell_player_error_quark ()
 
118
</programlisting>
 
119
<para>
 
120
 
 
121
</para></refsect2>
 
122
<refsect2>
 
123
<title><anchor id="rb-shell-player-error-quark"/>rb_shell_player_error_quark ()</title>
 
124
<indexterm><primary>rb_shell_player_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>      rb_shell_player_error_quark     (void);</programlisting>
 
125
<para>
 
126
 
 
127
</para><variablelist role="params">
 
128
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
129
 
 
130
 
 
131
</simpara></listitem></varlistentry>
 
132
</variablelist></refsect2>
 
133
<refsect2>
 
134
<title><anchor id="RBShellPlayerPrivate"/>RBShellPlayerPrivate</title>
 
135
<indexterm><primary>RBShellPlayerPrivate</primary></indexterm><programlisting>typedef struct RBShellPlayerPrivate RBShellPlayerPrivate;
 
136
</programlisting>
 
137
<para>
 
138
 
 
139
</para></refsect2>
 
140
<refsect2>
 
141
<title><anchor id="rb-shell-player-new"/>rb_shell_player_new ()</title>
 
142
<indexterm><primary>rb_shell_player_new</primary></indexterm><programlisting><link linkend="RBShellPlayer">RBShellPlayer</link>* rb_shell_player_new          (<link linkend="RhythmDB">RhythmDB</link> *db,
 
143
                                             <link linkend="GtkUIManager">GtkUIManager</link> *mgr,
 
144
                                             <link linkend="GtkActionGroup">GtkActionGroup</link> *actiongroup);</programlisting>
 
145
<para>
 
146
 
 
147
</para><variablelist role="params">
 
148
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
149
<listitem><simpara>
 
150
</simpara></listitem></varlistentry>
 
151
<varlistentry><term><parameter>mgr</parameter>&nbsp;:</term>
 
152
<listitem><simpara>
 
153
</simpara></listitem></varlistentry>
 
154
<varlistentry><term><parameter>actiongroup</parameter>&nbsp;:</term>
 
155
<listitem><simpara>
 
156
</simpara></listitem></varlistentry>
 
157
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
158
 
 
159
 
 
160
</simpara></listitem></varlistentry>
 
161
</variablelist></refsect2>
 
162
<refsect2>
 
163
<title><anchor id="rb-shell-player-set-selected-source"/>rb_shell_player_set_selected_source ()</title>
 
164
<indexterm><primary>rb_shell_player_set_selected_source</primary></indexterm><programlisting><link linkend="void">void</link>        rb_shell_player_set_selected_source
 
165
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
 
166
                                             <link linkend="RBSource">RBSource</link> *player);</programlisting>
 
167
<para>
 
168
 
 
169
</para><variablelist role="params">
 
170
<varlistentry><term><parameter>shell_player</parameter>&nbsp;:</term>
 
171
<listitem><simpara>
 
172
</simpara></listitem></varlistentry>
 
173
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
174
<listitem><simpara>
 
175
 
 
176
 
 
177
</simpara></listitem></varlistentry>
 
178
</variablelist></refsect2>
 
179
<refsect2>
 
180
<title><anchor id="rb-shell-player-set-playing-source"/>rb_shell_player_set_playing_source ()</title>
 
181
<indexterm><primary>rb_shell_player_set_playing_source</primary></indexterm><programlisting><link linkend="void">void</link>        rb_shell_player_set_playing_source
 
182
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
183
                                             <link linkend="RBSource">RBSource</link> *source);</programlisting>
 
184
<para>
 
185
 
 
186
</para><variablelist role="params">
 
187
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
188
<listitem><simpara>
 
189
</simpara></listitem></varlistentry>
 
190
<varlistentry><term><parameter>source</parameter>&nbsp;:</term>
 
191
<listitem><simpara>
 
192
 
 
193
 
 
194
</simpara></listitem></varlistentry>
 
195
</variablelist></refsect2>
 
196
<refsect2>
 
197
<title><anchor id="rb-shell-player-get-playing-source"/>rb_shell_player_get_playing_source ()</title>
 
198
<indexterm><primary>rb_shell_player_get_playing_source</primary></indexterm><programlisting><link linkend="RBSource">RBSource</link>*   rb_shell_player_get_playing_source
 
199
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player);</programlisting>
 
200
<para>
 
201
 
 
202
</para><variablelist role="params">
 
203
<varlistentry><term><parameter>shell_player</parameter>&nbsp;:</term>
 
204
<listitem><simpara>
 
205
</simpara></listitem></varlistentry>
 
206
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
207
 
 
208
 
 
209
</simpara></listitem></varlistentry>
 
210
</variablelist></refsect2>
 
211
<refsect2>
 
212
<title><anchor id="rb-shell-player-jump-to-current"/>rb_shell_player_jump_to_current ()</title>
 
213
<indexterm><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>
 
214
<para>
 
215
 
 
216
</para><variablelist role="params">
 
217
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
218
<listitem><simpara>
 
219
 
 
220
 
 
221
</simpara></listitem></varlistentry>
 
222
</variablelist></refsect2>
 
223
<refsect2>
 
224
<title><anchor id="rb-shell-player-play-entry"/>rb_shell_player_play_entry ()</title>
 
225
<indexterm><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,
 
226
                                             <link linkend="RhythmDBEntry">RhythmDBEntry</link> *entry);</programlisting>
 
227
<para>
 
228
 
 
229
</para><variablelist role="params">
 
230
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
231
<listitem><simpara>
 
232
</simpara></listitem></varlistentry>
 
233
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
234
<listitem><simpara>
 
235
 
 
236
 
 
237
</simpara></listitem></varlistentry>
 
238
</variablelist></refsect2>
 
239
<refsect2>
 
240
<title><anchor id="rb-shell-player-playpause"/>rb_shell_player_playpause ()</title>
 
241
<indexterm><primary>rb_shell_player_playpause</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_shell_player_playpause       (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
242
                                             <link linkend="gboolean">gboolean</link> ignore_stop,
 
243
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
244
<para>
 
245
 
 
246
</para><variablelist role="params">
 
247
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
248
<listitem><simpara>
 
249
</simpara></listitem></varlistentry>
 
250
<varlistentry><term><parameter>ignore_stop</parameter>&nbsp;:</term>
 
251
<listitem><simpara>
 
252
</simpara></listitem></varlistentry>
 
253
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
254
<listitem><simpara>
 
255
</simpara></listitem></varlistentry>
 
256
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
257
 
 
258
 
 
259
</simpara></listitem></varlistentry>
 
260
</variablelist></refsect2>
 
261
<refsect2>
 
262
<title><anchor id="rb-shell-player-stop"/>rb_shell_player_stop ()</title>
 
263
<indexterm><primary>rb_shell_player_stop</primary></indexterm><programlisting><link linkend="void">void</link>        rb_shell_player_stop            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
 
264
<para>
 
265
 
 
266
</para><variablelist role="params">
 
267
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
268
<listitem><simpara>
 
269
 
 
270
 
 
271
</simpara></listitem></varlistentry>
 
272
</variablelist></refsect2>
 
273
<refsect2>
 
274
<title><anchor id="rb-shell-player-do-previous"/>rb_shell_player_do_previous ()</title>
 
275
<indexterm><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,
 
276
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
277
<para>
 
278
 
 
279
</para><variablelist role="params">
 
280
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
281
<listitem><simpara>
 
282
</simpara></listitem></varlistentry>
 
283
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
284
<listitem><simpara>
 
285
</simpara></listitem></varlistentry>
 
286
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
287
 
 
288
 
 
289
</simpara></listitem></varlistentry>
 
290
</variablelist></refsect2>
 
291
<refsect2>
 
292
<title><anchor id="rb-shell-player-do-next"/>rb_shell_player_do_next ()</title>
 
293
<indexterm><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,
 
294
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
295
<para>
 
296
 
 
297
</para><variablelist role="params">
 
298
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
299
<listitem><simpara>
 
300
</simpara></listitem></varlistentry>
 
301
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
302
<listitem><simpara>
 
303
</simpara></listitem></varlistentry>
 
304
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
305
 
 
306
 
 
307
</simpara></listitem></varlistentry>
 
308
</variablelist></refsect2>
 
309
<refsect2>
 
310
<title><anchor id="rb-shell-player-get-playing-time"/>rb_shell_player_get_playing_time ()</title>
 
311
<indexterm><primary>rb_shell_player_get_playing_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_shell_player_get_playing_time
 
312
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
313
                                             <link linkend="guint">guint</link> *time,
 
314
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
315
<para>
 
316
 
 
317
</para><variablelist role="params">
 
318
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
319
<listitem><simpara>
 
320
</simpara></listitem></varlistentry>
 
321
<varlistentry><term><parameter>time</parameter>&nbsp;:</term>
 
322
<listitem><simpara>
 
323
</simpara></listitem></varlistentry>
 
324
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
325
<listitem><simpara>
 
326
</simpara></listitem></varlistentry>
 
327
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
328
 
 
329
 
 
330
</simpara></listitem></varlistentry>
 
331
</variablelist></refsect2>
 
332
<refsect2>
 
333
<title><anchor id="rb-shell-player-set-playing-time"/>rb_shell_player_set_playing_time ()</title>
 
334
<indexterm><primary>rb_shell_player_set_playing_time</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_shell_player_set_playing_time
 
335
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
336
                                             <link linkend="guint">guint</link> time,
 
337
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
338
<para>
 
339
 
 
340
</para><variablelist role="params">
 
341
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
342
<listitem><simpara>
 
343
</simpara></listitem></varlistentry>
 
344
<varlistentry><term><parameter>time</parameter>&nbsp;:</term>
 
345
<listitem><simpara>
 
346
</simpara></listitem></varlistentry>
 
347
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
348
<listitem><simpara>
 
349
</simpara></listitem></varlistentry>
 
350
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
351
</simpara></listitem></varlistentry>
 
352
</variablelist></refsect2>
 
353
<refsect2>
 
354
<title><anchor id="rb-shell-player-seek"/>rb_shell_player_seek ()</title>
 
355
<indexterm><primary>rb_shell_player_seek</primary></indexterm><programlisting><link linkend="void">void</link>        rb_shell_player_seek            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
356
                                             <link linkend="long-offset">long offset</link>);</programlisting>
 
357
<para>
 
358
 
 
359
</para><variablelist role="params">
 
360
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
361
<listitem><simpara>
 
362
</simpara></listitem></varlistentry>
 
363
<varlistentry><term><parameter>Param2</parameter>&nbsp;:</term>
 
364
<listitem><simpara>
 
365
 
 
366
 
 
367
</simpara></listitem></varlistentry>
 
368
</variablelist></refsect2>
 
369
<refsect2>
 
370
<title><anchor id="rb-shell-player-get-playing-song-duration"/>rb_shell_player_get_playing_song_duration ()</title>
 
371
<indexterm><primary>rb_shell_player_get_playing_song_duration</primary></indexterm><programlisting><link linkend="long">long</link>        rb_shell_player_get_playing_song_duration
 
372
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
 
373
<para>
 
374
 
 
375
</para><variablelist role="params">
 
376
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
377
<listitem><simpara>
 
378
</simpara></listitem></varlistentry>
 
379
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
380
 
 
381
 
 
382
</simpara></listitem></varlistentry>
 
383
</variablelist></refsect2>
 
384
<refsect2>
 
385
<title><anchor id="rb-shell-player-get-mm-player"/>rb_shell_player_get_mm_player ()</title>
 
386
<indexterm><primary>rb_shell_player_get_mm_player</primary></indexterm><programlisting><link linkend="RBPlayer">RBPlayer</link>*   rb_shell_player_get_mm_player   (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player);</programlisting>
 
387
<para>
 
388
 
 
389
</para><variablelist role="params">
 
390
<varlistentry><term><parameter>shell_player</parameter>&nbsp;:</term>
 
391
<listitem><simpara>
 
392
</simpara></listitem></varlistentry>
 
393
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
394
 
 
395
 
 
396
</simpara></listitem></varlistentry>
 
397
</variablelist></refsect2>
 
398
<refsect2>
 
399
<title><anchor id="rb-shell-player-get-playing"/>rb_shell_player_get_playing ()</title>
 
400
<indexterm><primary>rb_shell_player_get_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_shell_player_get_playing     (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
 
401
                                             <link linkend="gboolean">gboolean</link> *playing,
 
402
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
403
<para>
 
404
 
 
405
</para><variablelist role="params">
 
406
<varlistentry><term><parameter>shell_player</parameter>&nbsp;:</term>
 
407
<listitem><simpara>
 
408
</simpara></listitem></varlistentry>
 
409
<varlistentry><term><parameter>playing</parameter>&nbsp;:</term>
 
410
<listitem><simpara>
 
411
</simpara></listitem></varlistentry>
 
412
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
413
<listitem><simpara>
 
414
</simpara></listitem></varlistentry>
 
415
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
416
 
 
417
 
 
418
</simpara></listitem></varlistentry>
 
419
</variablelist></refsect2>
 
420
<refsect2>
 
421
<title><anchor id="rb-shell-player-get-playing-path"/>rb_shell_player_get_playing_path ()</title>
 
422
<indexterm><primary>rb_shell_player_get_playing_path</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_shell_player_get_playing_path
 
423
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *shell_player,
 
424
                                             const <link linkend="gchar">gchar</link> **path,
 
425
                                             <link linkend="GError">GError</link> **error);</programlisting>
 
426
<para>
 
427
 
 
428
</para><variablelist role="params">
 
429
<varlistentry><term><parameter>shell_player</parameter>&nbsp;:</term>
 
430
<listitem><simpara>
 
431
</simpara></listitem></varlistentry>
 
432
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
433
<listitem><simpara>
 
434
</simpara></listitem></varlistentry>
 
435
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
 
436
<listitem><simpara>
 
437
</simpara></listitem></varlistentry>
 
438
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
439
 
 
440
 
 
441
</simpara></listitem></varlistentry>
 
442
</variablelist></refsect2>
 
443
<refsect2>
 
444
<title><anchor id="rb-shell-player-sync-buttons"/>rb_shell_player_sync_buttons ()</title>
 
445
<indexterm><primary>rb_shell_player_sync_buttons</primary></indexterm><programlisting><link linkend="void">void</link>        rb_shell_player_sync_buttons    (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
 
446
<para>
 
447
 
 
448
</para><variablelist role="params">
 
449
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
450
<listitem><simpara>
 
451
 
 
452
 
 
453
</simpara></listitem></varlistentry>
 
454
</variablelist></refsect2>
 
455
<refsect2>
 
456
<title><anchor id="rb-shell-player-set-playback-state"/>rb_shell_player_set_playback_state ()</title>
 
457
<indexterm><primary>rb_shell_player_set_playback_state</primary></indexterm><programlisting><link linkend="void">void</link>        rb_shell_player_set_playback_state
 
458
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
459
                                             <link linkend="gboolean">gboolean</link> shuffle,
 
460
                                             <link linkend="gboolean">gboolean</link> repeat);</programlisting>
 
461
<para>
 
462
 
 
463
</para><variablelist role="params">
 
464
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
465
<listitem><simpara>
 
466
</simpara></listitem></varlistentry>
 
467
<varlistentry><term><parameter>shuffle</parameter>&nbsp;:</term>
 
468
<listitem><simpara>
 
469
</simpara></listitem></varlistentry>
 
470
<varlistentry><term><parameter>repeat</parameter>&nbsp;:</term>
 
471
<listitem><simpara>
 
472
 
 
473
 
 
474
</simpara></listitem></varlistentry>
 
475
</variablelist></refsect2>
 
476
<refsect2>
 
477
<title><anchor id="rb-shell-player-get-playback-state"/>rb_shell_player_get_playback_state ()</title>
 
478
<indexterm><primary>rb_shell_player_get_playback_state</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_shell_player_get_playback_state
 
479
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
480
                                             <link linkend="gboolean">gboolean</link> *shuffle,
 
481
                                             <link linkend="gboolean">gboolean</link> *repeat);</programlisting>
 
482
<para>
 
483
 
 
484
</para><variablelist role="params">
 
485
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
486
<listitem><simpara>
 
487
</simpara></listitem></varlistentry>
 
488
<varlistentry><term><parameter>shuffle</parameter>&nbsp;:</term>
 
489
<listitem><simpara>
 
490
</simpara></listitem></varlistentry>
 
491
<varlistentry><term><parameter>repeat</parameter>&nbsp;:</term>
 
492
<listitem><simpara>
 
493
</simpara></listitem></varlistentry>
 
494
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
495
 
 
496
 
 
497
</simpara></listitem></varlistentry>
 
498
</variablelist></refsect2>
 
499
<refsect2>
 
500
<title><anchor id="rb-shell-player-get-playing-entry"/>rb_shell_player_get_playing_entry ()</title>
 
501
<indexterm><primary>rb_shell_player_get_playing_entry</primary></indexterm><programlisting><link linkend="RhythmDBEntry">RhythmDBEntry</link>* rb_shell_player_get_playing_entry
 
502
                                            (<link linkend="RBShellPlayer">RBShellPlayer</link> *player);</programlisting>
 
503
<para>
 
504
 
 
505
</para><variablelist role="params">
 
506
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
507
<listitem><simpara>
 
508
</simpara></listitem></varlistentry>
 
509
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
510
 
 
511
 
 
512
</simpara></listitem></varlistentry>
 
513
</variablelist></refsect2>
 
514
<refsect2>
 
515
<title><anchor id="rb-shell-player-toggle-mute"/>rb_shell_player_toggle_mute ()</title>
 
516
<indexterm><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>
 
517
<para>
 
518
 
 
519
</para><variablelist role="params">
 
520
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
521
<listitem><simpara>
 
522
 
 
523
 
 
524
</simpara></listitem></varlistentry>
 
525
</variablelist></refsect2>
 
526
<refsect2>
 
527
<title><anchor id="rb-shell-player-handle-key"/>rb_shell_player_handle_key ()</title>
 
528
<indexterm><primary>rb_shell_player_handle_key</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    rb_shell_player_handle_key      (<link linkend="RBShellPlayer">RBShellPlayer</link> *player,
 
529
                                             <link linkend="guint">guint</link> keyval);</programlisting>
 
530
<para>
 
531
 
 
532
</para><variablelist role="params">
 
533
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
 
534
<listitem><simpara>
 
535
</simpara></listitem></varlistentry>
 
536
<varlistentry><term><parameter>keyval</parameter>&nbsp;:</term>
 
537
<listitem><simpara>
 
538
</simpara></listitem></varlistentry>
 
539
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
540
 
 
541
 
 
542
</simpara></listitem></varlistentry>
 
543
</variablelist></refsect2>
 
544
 
 
545
</refsect1>
 
546
 
 
547
 
 
548
 
 
549
 
 
550
</refentry>