rb_track_transfer_batch_new ()

RBTrackTransferBatch *
rb_track_transfer_batch_new (GstEncodingTarget *target,
                             GSettings *settings,
                             GObject *source,
                             GObject *destination,
                             GObject *queue);

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.

One or more entries must be added to the batch (using rb_track_transfer_batch_add) before the batch can be started (rb_track_transfer_manager_start_batch).

rb_track_transfer_batch_add ()

void
rb_track_transfer_batch_add (RBTrackTransferBatch *batch,
                             RhythmDBEntry *entry);

Adds an entry to be transferred.

rb_track_transfer_batch_cancel ()

void
rb_track_transfer_batch_cancel (RBTrackTransferBatch *batch);

Cancels the batch.

struct RBTrackTransferBatch

struct RBTrackTransferBatch;

struct RBTrackTransferBatchClass

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);
};

The “destination” property

  “destination”              RBSource *

The RBSource to which the tracks are being transferred.

Flags: Read / Write / Construct Only

The “done-entries” property

  “done-entries”             gint

Number of entries in the batch that have been transferred.

Flags: Read

Allowed values: >= 0

Default value: 0

The “encoding-target” property

  “encoding-target”          GstEncodingTarget *

A GstEncodingTarget describing allowable target formats. If NULL, the default set of profiles will be used.

Flags: Read / Write / Construct

The “entry-list” property

  “entry-list”               gpointer

A list of all entries in the batch.

Flags: Read

The “progress” property

  “progress”                 gdouble

Fraction of the transfer batch that has been processed.

Flags: Read

Allowed values: [0,1]

Default value: 0

The “queue” property

  “queue”                    RBTrackTransferQueue *

The RBTrackTransferQueue instance

Flags: Read / Write / Construct Only

The “settings” property

  “settings”                 GSettings *

GSettings instance holding profile preferences

Flags: Read / Write / Construct Only

The “source” property

  “source”                   RBSource *

The RBSource from which the tracks are being transferred.

Flags: Read / Write / Construct Only

The “total-entries” property

  “total-entries”            gint

Total number of entries in the transfer batch.

Flags: Read

Allowed values: >= 0

Default value: 0

The “cancelled” signal

void
user_function (RBTrackTransferBatch *batch,
               gpointer              user_data)

Emitted when the batch is cancelled.

hmm. will 'complete' still be emitted in this case?

Flags: Run Last

The “complete” signal

void
user_function (RBTrackTransferBatch *batch,
               gpointer              user_data)

Emitted when the batch is complete. This will be immediately after the final entry transfer is complete.

Flags: Run Last

The “get-dest-uri” signal

gchar*
user_function (RBTrackTransferBatch *batch,
               RhythmDBEntry        *entry,
               gchar                *mediatype,
               gchar                *extension,
               gpointer              user_data)

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.

Flags: Run Last

The “overwrite-prompt” signal

void
user_function (RBTrackTransferBatch *batch,
               gchar                *uri,
               gpointer              user_data)

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.

Flags: Run Last

The “started” signal

void
user_function (RBTrackTransferBatch *batch,
               gpointer              user_data)

Emitted when the batch is started. This will be after all previous batches have finished, which is not necessarily when rb_track_transfer_manager_start_batch is called.

Flags: Run Last

The “track-done” signal

void
user_function (RBTrackTransferBatch *batch,
               RhythmDBEntry        *entry,
               gchar                *dest,
               guint64               dest_size,
               gchar                *dest_mediatype,
               gpointer              error,
               gpointer              user_data)

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..).

Flags: Run Last

The “track-progress” signal

void
user_function (RBTrackTransferBatch *batch,
               RhythmDBEntry        *entry,
               gchar                *dest,
               gint                  done,
               gint                  total,
               gdouble               fraction,
               gpointer              user_data)

Emitted regularly throughout the transfer to allow progress bars and other UI elements to be updated.

Flags: Run Last

The “track-started” signal

void
user_function (RBTrackTransferBatch *batch,
               RhythmDBEntry        *entry,
               gchar                *dest,
               gpointer              user_data)

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.

Flags: Run Last