| Rhythmbox Development Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
struct RBTrackTransferQueue; struct RBTrackTransferQueueClass; RBTrackTransferQueue * rb_track_transfer_queue_new (RBShell *shell); void rb_track_transfer_queue_start_batch (RBTrackTransferQueue *queue,RBTrackTransferBatch *batch); void rb_track_transfer_queue_cancel_batch (RBTrackTransferQueue *queue,RBTrackTransferBatch *batch); gboolean rb_track_transfer_queue_get_status (RBTrackTransferQueue *queue,char **text,char **progress_text,float *progress,int *time_left); GList * rb_track_transfer_queue_find_batch_by_source (RBTrackTransferQueue *queue,RBSource *source);
struct RBTrackTransferQueueClass {
GObjectClass parent_class;
/* signals */
void (*transfer_progress) (RBTrackTransferQueue *queue,
int done,
int total,
double fraction,
int time_left);
};
RBTrackTransferQueue * rb_track_transfer_queue_new (RBShell *shell);
Creates the RBTrackTransferQueue instance
|
the RBShell |
Returns : |
the RBTrackTransferQueue |
void rb_track_transfer_queue_start_batch (RBTrackTransferQueue *queue,RBTrackTransferBatch *batch);
Adds a new transfer batch to the transfer queue; if the queue is currently empty, the transfer will start immediately, but not before the call returns.
|
the RBTrackTransferQueue |
|
the RBTrackTransferBatch to add to the queue |
void rb_track_transfer_queue_cancel_batch (RBTrackTransferQueue *queue,RBTrackTransferBatch *batch);
Removes a transfer batch from the queue. If an entry from the batch is currently being transferred, the transfer will be aborted.
|
the RBTrackTransferQueue |
|
the RBTrackTransferBatch to cancel, or NULL for the current batch |
gboolean rb_track_transfer_queue_get_status (RBTrackTransferQueue *queue,char **text,char **progress_text,float *progress,int *time_left);
Retrieves transfer status information. Works similarly to rb_source_get_status.
|
the RBTrackTransferQueue |
|
returns the status bar text |
|
returns the progress bar text |
|
returns the progress fraction |
|
returns the estimated number of seconds remaining |
Returns : |
TRUE if transfer status information is returned |
GList * rb_track_transfer_queue_find_batch_by_source (RBTrackTransferQueue *queue,RBSource *source);
Finds all transfer batches where source is the source or destination.
This should be used to wait for transfers to finish (or cancel them) before
ejecting a device. The transfer batches are returned in the order they're
found in the queue, so waiting for the RBTrackTransferBatch::complete signal
on the last one is sufficient to wait for them all to finish.
|
the RBTrackTransferQueue |
|
the RBSource to search for |
Returns : |
GList of RBTrackTransferBatch objects, not referenced. [element-type RBTrackTransferBatch][transfer container] |
"batch" property"batch" RBTrackTransferBatch* : Read
The current RBTrackTransferBatch being processed
"missing-plugins" signalgboolean user_function (RBTrackTransferQueue *queue,
GStrv details,
GStrv descriptions,
GClosure *closure,
gpointer user_data) : Run Last
Emitted to request installation of one or more encoder plugins for a destination media format. When the closure included in the signal args is called, the transfer batch will be started.
|
the RBTrackTransferQueue |
|
the list of plugin detail strings describing the missing plugins |
|
the list of descriptions for the missing plugins |
|
a GClosure to be called when the plugin installation is complete |
|
user data set when the signal handler was connected. |
"transfer-progress" signalvoid user_function (RBTrackTransferQueue *queue,
gint done,
gint total,
gdouble fraction,
gint time_left,
gpointer user_data) : Run Last
Emitted regularly to convey progress information. At the end of any given
transfer batch, there will be one signal emission with done == total and
fraction == 1.0.
|
the RBTrackTransferQueue |
|
the number of entries transferred |
|
the total number of entries in the batch |
|
the fraction of the batch that has been transferred |
|
the estimated remaining time (in seconds) |
|
user data set when the signal handler was connected. |