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">
6
<refentrytitle>rb-shell</refentrytitle>
7
<manvolnum>3</manvolnum>
8
<refmiscinfo>RHYTHMBOX Library</refmiscinfo>
12
<refname>rb-shell</refname><refpurpose></refpurpose>
15
<refsynopsisdiv><title>Synopsis</title>
21
enum <link linkend="RBShellError">RBShellError</link>;
22
#define <link linkend="RB-SHELL-ERROR:CAPS">RB_SHELL_ERROR</link>
23
<link linkend="GQuark">GQuark</link> <link linkend="rb-shell-error-quark">rb_shell_error_quark</link> (void);
24
typedef <link linkend="RBShellPrivate">RBShellPrivate</link>;
25
<link linkend="RBShell">RBShell</link>* <link linkend="rb-shell-new">rb_shell_new</link> (<link linkend="int">int</link> argc,
26
<link linkend="char">char</link> **argv,
27
<link linkend="gboolean">gboolean</link> no_registration,
28
<link linkend="gboolean">gboolean</link> no_update,
29
<link linkend="gboolean">gboolean</link> dry_run,
30
<link linkend="char">char</link> *rhythmdb);
31
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-present">rb_shell_present</link> (<link linkend="RBShell">RBShell</link> *shell,
32
<link linkend="guint32">guint32</link> timestamp,
33
<link linkend="GError">GError</link> **error);
34
<link linkend="gint">gint</link> <link linkend="rb-shell-guess-type-for-uri">rb_shell_guess_type_for_uri</link> (<link linkend="RBShell">RBShell</link> *shell,
35
const <link linkend="char">char</link> *uri);
36
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-add-uri">rb_shell_add_uri</link> (<link linkend="RBShell">RBShell</link> *shell,
37
<link linkend="gint">gint</link> entry_type,
38
const <link linkend="char">char</link> *uri,
39
const <link linkend="char">char</link> *title,
40
const <link linkend="char">char</link> *genre,
41
<link linkend="GError">GError</link> **error);
42
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-load-uri">rb_shell_load_uri</link> (<link linkend="RBShell">RBShell</link> *shell,
43
const <link linkend="char">char</link> *uri,
44
<link linkend="gboolean">gboolean</link> play,
45
<link linkend="GError">GError</link> **error);
46
<link linkend="GObject">GObject</link>* <link linkend="rb-shell-get-player">rb_shell_get_player</link> (<link linkend="RBShell">RBShell</link> *shell);
47
const <link linkend="char">char</link>* <link linkend="rb-shell-get-player-path">rb_shell_get_player_path</link> (<link linkend="RBShell">RBShell</link> *shell);
48
<link linkend="void">void</link> <link linkend="rb-shell-toggle-visibility">rb_shell_toggle_visibility</link> (<link linkend="RBShell">RBShell</link> *shell);
49
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-get-song-properties">rb_shell_get_song_properties</link> (<link linkend="RBShell">RBShell</link> *shell,
50
const <link linkend="char">char</link> *uri,
51
<link linkend="GHashTable">GHashTable</link> **properties,
52
<link linkend="GError">GError</link> **error);
53
<link linkend="gboolean">gboolean</link> <link linkend="rb-shell-set-song-property">rb_shell_set_song_property</link> (<link linkend="RBShell">RBShell</link> *shell,
54
const <link linkend="char">char</link> *uri,
55
const <link linkend="char">char</link> *propname,
56
const <link linkend="GValue">GValue</link> *value,
57
<link linkend="GError">GError</link> **error);
58
<link linkend="void">void</link> <link linkend="rb-shell-hidden-notify">rb_shell_hidden_notify</link> (<link linkend="RBShell">RBShell</link> *shell,
59
<link linkend="guint">guint</link> timeout,
60
const <link linkend="char">char</link> *primary,
61
<link linkend="GtkWidget">GtkWidget</link> *icon,
62
const <link linkend="char">char</link> *secondary);
63
<link linkend="void">void</link> <link linkend="rb-shell-construct">rb_shell_construct</link> (<link linkend="RBShell">RBShell</link> *shell);
64
<link linkend="void">void</link> <link linkend="rb-shell-register-entry-type-for-source">rb_shell_register_entry_type_for_source</link>
65
(<link linkend="RBShell">RBShell</link> *shell,
66
<link linkend="RBSource">RBSource</link> *source,
67
<link linkend="RhythmDBEntryType">RhythmDBEntryType</link> type);
68
<link linkend="void">void</link> <link linkend="rb-shell-append-source">rb_shell_append_source</link> (<link linkend="RBShell">RBShell</link> *shell,
69
<link linkend="RBSource">RBSource</link> *source,
70
<link linkend="RBSource">RBSource</link> *parent);
84
<title>Description</title>
91
<title>Details</title>
93
<title><anchor id="RBShellError"/>enum RBShellError</title>
94
<indexterm><primary>RBShellError</primary></indexterm><programlisting>typedef enum
96
RB_SHELL_ERROR_NO_SUCH_URI,
97
RB_SHELL_ERROR_NO_SUCH_PROPERTY,
98
RB_SHELL_ERROR_IMMUTABLE_PROPERTY,
99
RB_SHELL_ERROR_INVALID_PROPERTY_TYPE
106
<title><anchor id="RB-SHELL-ERROR:CAPS"/>RB_SHELL_ERROR</title>
107
<indexterm><primary>RB_SHELL_ERROR</primary></indexterm><programlisting>#define RB_SHELL_ERROR rb_shell_error_quark ()
113
<title><anchor id="rb-shell-error-quark"/>rb_shell_error_quark ()</title>
114
<indexterm><primary>rb_shell_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link> rb_shell_error_quark (void);</programlisting>
117
</para><variablelist role="params">
118
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
121
</simpara></listitem></varlistentry>
122
</variablelist></refsect2>
124
<title><anchor id="RBShellPrivate"/>RBShellPrivate</title>
125
<indexterm><primary>RBShellPrivate</primary></indexterm><programlisting>typedef struct RBShellPrivate RBShellPrivate;
131
<title><anchor id="rb-shell-new"/>rb_shell_new ()</title>
132
<indexterm><primary>rb_shell_new</primary></indexterm><programlisting><link linkend="RBShell">RBShell</link>* rb_shell_new (<link linkend="int">int</link> argc,
133
<link linkend="char">char</link> **argv,
134
<link linkend="gboolean">gboolean</link> no_registration,
135
<link linkend="gboolean">gboolean</link> no_update,
136
<link linkend="gboolean">gboolean</link> dry_run,
137
<link linkend="char">char</link> *rhythmdb);</programlisting>
140
</para><variablelist role="params">
141
<varlistentry><term><parameter>argc</parameter> :</term>
143
</simpara></listitem></varlistentry>
144
<varlistentry><term><parameter>argv</parameter> :</term>
146
</simpara></listitem></varlistentry>
147
<varlistentry><term><parameter>no_registration</parameter> :</term>
149
</simpara></listitem></varlistentry>
150
<varlistentry><term><parameter>no_update</parameter> :</term>
152
</simpara></listitem></varlistentry>
153
<varlistentry><term><parameter>dry_run</parameter> :</term>
155
</simpara></listitem></varlistentry>
156
<varlistentry><term><parameter>rhythmdb</parameter> :</term>
158
</simpara></listitem></varlistentry>
159
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
162
</simpara></listitem></varlistentry>
163
</variablelist></refsect2>
165
<title><anchor id="rb-shell-present"/>rb_shell_present ()</title>
166
<indexterm><primary>rb_shell_present</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_present (<link linkend="RBShell">RBShell</link> *shell,
167
<link linkend="guint32">guint32</link> timestamp,
168
<link linkend="GError">GError</link> **error);</programlisting>
171
</para><variablelist role="params">
172
<varlistentry><term><parameter>shell</parameter> :</term>
174
</simpara></listitem></varlistentry>
175
<varlistentry><term><parameter>timestamp</parameter> :</term>
177
</simpara></listitem></varlistentry>
178
<varlistentry><term><parameter>error</parameter> :</term>
180
</simpara></listitem></varlistentry>
181
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
184
</simpara></listitem></varlistentry>
185
</variablelist></refsect2>
187
<title><anchor id="rb-shell-guess-type-for-uri"/>rb_shell_guess_type_for_uri ()</title>
188
<indexterm><primary>rb_shell_guess_type_for_uri</primary></indexterm><programlisting><link linkend="gint">gint</link> rb_shell_guess_type_for_uri (<link linkend="RBShell">RBShell</link> *shell,
189
const <link linkend="char">char</link> *uri);</programlisting>
192
</para><variablelist role="params">
193
<varlistentry><term><parameter>shell</parameter> :</term>
195
</simpara></listitem></varlistentry>
196
<varlistentry><term><parameter>uri</parameter> :</term>
198
</simpara></listitem></varlistentry>
199
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
202
</simpara></listitem></varlistentry>
203
</variablelist></refsect2>
205
<title><anchor id="rb-shell-add-uri"/>rb_shell_add_uri ()</title>
206
<indexterm><primary>rb_shell_add_uri</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_add_uri (<link linkend="RBShell">RBShell</link> *shell,
207
<link linkend="gint">gint</link> entry_type,
208
const <link linkend="char">char</link> *uri,
209
const <link linkend="char">char</link> *title,
210
const <link linkend="char">char</link> *genre,
211
<link linkend="GError">GError</link> **error);</programlisting>
214
</para><variablelist role="params">
215
<varlistentry><term><parameter>shell</parameter> :</term>
217
</simpara></listitem></varlistentry>
218
<varlistentry><term><parameter>entry_type</parameter> :</term>
220
</simpara></listitem></varlistentry>
221
<varlistentry><term><parameter>uri</parameter> :</term>
223
</simpara></listitem></varlistentry>
224
<varlistentry><term><parameter>title</parameter> :</term>
226
</simpara></listitem></varlistentry>
227
<varlistentry><term><parameter>genre</parameter> :</term>
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><parameter>error</parameter> :</term>
232
</simpara></listitem></varlistentry>
233
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
236
</simpara></listitem></varlistentry>
237
</variablelist></refsect2>
239
<title><anchor id="rb-shell-load-uri"/>rb_shell_load_uri ()</title>
240
<indexterm><primary>rb_shell_load_uri</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_load_uri (<link linkend="RBShell">RBShell</link> *shell,
241
const <link linkend="char">char</link> *uri,
242
<link linkend="gboolean">gboolean</link> play,
243
<link linkend="GError">GError</link> **error);</programlisting>
246
</para><variablelist role="params">
247
<varlistentry><term><parameter>shell</parameter> :</term>
249
</simpara></listitem></varlistentry>
250
<varlistentry><term><parameter>uri</parameter> :</term>
252
</simpara></listitem></varlistentry>
253
<varlistentry><term><parameter>play</parameter> :</term>
255
</simpara></listitem></varlistentry>
256
<varlistentry><term><parameter>error</parameter> :</term>
258
</simpara></listitem></varlistentry>
259
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
262
</simpara></listitem></varlistentry>
263
</variablelist></refsect2>
265
<title><anchor id="rb-shell-get-player"/>rb_shell_get_player ()</title>
266
<indexterm><primary>rb_shell_get_player</primary></indexterm><programlisting><link linkend="GObject">GObject</link>* rb_shell_get_player (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
269
</para><variablelist role="params">
270
<varlistentry><term><parameter>shell</parameter> :</term>
272
</simpara></listitem></varlistentry>
273
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
276
</simpara></listitem></varlistentry>
277
</variablelist></refsect2>
279
<title><anchor id="rb-shell-get-player-path"/>rb_shell_get_player_path ()</title>
280
<indexterm><primary>rb_shell_get_player_path</primary></indexterm><programlisting>const <link linkend="char">char</link>* rb_shell_get_player_path (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
283
</para><variablelist role="params">
284
<varlistentry><term><parameter>shell</parameter> :</term>
286
</simpara></listitem></varlistentry>
287
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
290
</simpara></listitem></varlistentry>
291
</variablelist></refsect2>
293
<title><anchor id="rb-shell-toggle-visibility"/>rb_shell_toggle_visibility ()</title>
294
<indexterm><primary>rb_shell_toggle_visibility</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_toggle_visibility (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
297
</para><variablelist role="params">
298
<varlistentry><term><parameter>shell</parameter> :</term>
302
</simpara></listitem></varlistentry>
303
</variablelist></refsect2>
305
<title><anchor id="rb-shell-get-song-properties"/>rb_shell_get_song_properties ()</title>
306
<indexterm><primary>rb_shell_get_song_properties</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_get_song_properties (<link linkend="RBShell">RBShell</link> *shell,
307
const <link linkend="char">char</link> *uri,
308
<link linkend="GHashTable">GHashTable</link> **properties,
309
<link linkend="GError">GError</link> **error);</programlisting>
312
</para><variablelist role="params">
313
<varlistentry><term><parameter>shell</parameter> :</term>
315
</simpara></listitem></varlistentry>
316
<varlistentry><term><parameter>uri</parameter> :</term>
318
</simpara></listitem></varlistentry>
319
<varlistentry><term><parameter>properties</parameter> :</term>
321
</simpara></listitem></varlistentry>
322
<varlistentry><term><parameter>error</parameter> :</term>
324
</simpara></listitem></varlistentry>
325
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
328
</simpara></listitem></varlistentry>
329
</variablelist></refsect2>
331
<title><anchor id="rb-shell-set-song-property"/>rb_shell_set_song_property ()</title>
332
<indexterm><primary>rb_shell_set_song_property</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> rb_shell_set_song_property (<link linkend="RBShell">RBShell</link> *shell,
333
const <link linkend="char">char</link> *uri,
334
const <link linkend="char">char</link> *propname,
335
const <link linkend="GValue">GValue</link> *value,
336
<link linkend="GError">GError</link> **error);</programlisting>
339
</para><variablelist role="params">
340
<varlistentry><term><parameter>shell</parameter> :</term>
342
</simpara></listitem></varlistentry>
343
<varlistentry><term><parameter>uri</parameter> :</term>
345
</simpara></listitem></varlistentry>
346
<varlistentry><term><parameter>propname</parameter> :</term>
348
</simpara></listitem></varlistentry>
349
<varlistentry><term><parameter>value</parameter> :</term>
351
</simpara></listitem></varlistentry>
352
<varlistentry><term><parameter>error</parameter> :</term>
354
</simpara></listitem></varlistentry>
355
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
358
</simpara></listitem></varlistentry>
359
</variablelist></refsect2>
361
<title><anchor id="rb-shell-hidden-notify"/>rb_shell_hidden_notify ()</title>
362
<indexterm><primary>rb_shell_hidden_notify</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_hidden_notify (<link linkend="RBShell">RBShell</link> *shell,
363
<link linkend="guint">guint</link> timeout,
364
const <link linkend="char">char</link> *primary,
365
<link linkend="GtkWidget">GtkWidget</link> *icon,
366
const <link linkend="char">char</link> *secondary);</programlisting>
369
</para><variablelist role="params">
370
<varlistentry><term><parameter>shell</parameter> :</term>
372
</simpara></listitem></varlistentry>
373
<varlistentry><term><parameter>timeout</parameter> :</term>
375
</simpara></listitem></varlistentry>
376
<varlistentry><term><parameter>primary</parameter> :</term>
378
</simpara></listitem></varlistentry>
379
<varlistentry><term><parameter>icon</parameter> :</term>
381
</simpara></listitem></varlistentry>
382
<varlistentry><term><parameter>secondary</parameter> :</term>
386
</simpara></listitem></varlistentry>
387
</variablelist></refsect2>
389
<title><anchor id="rb-shell-construct"/>rb_shell_construct ()</title>
390
<indexterm><primary>rb_shell_construct</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_construct (<link linkend="RBShell">RBShell</link> *shell);</programlisting>
393
</para><variablelist role="params">
394
<varlistentry><term><parameter>shell</parameter> :</term>
398
</simpara></listitem></varlistentry>
399
</variablelist></refsect2>
401
<title><anchor id="rb-shell-register-entry-type-for-source"/>rb_shell_register_entry_type_for_source ()</title>
402
<indexterm><primary>rb_shell_register_entry_type_for_source</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_register_entry_type_for_source
403
(<link linkend="RBShell">RBShell</link> *shell,
404
<link linkend="RBSource">RBSource</link> *source,
405
<link linkend="RhythmDBEntryType">RhythmDBEntryType</link> type);</programlisting>
408
</para><variablelist role="params">
409
<varlistentry><term><parameter>shell</parameter> :</term>
411
</simpara></listitem></varlistentry>
412
<varlistentry><term><parameter>source</parameter> :</term>
414
</simpara></listitem></varlistentry>
415
<varlistentry><term><parameter>type</parameter> :</term>
419
</simpara></listitem></varlistentry>
420
</variablelist></refsect2>
422
<title><anchor id="rb-shell-append-source"/>rb_shell_append_source ()</title>
423
<indexterm><primary>rb_shell_append_source</primary></indexterm><programlisting><link linkend="void">void</link> rb_shell_append_source (<link linkend="RBShell">RBShell</link> *shell,
424
<link linkend="RBSource">RBSource</link> *source,
425
<link linkend="RBSource">RBSource</link> *parent);</programlisting>
428
</para><variablelist role="params">
429
<varlistentry><term><parameter>shell</parameter> :</term>
431
</simpara></listitem></varlistentry>
432
<varlistentry><term><parameter>source</parameter> :</term>
434
</simpara></listitem></varlistentry>
435
<varlistentry><term><parameter>parent</parameter> :</term>
439
</simpara></listitem></varlistentry>
440
</variablelist></refsect2>