LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Media::IAlbumArtProvider Class Referenceabstract

Interface for plugins that can search for album art. More...

#include "ialbumartprovider.h"

Public Member Functions

virtual ~IAlbumArtProvider ()
 
virtual QString GetAlbumArtProviderName () const =0
 Returns the human-readable name of this provider. More...
 
virtual void RequestAlbumArt (const AlbumInfo &album) const =0
 Initiates search for album art of the given album. More...
 

Protected Member Functions

virtual void gotAlbumArt (const AlbumInfo &album, const QList< QImage > &arts)=0
 Emitted when album art for the given album is available. More...
 

Detailed Description

Interface for plugins that can search for album art.

Plugins that can search for album art (like on Amazon or Last.FM) should implement this interface.

Album art lookup is asynchronous in nature: one first initiates a search via RequestAlbumArt() method and then listens for the gotAlbumArt() signal.

Definition at line 77 of file ialbumartprovider.h.

Constructor & Destructor Documentation

virtual Media::IAlbumArtProvider::~IAlbumArtProvider ( )
inlinevirtual

Definition at line 80 of file ialbumartprovider.h.

Member Function Documentation

virtual QString Media::IAlbumArtProvider::GetAlbumArtProviderName ( ) const
pure virtual

Returns the human-readable name of this provider.

Returns
The human-readable name of the provider, like Last.FM.
virtual void Media::IAlbumArtProvider::gotAlbumArt ( const AlbumInfo album,
const QList< QImage > &  arts 
)
protectedpure virtual

Emitted when album art for the given album is available.

This signal should be emitted by the implementation even if no album art is found for the given album.

Parameters
[in]albumThe album for which the album art is found.
[in]artsThe list of album covers that were found. The list may be empty.
virtual void Media::IAlbumArtProvider::RequestAlbumArt ( const AlbumInfo album) const
pure virtual

Initiates search for album art of the given album.

Parameters
[in]albumThe information about the album.

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