/usr/share/gtk-doc/html/rhythmbox/rhythmbox-RBTransferTarget.html is in rhythmbox-doc 3.0.2-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Rhythmbox Development Reference Manual: RBTransferTarget</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch06.html" title="Sources">
<link rel="prev" href="rhythmbox-RBDeviceSource.html" title="RBDeviceSource">
<link rel="next" href="ch07.html" title="Widgets">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#rhythmbox-RBTransferTarget.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#rhythmbox-RBTransferTarget.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="rhythmbox-RBDeviceSource.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch07.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="rhythmbox-RBTransferTarget"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rhythmbox-RBTransferTarget.top_of_page"></a>RBTransferTarget</span></h2>
<p>RBTransferTarget — interface for sources that can receive track transfers</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="rhythmbox-RBTransferTarget.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-build-dest-uri" title="rb_transfer_target_build_dest_uri ()">rb_transfer_target_build_dest_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-track-added" title="rb_transfer_target_track_added ()">rb_transfer_target_track_added</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-track-add-error" title="rb_transfer_target_track_add_error ()">rb_transfer_target_track_add_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-should-transfer" title="rb_transfer_target_should_transfer ()">rb_transfer_target_should_transfer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-get-format-descriptions" title="rb_transfer_target_get_format_descriptions ()">rb_transfer_target_get_format_descriptions</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-check-category" title="rb_transfer_target_check_category ()">rb_transfer_target_check_category</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-check-duplicate" title="rb_transfer_target_check_duplicate ()">rb_transfer_target_check_duplicate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="returnvalue">RBTrackTransferBatch</span></a> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-RBTransferTarget.html#rb-transfer-target-transfer" title="rb_transfer_target_transfer ()">rb_transfer_target_transfer</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBTransferTarget.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="rhythmbox-RBTransferTarget.html#RBTransferTargetInterface" title="struct RBTransferTargetInterface">RBTransferTargetInterface</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBTransferTarget.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="rhythmbox-RBTransferTarget.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <rb-transfer-target.h>
</pre>
</div>
<div class="refsect1">
<a name="rhythmbox-RBTransferTarget.description"></a><h2>Description</h2>
<p>Sources that can accept track transfers should implement this interface
and call the associated functions to perform transfers. The source
needs to be able to construct target URIs for transfers, and can optionally
perform its own processing after transfers have finished. The source
must also provide a <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-encoding-profile.html#GstEncodingTarget"><span class="type">GstEncodingTarget</span></a> that describes the formats it
accepts.</p>
</div>
<div class="refsect1">
<a name="rhythmbox-RBTransferTarget.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-transfer-target-build-dest-uri"></a><h3>rb_transfer_target_build_dest_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
rb_transfer_target_build_dest_uri (<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *media_type</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *extension</code></em>);</pre>
<p>Constructs a URI to use as the destination for a transfer or transcoding
operation. The URI may be on the device itself, if the device is mounted
into the normal filesystem or through gvfs, or it may be a temporary
location used to store the file before uploading it to the device.</p>
<p>The destination URI should conform to the device's normal URI format,
and should use the provided extension instead of the extension from
the source entry.</p>
<div class="refsect3">
<a name="id-1.7.18.8.2.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span> being transferred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>media_type</p></td>
<td class="parameter_description"><p>destination media type</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>extension associated with destination media type</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.18.8.2.7"></a><h4>Returns</h4>
<p> constructed URI</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-transfer-target-track-added"></a><h3>rb_transfer_target_track_added ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_transfer_target_track_added (<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><span class="type">guint64</span> filesize</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *media_type</code></em>);</pre>
<p>This is called when a transfer to the target has completed.
If the source's <em class="parameter"><code>track_added</code></em>
method returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the destination
URI will be added to the database using the entry type for the device.</p>
<p>If the target uses a temporary area as the destination for transfers,
it can instead upload the destination file to the device and create an
entry for it, then return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.18.8.3.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the source <span class="type">RhythmDBEntry</span> for the transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>the destination URI</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filesize</p></td>
<td class="parameter_description"><p>size of the destination file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>media_type</p></td>
<td class="parameter_description"><p>media type of the destination file</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-transfer-target-track-add-error"></a><h3>rb_transfer_target_track_add_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_transfer_target_track_add_error (<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
<p>This is called when a transfer fails. If the source's
impl_track_add_error implementation returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, an error dialog
will be displayed to the user containing the error message, unless
the error indicates that the destination file already exists.</p>
<div class="refsect3">
<a name="id-1.7.18.8.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the source <span class="type">RhythmDBEntry</span> for the transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>the destination URI</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>the transfer error information</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-transfer-target-should-transfer"></a><h3>rb_transfer_target_should_transfer ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_transfer_target_should_transfer (<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>Checks whether <em class="parameter"><code>entry</code></em>
should be transferred to the target.
The target can check whether a matching entry already exists on the device,
for instance. <em class="parameter"><code>rb_transfer_target_check_duplicate</code></em>
may form part of
an implementation. If this method returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the entry
will be skipped.</p>
<div class="refsect3">
<a name="id-1.7.18.8.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span> to consider transferring</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.18.8.5.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the entry should be transferred to the target</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-transfer-target-get-format-descriptions"></a><h3>rb_transfer_target_get_format_descriptions ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
rb_transfer_target_get_format_descriptions
(<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>);</pre>
<p>Returns a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of allocated media format descriptions for
the formats supported by the target. The list and the strings
it holds must be freed by the caller.</p>
<div class="refsect3">
<a name="id-1.7.18.8.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.18.8.6.6"></a><h4>Returns</h4>
<p> list of descriptions. </p>
<p><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-transfer-target-check-category"></a><h3>rb_transfer_target_check_category ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_transfer_target_check_category (<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>This checks that the entry type of <em class="parameter"><code>entry</code></em>
is in a suitable
category for transfer. This can be used to implement
<em class="parameter"><code>should_transfer</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.18.8.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span> to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.18.8.7.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the entry is in a suitable category</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-transfer-target-check-duplicate"></a><h3>rb_transfer_target_check_duplicate ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_transfer_target_check_duplicate (<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>This checks for an existing entry in the target that matches
the title, album, artist, and track number of the entry being
considered. This can be used to implement <em class="parameter"><code>should_transfer</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.18.8.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>a <span class="type">RhythmDBEntry</span> to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.18.8.8.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the entry already exists on the target.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-transfer-target-transfer"></a><h3>rb_transfer_target_transfer ()</h3>
<pre class="programlisting"><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="returnvalue">RBTrackTransferBatch</span></a> *
rb_transfer_target_transfer (<em class="parameter"><code><span class="type">RBTransferTarget</span> *target</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *entries</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> defer</code></em>);</pre>
<p>Starts tranferring <em class="parameter"><code>entries</code></em>
to the target. This returns the
<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> that it starts, so the caller can track
the progress of the transfer, or NULL if the target doesn't
want any of the entries.</p>
<div class="refsect3">
<a name="id-1.7.18.8.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>target</p></td>
<td class="parameter_description"><p>an <span class="type">RBTransferTarget</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entries</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of entries to transfer. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> RB.RhythmDBEntry]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>defer</p></td>
<td class="parameter_description"><p>if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, don't start the transfer until</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.18.8.9.6"></a><h4>Returns</h4>
<p> an <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a>, or NULL. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="rhythmbox-RBTransferTarget.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBTransferTargetInterface"></a><h3>struct RBTransferTargetInterface</h3>
<pre class="programlisting">struct RBTransferTargetInterface {
GTypeInterface g_iface;
char* (*build_dest_uri) (RBTransferTarget *target,
RhythmDBEntry *entry,
const char *media_type,
const char *extension);
gboolean (*track_added) (RBTransferTarget *target,
RhythmDBEntry *entry,
const char *uri,
guint64 dest_size,
const char *media_type);
gboolean (*track_add_error) (RBTransferTarget *target,
RhythmDBEntry *entry,
const char *uri,
GError *error);
gboolean (*should_transfer) (RBTransferTarget *target,
RhythmDBEntry *entry);
};
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|