1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>RBRemovableMediaManager</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
<link rel="start" href="index.html" title="Rhythmbox Development Reference Manual">
8
<link rel="up" href="ch05.html" title="Shell">
9
<link rel="prev" href="RBPlaylistManager.html" title="RBPlaylistManager">
10
<link rel="next" href="RBShellClipboard.html" title="RBShellClipboard">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="chapter" href="ch01.html" title="Backends">
14
<link rel="chapter" href="ch02.html" title="Lib">
15
<link rel="chapter" href="ch03.html" title="Metadata">
16
<link rel="chapter" href="ch04.html" title="RhythmDB">
17
<link rel="chapter" href="ch05.html" title="Shell">
18
<link rel="chapter" href="ch06.html" title="Sources">
19
<link rel="chapter" href="ch07.html" title="Widgets">
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
22
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
24
<td><a accesskey="p" href="RBPlaylistManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
25
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
26
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
27
<th width="100%" align="center">Rhythmbox Development Reference Manual</th>
28
<td><a accesskey="n" href="RBShellClipboard.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
<tr><td colspan="5" class="shortcuts"><nobr><a href="#RBRemovableMediaManager.synopsis" class="shortcut">Top</a>
32
<a href="#RBRemovableMediaManager.description" class="shortcut">Description</a>
34
<a href="#RBRemovableMediaManager.object-hierarchy" class="shortcut">Object Hierarchy</a>
36
<a href="#RBRemovableMediaManager.properties" class="shortcut">Properties</a>
38
<a href="#RBRemovableMediaManager.signals" class="shortcut">Signals</a></nobr></td></tr>
40
<div class="refentry" lang="en">
41
<a name="RBRemovableMediaManager"></a><div class="titlepage"></div>
42
<div class="refnamediv"><table width="100%"><tr>
44
<h2><span class="refentrytitle"><a name="RBRemovableMediaManager.top_of_page"></a>RBRemovableMediaManager</span></h2>
45
<p>RBRemovableMediaManager</p>
47
<td valign="top" align="right"></td>
49
<div class="refsynopsisdiv">
50
<a name="RBRemovableMediaManager.synopsis"></a><h2>Synopsis</h2>
51
<pre class="synopsis">
52
<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager-struct" title="RBRemovableMediaManager">RBRemovableMediaManager</a>;
53
<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManagerClass" title="RBRemovableMediaManagerClass">RBRemovableMediaManagerClass</a>;
54
<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a>* <a class="link" href="RBRemovableMediaManager.html#rb-removable-media-manager-new" title="rb_removable_media_manager_new ()">rb_removable_media_manager_new</a> (RBShell *shell);
55
void <a class="link" href="RBRemovableMediaManager.html#rb-removable-media-manager-scan" title="rb_removable_media_manager_scan ()">rb_removable_media_manager_scan</a> (<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *manager);
56
void <a class="link" href="RBRemovableMediaManager.html#rb-removable-media-manager-queue-transfer" title="rb_removable_media_manager_queue_transfer ()">rb_removable_media_manager_queue_transfer</a>
57
(<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *mgr,
58
<a class="link" href="RhythmDB.html#RhythmDBEntry" title="RhythmDBEntry">RhythmDBEntry</a> *entry,
61
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
62
>GList</a> *mime_types,
63
RBTransferCompleteCallback callback,
65
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
66
>gpointer</a> userdata);
69
<div class="refsect1" lang="en">
70
<a name="RBRemovableMediaManager.object-hierarchy"></a><h2>Object Hierarchy</h2>
71
<pre class="synopsis">
73
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
75
+----RBRemovableMediaManager
78
<div class="refsect1" lang="en">
79
<a name="RBRemovableMediaManager.properties"></a><h2>Properties</h2>
80
<pre class="synopsis">
81
"<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager--scanned" title='The "scanned" property'>scanned</a>" <a
82
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
84
"<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager--shell" title='The "shell" property'>shell</a>" RBShell* : Read / Write
85
"<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager--source" title='The "source" property'>source</a>" <a class="link" href="RBSource.html" title="RBSource">RBSource</a>* : Read / Write
88
<div class="refsect1" lang="en">
89
<a name="RBRemovableMediaManager.signals"></a><h2>Signals</h2>
90
<pre class="synopsis">
91
"<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager-create-source-mount" title='The "create-source-mount" signal'>create-source-mount</a>" : Run Last
92
"<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager-create-source-volume" title='The "create-source-volume" signal'>create-source-volume</a>" : Run Last
93
"<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager-medium-added" title='The "medium-added" signal'>medium-added</a>" : Run Last
94
"<a class="link" href="RBRemovableMediaManager.html#RBRemovableMediaManager-transfer-progress" title='The "transfer-progress" signal'>transfer-progress</a>" : Run Last
97
<div class="refsect1" lang="en">
98
<a name="RBRemovableMediaManager.description"></a><h2>Description</h2>
103
<div class="refsect1" lang="en">
104
<a name="RBRemovableMediaManager.details"></a><h2>Details</h2>
105
<div class="refsect2" lang="en">
106
<a name="RBRemovableMediaManager-struct"></a><h3>RBRemovableMediaManager</h3>
107
<pre class="programlisting">typedef struct _RBRemovableMediaManager RBRemovableMediaManager;</pre>
113
<div class="refsect2" lang="en">
114
<a name="RBRemovableMediaManagerClass"></a><h3>RBRemovableMediaManagerClass</h3>
115
<pre class="programlisting">typedef struct {
116
GObjectClass parent_class;
119
void (*medium_added) (RBRemovableMediaManager *mgr,
121
void (*transfer_progress) (RBRemovableMediaManager *mgr,
125
RBSource * (*create_source_mount) (RBRemovableMediaManager *mgr,
127
RBSource * (*create_source_volume) (RBRemovableMediaManager *mgr,
129
} RBRemovableMediaManagerClass;
136
<div class="refsect2" lang="en">
137
<a name="rb-removable-media-manager-new"></a><h3>rb_removable_media_manager_new ()</h3>
138
<pre class="programlisting"><a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a>* rb_removable_media_manager_new (RBShell *shell);</pre>
140
Creates the <a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager"><span class="type">RBRemovableMediaManager</span></a> instance.</p>
144
<div class="variablelist"><table border="0">
145
<col align="left" valign="top">
148
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
149
<td> the <span class="type">RBShell</span>
153
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
163
<div class="refsect2" lang="en">
164
<a name="rb-removable-media-manager-scan"></a><h3>rb_removable_media_manager_scan ()</h3>
165
<pre class="programlisting">void rb_removable_media_manager_scan (<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *manager);</pre>
167
Initiates a new scan of all attached media. Newly activated plugins that use
168
the create-source-volume or create-source-mount signals should call this if
169
the 'scanned' property is <a
170
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
171
><code class="literal">TRUE</code></a>. Otherwise, the first scan will catch any
172
existing volumes or mounts that the plugin is interested in.</p>
176
<div class="variablelist"><table border="0">
177
<col align="left" valign="top">
179
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
180
<td> the <a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager"><span class="type">RBRemovableMediaManager</span></a>
186
<div class="refsect2" lang="en">
187
<a name="rb-removable-media-manager-queue-transfer"></a><h3>rb_removable_media_manager_queue_transfer ()</h3>
188
<pre class="programlisting">void rb_removable_media_manager_queue_transfer
189
(<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *mgr,
190
<a class="link" href="RhythmDB.html#RhythmDBEntry" title="RhythmDBEntry">RhythmDBEntry</a> *entry,
193
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
194
>GList</a> *mime_types,
195
RBTransferCompleteCallback callback,
197
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
198
>gpointer</a> userdata);</pre>
200
Initiates a track transfer. This will transfer the track identified by the
201
<a class="link" href="RhythmDB.html#RhythmDBEntry" title="RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> to the given destination, transcoding it if its
202
current media type is not in the list of acceptable output types.</p>
206
<div class="variablelist"><table border="0">
207
<col align="left" valign="top">
210
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
215
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
216
<td> the <a class="link" href="RhythmDB.html#RhythmDBEntry" title="RhythmDBEntry"><span class="type">RhythmDBEntry</span></a> to transfer
220
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
221
<td> the destination URI
225
<td><p><span class="term"><em class="parameter"><code>mime_types</code></em> :</span></p></td>
226
<td> a list of acceptable output MIME types
230
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
231
<td> function to call when the transfer is complete
235
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
236
<td> data to pass to the callback
243
<div class="refsect1" lang="en">
244
<a name="RBRemovableMediaManager.property-details"></a><h2>Property Details</h2>
245
<div class="refsect2" lang="en">
246
<a name="RBRemovableMediaManager--scanned"></a><h3>The <code class="literal">"scanned"</code> property</h3>
247
<pre class="programlisting"> "scanned" <a
248
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
249
>gboolean</a> : Read</pre>
251
This is set to TRUE when the removable media manager has scanned
252
all existing volumes and mounts. When a plugin that handles removable
253
media is activated, it should request a new scan if this property is
254
already set to TRUE.</p>
258
<p>Default value: FALSE</p>
261
<div class="refsect2" lang="en">
262
<a name="RBRemovableMediaManager--shell"></a><h3>The <code class="literal">"shell"</code> property</h3>
263
<pre class="programlisting"> "shell" RBShell* : Read / Write</pre>
265
The <span class="type">RBShell</span> instance.</p>
271
<div class="refsect2" lang="en">
272
<a name="RBRemovableMediaManager--source"></a><h3>The <code class="literal">"source"</code> property</h3>
273
<pre class="programlisting"> "source" <a class="link" href="RBSource.html" title="RBSource">RBSource</a>* : Read / Write</pre>
275
The current selected source.</p>
281
<div class="refsect1" lang="en">
282
<a name="RBRemovableMediaManager.signal-details"></a><h2>Signal Details</h2>
283
<div class="refsect2" lang="en">
284
<a name="RBRemovableMediaManager-create-source-mount"></a><h3>The <code class="literal">"create-source-mount"</code> signal</h3>
285
<pre class="programlisting"><a class="link" href="RBSource.html" title="RBSource">RBSource</a>* user_function (<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *mgr,
287
href="/usr/share/gtk-doc/html/gio/GMount.html"
290
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
291
>gpointer</a> user_data) : Run Last</pre>
293
Emitted when a new mount is added to allow plugins to create a
294
corresponding <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>. The first signal handler that returns
295
a source wins. If a source was created for the <a
296
href="/usr/share/gtk-doc/html/gio/GVolume.html"
297
><span class="type">GVolume</span></a>
298
for a mount, then this signal will not be emitted.</p>
302
<div class="variablelist"><table border="0">
303
<col align="left" valign="top">
306
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
307
<td> the <a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager"><span class="type">RBRemovableMediaManager</span></a>
311
<td><p><span class="term"><em class="parameter"><code>mount</code></em> :</span></p></td>
313
href="/usr/share/gtk-doc/html/gio/GMount.html"
314
><span class="type">GMount</span></a>
318
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
319
<td>user data set when the signal handler was connected.</td>
325
<div class="refsect2" lang="en">
326
<a name="RBRemovableMediaManager-create-source-volume"></a><h3>The <code class="literal">"create-source-volume"</code> signal</h3>
327
<pre class="programlisting"><a class="link" href="RBSource.html" title="RBSource">RBSource</a>* user_function (<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *mgr,
329
href="/usr/share/gtk-doc/html/gio/GVolume.html"
330
>GVolume</a> *volume,
332
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
333
>gpointer</a> user_data) : Run Last</pre>
335
Emitted when a new volume is added to allow plugins to create a
336
corresponding <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>. The first signal handler that returns
337
a source wins. A plugin should only use this signal if it
338
doesn't require the volume to be mounted. If the volume must be
339
mounted to be useful, use the create-source-mount signal instead.</p>
343
<div class="variablelist"><table border="0">
344
<col align="left" valign="top">
347
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
348
<td> the <a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager"><span class="type">RBRemovableMediaManager</span></a>
352
<td><p><span class="term"><em class="parameter"><code>volume</code></em> :</span></p></td>
354
href="/usr/share/gtk-doc/html/gio/GVolume.html"
355
><span class="type">GVolume</span></a>
359
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
360
<td>user data set when the signal handler was connected.</td>
366
<div class="refsect2" lang="en">
367
<a name="RBRemovableMediaManager-medium-added"></a><h3>The <code class="literal">"medium-added"</code> signal</h3>
368
<pre class="programlisting">void user_function (<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *mgr,
370
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
371
>GObject</a> *source,
373
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
374
>gpointer</a> user_data) : Run Last</pre>
376
Emitted when a new source is added for a removable medium.</p>
380
<div class="variablelist"><table border="0">
381
<col align="left" valign="top">
384
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
385
<td> the <a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager"><span class="type">RBRemovableMediaManager</span></a>
389
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
390
<td> the newly added <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a>
394
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
395
<td>user data set when the signal handler was connected.</td>
401
<div class="refsect2" lang="en">
402
<a name="RBRemovableMediaManager-transfer-progress"></a><h3>The <code class="literal">"transfer-progress"</code> signal</h3>
403
<pre class="programlisting">void user_function (<a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager">RBRemovableMediaManager</a> *mgr,
405
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
408
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
411
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"
412
>gdouble</a> progress,
414
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
415
>gpointer</a> user_data) : Run Last</pre>
417
Emitted throughout the track transfer process to allow UI elements
418
showing transfer progress to be updated.</p>
422
<div class="variablelist"><table border="0">
423
<col align="left" valign="top">
426
<td><p><span class="term"><em class="parameter"><code>mgr</code></em> :</span></p></td>
427
<td> the <a class="link" href="RBRemovableMediaManager.html" title="RBRemovableMediaManager"><span class="type">RBRemovableMediaManager</span></a>
431
<td><p><span class="term"><em class="parameter"><code>done</code></em> :</span></p></td>
432
<td> number of tracks that have been fully transferred
436
<td><p><span class="term"><em class="parameter"><code>total</code></em> :</span></p></td>
437
<td> total number of tracks to transfer
441
<td><p><span class="term"><em class="parameter"><code>progress</code></em> :</span></p></td>
442
<td> fraction of the current track that has been transferred
446
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
447
<td>user data set when the signal handler was connected.</td>
456
Generated by GTK-Doc V1.10</div>