Songbird / Development / Songbird Add-Ons API Documentation

sbIAlbumArtListener Interface Reference

A component which is interested in the result of an album art fetch request. More...

import "sbIAlbumArtListener.idl";

List of all members.

Public Member Functions

void onChangeFetcher (in sbIAlbumArtFetcher aFetcher)
 onChangeFetcher - Notifies the listener when the fetcher being used has changed. This is used from the sbIAlbumArtFetcherSet component.
void onResult (in nsIURI aImageLocation, in sbIMediaItem aMediaItem)
 onResult - Notifies the listener when either an image has or has not been found. aImageLocation will be null if the operation failed to get artwork.
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.
void onAlbumComplete (in nsIArray aMediaItems)
 onAlbumComplete - Notifies the listener that the search for artwork for an album has been completed. This is fired even if there is only one item in the list.


Detailed Description

A component which is interested in the result of an album art fetch request.

See also:
sbIAlbumArtFetcher

sbIAlbumArtFetcherSet

Definition at line 53 of file sbIAlbumArtListener.idl.


Member Function Documentation

void sbIAlbumArtListener::onChangeFetcher ( in sbIAlbumArtFetcher  aFetcher  ) 

onChangeFetcher - Notifies the listener when the fetcher being used has changed. This is used from the sbIAlbumArtFetcherSet component.

Parameters:
aFetcher - Fetcher that has been changed to.

void sbIAlbumArtListener::onResult ( in nsIURI  aImageLocation,
in sbIMediaItem  aMediaItem 
)

onResult - Notifies the listener when either an image has or has not been found. aImageLocation will be null if the operation failed to get artwork.

Parameters:
aImageLocation - uri of the image location, this can be a file, http, or other.
aMediaItem - The media item that the result is for.

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

Parameters:
aImageLocation - uri of the image location, this can be a file, http, or other.
aMediaItems - A list of the media items that the result is for.

void sbIAlbumArtListener::onAlbumComplete ( in nsIArray  aMediaItems  ) 

onAlbumComplete - Notifies the listener that the search for artwork for an album has been completed. This is fired even if there is only one item in the list.

Parameters:
aMediaItems - A list of the media items that the result is for.


The documentation for this interface was generated from the following file:
Generated on Fri Feb 6 15:18:40 2009 for Songbird by  doxygen 1.5.2