/usr/share/gtk-doc/html/rhythmbox/RBTrackTransferBatch.html is in rhythmbox-doc 3.4.2-4ubuntu1.
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 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RBTrackTransferBatch: Rhythmbox Development Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch05.html" title="Shell">
<link rel="prev" href="RBStatusbar.html" title="RBStatusbar">
<link rel="next" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue">
<meta name="generator" content="GTK-Doc V1.27 (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="5"><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="#RBTrackTransferBatch.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#RBTrackTransferBatch.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#RBTrackTransferBatch.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#RBTrackTransferBatch.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#RBTrackTransferBatch.signals" class="shortcut">Signals</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="RBStatusbar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="RBTrackTransferQueue.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="RBTrackTransferBatch"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="RBTrackTransferBatch.top_of_page"></a>RBTrackTransferBatch</span></h2>
<p>RBTrackTransferBatch — batch track transfer job</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="RBTrackTransferBatch.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<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="RBTrackTransferBatch.html#rb-track-transfer-batch-new" title="rb_track_transfer_batch_new ()">rb_track_transfer_batch_new</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="RBTrackTransferBatch.html#rb-track-transfer-batch-add" title="rb_track_transfer_batch_add ()">rb_track_transfer_batch_add</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="RBTrackTransferBatch.html#rb-track-transfer-batch-cancel" title="rb_track_transfer_batch_cancel ()">rb_track_transfer_batch_cancel</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *</td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--destination" title="The “destination” property">destination</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--done-entries" title="The “done-entries” property">done-entries</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="../gst-plugins-base-libs-1.0/GstEncodingProfile.html#GstEncodingTarget-struct"><span class="type">GstEncodingTarget</span></a> *</td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--encoding-target" title="The “encoding-target” property">encoding-target</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--entry-list" title="The “entry-list” property">entry-list</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--progress" title="The “progress” property">progress</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *</td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--queue" title="The “queue” property">queue</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../gio/GSettings.html#GSettings-struct"><span class="type">GSettings</span></a> *</td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--settings" title="The “settings” property">settings</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *</td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--source" title="The “source” property">source</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch--total-entries" title="The “total-entries” property">total-entries</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-cancelled" title="The “cancelled” signal">cancelled</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-complete" title="The “complete” signal">complete</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*</td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-get-dest-uri" title="The “get-dest-uri” signal">get-dest-uri</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-overwrite-prompt" title="The “overwrite-prompt” signal">overwrite-prompt</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-started" title="The “started” signal">started</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-track-done" title="The “track-done” signal">track-done</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-track-progress" title="The “track-progress” signal">track-progress</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatch-track-started" title="The “track-started” signal">track-started</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="RBTrackTransferBatch.html#RBTrackTransferBatch-struct" title="struct RBTrackTransferBatch">RBTrackTransferBatch</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="RBTrackTransferBatch.html#RBTrackTransferBatchClass" title="struct RBTrackTransferBatchClass">RBTrackTransferBatchClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> RBTrackTransferBatch
</pre>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
RBTrackTransferBatch implements
RBTaskProgress.</p>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.description"></a><h2>Description</h2>
<p>Manages the transfer of a set of tracks (using <span class="type">RBEncoder</span>), providing overall
status information and allowing the transfer to be cancelled as a single unit.</p>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-track-transfer-batch-new"></a><h3>rb_track_transfer_batch_new ()</h3>
<pre class="programlisting"><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="returnvalue">RBTrackTransferBatch</span></a> *
rb_track_transfer_batch_new (<em class="parameter"><code><a href="../gst-plugins-base-libs-1.0/GstEncodingProfile.html#GstEncodingTarget-struct"><span class="type">GstEncodingTarget</span></a> *target</code></em>,
<em class="parameter"><code><a href="../gio/GSettings.html#GSettings-struct"><span class="type">GSettings</span></a> *settings</code></em>,
<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *source</code></em>,
<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *destination</code></em>,
<em class="parameter"><code><a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *queue</code></em>);</pre>
<p>Creates a new transfer batch with the specified encoding target. If no target
is specified, the default target will be used with the user's preferred
encoding type.</p>
<p>One or more entries must be added to the batch (using <a class="link" href="RBTrackTransferBatch.html#rb-track-transfer-batch-add" title="rb_track_transfer_batch_add ()"><span class="type">rb_track_transfer_batch_add</span></a>)
before the batch can be started (<span class="type">rb_track_transfer_manager_start_batch</span>).</p>
<div class="refsect3">
<a name="rb-track-transfer-batch-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>a <a href="../gst-plugins-base-libs-1.0/GstEncodingProfile.html#GstEncodingTarget-struct"><span class="type">GstEncodingTarget</span></a> describing allowable encodings (or NULL for defaults)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> from which the entries are to be transferred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destination</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> to which the entries are to be transferred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>queue</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="rb-track-transfer-batch-new.returns"></a><h4>Returns</h4>
<p> new <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> object</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-track-transfer-batch-add"></a><h3>rb_track_transfer_batch_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_track_transfer_batch_add (<em class="parameter"><code><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch</code></em>,
<em class="parameter"><code><span class="type">RhythmDBEntry</span> *entry</code></em>);</pre>
<p>Adds an entry to be transferred.</p>
<div class="refsect3">
<a name="rb-track-transfer-batch-add.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></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> to transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-track-transfer-batch-cancel"></a><h3>rb_track_transfer_batch_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_track_transfer_batch_cancel (<em class="parameter"><code><a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch</code></em>);</pre>
<p>Cancels the batch.</p>
<div class="refsect3">
<a name="rb-track-transfer-batch-cancel.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>a <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBTrackTransferBatch-struct"></a><h3>struct RBTrackTransferBatch</h3>
<pre class="programlisting">struct RBTrackTransferBatch;</pre>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatchClass"></a><h3>struct RBTrackTransferBatchClass</h3>
<pre class="programlisting">struct RBTrackTransferBatchClass {
GObjectClass parent_class;
/* signals */
void (*started) (RBTrackTransferBatch *batch);
void (*cancelled) (RBTrackTransferBatch *batch);
void (*complete) (RBTrackTransferBatch *batch);
char * (*get_dest_uri) (RBTrackTransferBatch *batch,
RhythmDBEntry *entry,
const char *mediatype,
const char *extension);
gboolean (*overwrite_prompt) (RBTrackTransferBatch *batch,
GFile *dest_file);
void (*track_started) (RBTrackTransferBatch *batch,
RhythmDBEntry *entry,
const char *dest);
void (*track_progress) (RBTrackTransferBatch *batch,
RhythmDBEntry *entry,
const char *dest,
int done,
int total,
double fraction);
void (*track_done) (RBTrackTransferBatch *batch,
RhythmDBEntry *entry,
const char *dest,
guint64 dest_size,
const char *mediatype,
GError *error);
};
</pre>
</div>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="RBTrackTransferBatch--destination"></a><h3>The <code class="literal">“destination”</code> property</h3>
<pre class="programlisting"> “destination” <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *</pre>
<p>The RBSource to which the tracks are being transferred.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--done-entries"></a><h3>The <code class="literal">“done-entries”</code> property</h3>
<pre class="programlisting"> “done-entries” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Number of entries in the batch that have been transferred.</p>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--encoding-target"></a><h3>The <code class="literal">“encoding-target”</code> property</h3>
<pre class="programlisting"> “encoding-target” <a href="../gst-plugins-base-libs-1.0/GstEncodingProfile.html#GstEncodingTarget-struct"><span class="type">GstEncodingTarget</span></a> *</pre>
<p>A GstEncodingTarget describing allowable target formats.
If NULL, the default set of profiles will be used.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--entry-list"></a><h3>The <code class="literal">“entry-list”</code> property</h3>
<pre class="programlisting"> “entry-list” <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>A list of all entries in the batch.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--progress"></a><h3>The <code class="literal">“progress”</code> property</h3>
<pre class="programlisting"> “progress” <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Fraction of the transfer batch that has been processed.</p>
<p>Flags: Read</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--queue"></a><h3>The <code class="literal">“queue”</code> property</h3>
<pre class="programlisting"> “queue” <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> *</pre>
<p>The <a class="link" href="RBTrackTransferQueue.html" title="RBTrackTransferQueue"><span class="type">RBTrackTransferQueue</span></a> instance</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--settings"></a><h3>The <code class="literal">“settings”</code> property</h3>
<pre class="programlisting"> “settings” <a href="../gio/GSettings.html#GSettings-struct"><span class="type">GSettings</span></a> *</pre>
<p>GSettings instance holding profile preferences</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--source"></a><h3>The <code class="literal">“source”</code> property</h3>
<pre class="programlisting"> “source” <a class="link" href="RBSource.html" title="RBSource"><span class="type">RBSource</span></a> *</pre>
<p>The RBSource from which the tracks are being transferred.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch--total-entries"></a><h3>The <code class="literal">“total-entries”</code> property</h3>
<pre class="programlisting"> “total-entries” <a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Total number of entries in the transfer batch.</p>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="RBTrackTransferBatch.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="RBTrackTransferBatch-cancelled"></a><h3>The <code class="literal">“cancelled”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when the batch is cancelled.</p>
<p>hmm. will 'complete' still be emitted in this case?</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-cancelled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch-complete"></a><h3>The <code class="literal">“complete”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when the batch is complete. This will be immediately
after the final entry transfer is complete.</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-complete.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch-get-dest-uri"></a><h3>The <code class="literal">“get-dest-uri”</code> signal</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<span class="type">RhythmDBEntry</span> *entry,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *mediatype,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *extension,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The batch emits this to allow the creator to provide a destination
URI for an entry being transferred. This is emitted after the
output media type is decided, so the usual extension for the media
type can be taken into consideration.</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-get-dest-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the <span class="type">RhythmDBEntry</span> to be transferred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mediatype</p></td>
<td class="parameter_description"><p>the destination media type for the transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extension</p></td>
<td class="parameter_description"><p>usual extension for the destionation media type</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch-overwrite-prompt"></a><h3>The <code class="literal">“overwrite-prompt”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when the destination URI for a transfer already exists.
The handler must call _rb_track_transfer_batch_continue or
_rb_track_transfer_batch_cancel when it has figured out what to
do.</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-overwrite-prompt.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></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 that already exists</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch-started"></a><h3>The <code class="literal">“started”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when the batch is started. This will be after
all previous batches have finished, which is not necessarily
when <span class="type">rb_track_transfer_manager_start_batch</span> is called.</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-started.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch-track-done"></a><h3>The <code class="literal">“track-done”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<span class="type">RhythmDBEntry</span> *entry,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest,
<a href="../glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> dest_size,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest_mediatype,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> error,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when a track transfer is complete, whether because
the track was fully transferred, because an error occurred,
or because the batch was cancelled (maybe..).</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-track-done.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the <span class="type">RhythmDBEntry</span> that was transferred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>the destination URI for the transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_size</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>dest_mediatype</p></td>
<td class="parameter_description"><p>the media type of the destination file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>any error that occurred during transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch-track-progress"></a><h3>The <code class="literal">“track-progress”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<span class="type">RhythmDBEntry</span> *entry,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> done,
<a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> total,
<a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> fraction,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted regularly throughout the transfer to allow progress bars
and other UI elements to be updated.</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-track-progress.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the <span class="type">RhythmDBEntry</span> being transferred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>the destination URI for the transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>done</p></td>
<td class="parameter_description"><p>some measure of how much of the transfer is done</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>total</p></td>
<td class="parameter_description"><p>the total amount of that same measure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fraction</p></td>
<td class="parameter_description"><p>the fraction of the transfer that is done</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
<hr>
<div class="refsect2">
<a name="RBTrackTransferBatch-track-started"></a><h3>The <code class="literal">“track-started”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a> *batch,
<span class="type">RhythmDBEntry</span> *entry,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dest,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Emitted when a new entry is about to be transferred.
This will be emitted for each entry in the batch, unless
the batch is cancelled.</p>
<div class="refsect3">
<a name="RBTrackTransferBatch-track-started.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="RBTrackTransferBatch.html" title="RBTrackTransferBatch"><span class="type">RBTrackTransferBatch</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>entry</p></td>
<td class="parameter_description"><p>the <span class="type">RhythmDBEntry</span> being transferred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest</p></td>
<td class="parameter_description"><p>the destination URI for the transfer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|