sbIDownloadDevice Interface Reference

Songbird DownloadDevice Interface. More...

import"sbIDownloadDevice.idl";

Inheritance diagram for sbIDownloadDevice:
[legend]
Collaboration diagram for sbIDownloadDevice:
[legend]

Public Member Functions

void clearCompletedItems ()
 Clear all completed items from download device. More...
 
- Public Member Functions inherited from sbIDeviceBase
void initialize ()
 Initialize the device category handler. More...
 
void finalize ()
 Finalize usage of the device category handler. More...
 
void addCallback (in sbIDeviceBaseCallback aCallback)
 Add a device category handler callback. More...
 
void removeCallback (in sbIDeviceBaseCallback aCallback)
 Remove a device category handler callback. More...
 
sbILibrary getLibrary (in AString aDeviceIdentifier)
 Get the device library representing the content available on the device. More...
 
unsigned long getDeviceState (in AString aDeviceIdentifier)
 Get the device's current state. More...
 
nsIURI getTransferLocation (in AString aDeviceIdentifier, in sbIMediaItem aMediaItem)
 Get preferred transfer location for item. More...
 
unsigned long transferItems (in AString aDeviceIdentifier, in nsIArray aMediaItems, in nsIURI aDestionationPath, in unsigned long aDeviceOperation, in boolean aBeginTransferNow, in sbILibrary aDestinationLibrary)
 Transfer items to a library or destination. More...
 
unsigned long updateItems (in AString aDeviceIdentifier, in nsIArray aMediaItems)
 Update items on the device. More...
 
unsigned long deleteItems (in AString aDeviceIdentifier, in nsIArray aMediaItems)
 Delete items from the device. More...
 
unsigned long deleteAllItems (in AString aDeviceIdentifier)
 
unsigned long createPlaylists (in AString aDeviceIdentifier, in nsIArray aMediaLists)
 
unsigned long deletePlaylists (in AString aDeviceIdentifier, in nsIArray aMediaLists)
 
unsigned long addToPlaylist (in AString aDeviceIdentifier, in sbIMediaList aMediaList, in nsIArray aMediaItems, in unsigned long aBeforeIndex)
 
unsigned long removeFromPlaylist (in AString aDeviceIdentifier, in sbIMediaList aMediaList, in sbIMediaItem aMediaItem, in unsigned long aIndex)
 
unsigned long movePlaylistItem (in AString aDeviceIdentifier, in sbIMediaList aMediaList, in unsigned long aFromIndex, in unsigned long aToIndex)
 
unsigned long clearPlaylist (in AString aDeviceIdentifier, in sbIMediaList aMediaList)
 
sbIMediaItem beginTransfer (in AString aDeviceIdentifier)
 Begin transfer operations. More...
 
unsigned long cancelTransfer (in AString aDeviceIdentifier, in nsIArray aMediaItems)
 Cancel a transfer by removing it from the queue. More...
 
unsigned long suspendTransfer (in AString aDeviceIdentifier)
 Suspend all transfers. More...
 
unsigned long resumeTransfer (in AString aDeviceIdentifier)
 Resume pending transfers. More...
 
long long getUsedSpace (in AString aDeviceIdentifier)
 Get the amount of used space from a device. More...
 
long long getAvailableSpace (in AString aDeviceIdentifier)
 Get the amount of available space from a device. More...
 
nsIArray getSupportedFormats (in AString aDeviceIdentifier)
 Returns a list of file extensions representing the formats supported by a specific device. More...
 
boolean isDownloadSupported (in AString aDeviceIdentifier)
 Download is to copy a track from the device to the host. More...
 
boolean isUploadSupported (in AString aDeviceIdentifier)
 Is uploading supported on this device? More...
 
boolean isDeleteSupported (in AString aDeviceIdentifier)
 Is it possible to delete items from the device? More...
 
boolean isUpdateSupported (in AString aDeviceIdentifier)
 Is it possible to update items directly on the device? More...
 
boolean isEjectSupported (in AString aDeviceIdentifier)
 Is eject or unmount supported by the device?. More...
 
boolean ejectDevice (in AString aDeviceIdentifier)
 Eject or unmount the device from the system. More...
 

Public Attributes

readonly attribute sbIMediaList downloadMediaList
 The media list containing items for download. More...
 
readonly attribute unsigned long completedItemCount
 The number of completed download items. More...
 
- Public Attributes inherited from sbIDeviceBase
const PRUint32 FILE_FORMAT_UNDEFINED = 9999
 
const PRUint32 FILE_FORMAT_WAV = 0
 
const PRUint32 FILE_FORMAT_MP3 = 1
 
const PRUint32 FILE_FORMAT_WMA = 2
 
const PRUint32 STATE_IDLE = 0
 
const PRUint32 STATE_BUSY = 1
 
const PRUint32 STATE_DOWNLOADING = 2
 
const PRUint32 STATE_UPLOADING = 3
 
const PRUint32 STATE_DOWNLOAD_PAUSED = 4
 
const PRUint32 STATE_UPLOAD_PAUSED = 5
 
const PRUint32 STATE_DELETING = 6
 
const unsigned long OP_UPLOAD = 1
 Device Operation Constants. More...
 
const unsigned long OP_DOWNLOAD = 2
 
const unsigned long OP_MOVE = 3
 
attribute AString name
 The name of the device category handler. More...
 
readonly attribute AString deviceCategory
 Device category name for this class of devices. More...
 
readonly attribute
nsIStringEnumerator 
deviceIdentifiers
 Contains nsISupportsStrings representing the device unique identifiers for all connected devices of this category. More...
 
readonly attribute unsigned long deviceCount
 Get the number of devices currently connected. More...
 

Detailed Description

Songbird DownloadDevice Interface.

<TODO:Detail>.

See Also
sbIDeviceBase.idl

Definition at line 51 of file sbIDownloadDevice.idl.

Member Function Documentation

void sbIDownloadDevice::clearCompletedItems ( )

Clear all completed items from download device.

Member Data Documentation

readonly attribute unsigned long sbIDownloadDevice::completedItemCount

The number of completed download items.

Definition at line 61 of file sbIDownloadDevice.idl.

readonly attribute sbIMediaList sbIDownloadDevice::downloadMediaList

The media list containing items for download.

Definition at line 56 of file sbIDownloadDevice.idl.


The documentation for this interface was generated from the following file: