sbIAlbumArtFetcher Interface Reference

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

import"sbIAlbumArtFetcher.idl";

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

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

Public Attributes

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

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

See Also
sbIAlbumArtListener

Definition at line 51 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
aMediaItemsis an array of sbIMediaItems from the same album
aListenerthe 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
aMediaItemis an sbIMediaItem to scan for artwork.
aListenerthe listener to inform of success or failure
void sbIAlbumArtFetcher::shutdown ( )

Member Data Documentation

attribute nsIArray sbIAlbumArtFetcher::albumArtSourceList

List of sources of album art (e.g., sbIMetadataHandler).

Definition at line 92 of file sbIAlbumArtFetcher.idl.

readonly attribute AString sbIAlbumArtFetcher::description

Description of the AlbumArtFetcher to display to the user.

Definition at line 67 of file sbIAlbumArtFetcher.idl.

attribute boolean sbIAlbumArtFetcher::isEnabled

Flag to indicate if this Fetcher is enabled or not.

Definition at line 77 of file sbIAlbumArtFetcher.idl.

readonly attribute boolean sbIAlbumArtFetcher::isFetching

Flag to indicate if this fetcher is currently fetching.

Definition at line 97 of file sbIAlbumArtFetcher.idl.

readonly attribute boolean sbIAlbumArtFetcher::isLocal

Flag to indicate if this Fetcher fetches from local sources.

Definition at line 72 of file sbIAlbumArtFetcher.idl.

readonly attribute AString sbIAlbumArtFetcher::name

Name of AlbumArtFetcher to display to the user on things like menus.

Definition at line 62 of file sbIAlbumArtFetcher.idl.

attribute PRInt32 sbIAlbumArtFetcher::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).

Definition at line 87 of file sbIAlbumArtFetcher.idl.

readonly attribute AString sbIAlbumArtFetcher::shortName

Short name of AlbumArtFetcher.

Definition at line 56 of file sbIAlbumArtFetcher.idl.


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