sbIAlbumArtFetcherSet Interface Reference

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

import"sbIAlbumArtFetcherSet.idl";

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

Public Attributes

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...
 

Additional Inherited Members

- 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 ()
 

Detailed Description

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

An album art fetcher set may be used to fetch album art from multiple sources. This interface will obtain an ordered set of album art fetchers and call each fetcher in succession until one successfully fetches album art.

See Also
sbIAlbumArtFetcher

Definition at line 54 of file sbIAlbumArtFetcherSet.idl.

Member Data Documentation

attribute unsigned long sbIAlbumArtFetcherSet::fetcherType

Type of fetchers in the set (local, remote, both)

Definition at line 63 of file sbIAlbumArtFetcherSet.idl.

const unsigned long sbIAlbumArtFetcherSet::TYPE_ALL = 0x00

Definition at line 56 of file sbIAlbumArtFetcherSet.idl.

const unsigned long sbIAlbumArtFetcherSet::TYPE_LOCAL = 0x02

Definition at line 58 of file sbIAlbumArtFetcherSet.idl.

const unsigned long sbIAlbumArtFetcherSet::TYPE_REMOTE = 0x01

Definition at line 57 of file sbIAlbumArtFetcherSet.idl.


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