Songbird / Development / Songbird Add-Ons API Documentation

sbIAlbumArtFetcher Interface Reference

Interface for an album art fetcher. Instantiate as a component instance. More...

import "sbIAlbumArtFetcher.idl";

Inheritance diagram for sbIAlbumArtFetcher:

sbIAlbumArtFetcherSet List of all members.

Public Member Functions

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.
void fetchAlbumArtForTrack (in sbIMediaItem aMediaItem, in sbIAlbumArtListener aListener)
 Try to fetch album art for a single track.

Public Attributes

readonly attribute AString shortName
 Short name of AlbumArtFetcher.
readonly attribute AString name
 Name of AlbumArtFetcher to display to the user on things like menus.
readonly attribute AString description
 Description of the AlbumArtFetcher to display to the user.
readonly attribute boolean isLocal
 Flag to indicate if this Fetcher fetches from local sources.
attribute boolean isEnabled
 Flag to indicate if this Fetcher is enabled or not.
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).
attribute nsIArray albumArtSourceList
 List of sources of album art (e.g., sbIMetadataHandler).

Detailed Description

Interface for an album art fetcher. Instantiate as a component instance.

See also:
sbIAlbumArtListener

Definition at line 53 of file sbIAlbumArtFetcher.idl.


Member Function Documentation

void sbIAlbumArtFetcher::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.

Parameters:
aMediaItems is an array of sbIMediaItems from the same album
aListener the listener to inform of success or failure

void sbIAlbumArtFetcher::fetchAlbumArtForTrack ( in sbIMediaItem  aMediaItem,
in sbIAlbumArtListener  aListener 
)

Try to fetch album art for a single track.

Parameters:
aMediaItem is an sbIMediaItem to scan for artwork.
aListener the listener to inform of success or failure


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