RB.TrackTransferQueue¶
- Subclasses
None
Methods¶
- Inherited
- Structs
class |
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited
|
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r |
current |
||
r/w/co |
the |
Signals¶
- Inherited
Name |
Short Description |
---|---|
Emitted to request installation of one or more encoder plugins for a destination media format. |
|
Emitted regularly to convey progress information. |
Fields¶
- Inherited
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class RB.TrackTransferQueue(**kwargs)¶
- Bases
- Abstract
No
- Structure
- classmethod new(shell)¶
- Parameters
- Returns
- Return type
Creates the
RB.TrackTransferQueue
instance
- cancel_batch(batch)¶
- Parameters
batch (
RB.TrackTransferBatch
) – theRB.TrackTransferBatch
to cancel, orNone
for the current batch
Removes a transfer batch from the queue. If an entry from the batch is currently being transferred, the transfer will be aborted.
- cancel_for_source(source)¶
-
Cancels all transfers to or from a specified source.
- find_batch_by_source(source)¶
- Parameters
- Returns
GLib.List
ofRB.TrackTransferBatch
objects, not referenced- Return type
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.
- start_batch(batch)¶
- Parameters
batch (
RB.TrackTransferBatch
) – theRB.TrackTransferBatch
to add to the queue
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.
Signal Details¶
- RB.TrackTransferQueue.signals.missing_plugins(track_transfer_queue, details, descriptions, closure)¶
- Signal Name
missing-plugins
- Flags
- Parameters
track_transfer_queue (
RB.TrackTransferQueue
) – The object which received the signaldetails ([
str
]) – the list of plugin detail strings describing the missing pluginsdescriptions ([
str
]) – the list of descriptions for the missing pluginsclosure (
GObject.Closure
) – aGObject.Closure
to be called when the plugin installation is complete
- Return type
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.
- RB.TrackTransferQueue.signals.transfer_progress(track_transfer_queue, done, total, fraction, time_left)¶
- Signal Name
transfer-progress
- Flags
- Parameters
track_transfer_queue (
RB.TrackTransferQueue
) – The object which received the signaldone (
int
) – the number of entries transferredtotal (
int
) – the total number of entries in the batchfraction (
float
) – the fraction of the batch that has been transferredtime_left (
int
) – the estimated remaining time (in seconds)
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.
Property Details¶
- RB.TrackTransferQueue.props.batch¶
- Name
batch
- Type
- Default Value
- Flags
The current
RB.TrackTransferBatch
being processed