Songbird / Development / Songbird Add-Ons API Documentation

sbIDeviceLibrary Interface Reference

import "sbIDeviceLibrary.idl";

Inheritance diagram for sbIDeviceLibrary:

sbILibrary sbIMediaList sbIMediaItem sbILibraryResource List of all members.

Public Member Functions

void initialize (in AString aLibraryId)
 Initialize the device library.
void finalize ()
 Finalize the device library.
nsIArray getSyncPlaylistList ()
 Return the list of playlists the user wants to sync from the main library to the device.
void setSyncPlaylistList (in nsIArray aPlaylistList)
 Set the list of playlists the user wants to sync from the main library to the device.
void addToSyncPlaylistList (in sbIMediaList aPlaylist)
 Add a playlist to the list of playlists the user wants to sync from the main library to the device.
void sync ()
 Initiates a sync operation on this library.
void addDeviceLibraryListener (in sbIDeviceLibraryListener aListener)
 Add a listener to this device library.
void removeDeviceLibraryListener (in sbIDeviceLibraryListener aListener)
 Remove a listener from this device library.

Public Attributes

const unsigned long MGMT_TYPE_MANUAL = 0
 Manually manage device.
const unsigned long MGMT_TYPE_SYNC_ALL = 1
 Automatically synchronize all of library to device.
const unsigned long MGMT_TYPE_SYNC_PLAYLISTS = 2
 Automatically synchronize a list of playlsits to device.
attribute PRUint32 mgmtType
 The currently configured device management type preference for the device library.

Detailed Description

Note:
Implementations of this interface must be threadsafe.

Definition at line 210 of file sbIDeviceLibrary.idl.


Member Function Documentation

void sbIDeviceLibrary::initialize ( in AString  aLibraryId  ) 

Initialize the device library.

Parameters:
aLibraryId Device library identifier.

nsIArray sbIDeviceLibrary::getSyncPlaylistList (  ) 

Return the list of playlists the user wants to sync from the main library to the device.

Returns:
List of sbIMediaLists that represent the playlists to sync.

void sbIDeviceLibrary::setSyncPlaylistList ( in nsIArray  aPlaylistList  ) 

Set the list of playlists the user wants to sync from the main library to the device.

Parameters:
aPlaylistList List of sbIMediaLists that represent the playlists to sync.

void sbIDeviceLibrary::addToSyncPlaylistList ( in sbIMediaList  aPlaylist  ) 

Add a playlist to the list of playlists the user wants to sync from the main library to the device.

Parameters:
aPlaylist The playlist to add.

void sbIDeviceLibrary::sync (  ) 

Initiates a sync operation on this library.

This is a no-op if this library is in manual management mode.

void sbIDeviceLibrary::addDeviceLibraryListener ( in sbIDeviceLibraryListener  aListener  ) 

Add a listener to this device library.

Parameters:
sbIDeviceLibraryListener aListener listener to add.

void sbIDeviceLibrary::removeDeviceLibraryListener ( in sbIDeviceLibraryListener  aListener  ) 

Remove a listener from this device library.

Parameters:
sbIDeviceLibraryListener aListener listener to remove.


Member Data Documentation

attribute PRUint32 sbIDeviceLibrary::mgmtType

The currently configured device management type preference for the device library.

See also:
MGMT_TYPE_* constants

Definition at line 246 of file sbIDeviceLibrary.idl.


The documentation for this interface was generated from the following file:
Generated on Tue Mar 10 14:28:58 2009 for Songbird by  doxygen 1.5.2