sbAlbumArtFetcherSet Class Reference

#include <sbAlbumArtFetcherSet.h>

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

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_SBIALBUMARTFETCHER
NS_DECL_SBIALBUMARTFETCHERSET
NS_DECL_NSITIMERCALLBACK
NS_DECL_SBIALBUMARTLISTENER 
sbAlbumArtFetcherSet ()
 
virtual ~sbAlbumArtFetcherSet ()
 
nsresult Initialize ()
 
- Public Member Functions inherited from sbIAlbumArtFetcher
void fetchAlbumArtForAlbum (in nsIArray aMediaItems, in sbIAlbumArtListener aListener)
 Try to fetch album art for a list of items that belong to the same album. This function infers that all items in the list are from the same album. More...
 
void fetchAlbumArtForTrack (in sbIMediaItem aMediaItem, in sbIAlbumArtListener aListener)
 Try to fetch album art for a single track. More...
 
void shutdown ()
 
- Public Member Functions inherited from sbIAlbumArtListener
void onChangeFetcher (in sbIAlbumArtFetcher aFetcher)
 onChangeFetcher - Notifies the listener when the fetcher being used has changed. This is used from the sbIAlbumArtFetcherSet component. More...
 
void onTrackResult (in nsIURI aImageLocation, in sbIMediaItem aMediaItem)
 onTrackResult - Notifies the listener when either an image has or has not been found. aImageLocation will be null if the operation failed to get artwork. More...
 
void onAlbumResult (in nsIURI aImageLocation, in nsIArray aMediaItems)
 onAlbumResult - Notifies the listener when either an image has or has not been found for a list of items. aImageLocation will be null if the operation failed to get artwork. More...
 
void onSearchComplete (in nsIArray aMediaItems)
 onSearchComplete - Notifies the listener that the search for artwork has been completed. More...
 

Additional Inherited Members

- Public Attributes inherited from sbIAlbumArtFetcherSet
const unsigned long TYPE_ALL = 0x00
 
const unsigned long TYPE_REMOTE = 0x01
 
const unsigned long TYPE_LOCAL = 0x02
 
attribute unsigned long fetcherType
 Type of fetchers in the set (local, remote, both) More...
 
- Public Attributes inherited from sbIAlbumArtFetcher
readonly attribute AString shortName
 Short name of AlbumArtFetcher. More...
 
readonly attribute AString name
 Name of AlbumArtFetcher to display to the user on things like menus. More...
 
readonly attribute AString description
 Description of the AlbumArtFetcher to display to the user. More...
 
readonly attribute boolean isLocal
 Flag to indicate if this Fetcher fetches from local sources. More...
 
attribute boolean isEnabled
 Flag to indicate if this Fetcher is enabled or not. More...
 
attribute PRInt32 priority
 Priority of this fetcher, a lower number represents a higher priority (so 0 is higher than 10). If multiple fetchers have the same priority then it is first come first serve at that priority. The priorities should not fall below 0 except where a priority of -1 will mean to append to end of list (so it will be the lowest priority). More...
 
attribute nsIArray albumArtSourceList
 List of sources of album art (e.g., sbIMetadataHandler). More...
 
readonly attribute boolean isFetching
 Flag to indicate if this fetcher is currently fetching. More...
 

Detailed Description

This class implements the album art fetcher set component.

Definition at line 101 of file sbAlbumArtFetcherSet.h.

Constructor & Destructor Documentation

sbAlbumArtFetcherSet::sbAlbumArtFetcherSet ( )

Construct an album art fetcher set instance.

Definition at line 395 of file sbAlbumArtFetcherSet.cpp.

sbAlbumArtFetcherSet::~sbAlbumArtFetcherSet ( )
virtual

Destroy an album art fetcher set instance.

Definition at line 421 of file sbAlbumArtFetcherSet.cpp.

Member Function Documentation

nsresult sbAlbumArtFetcherSet::Initialize ( )

Initialize the album art fetcher set.

Definition at line 436 of file sbAlbumArtFetcherSet.cpp.

Here is the call graph for this function:


The documentation for this class was generated from the following files: