LeechCraft  %{LEECHCRAFT_VERSION}
Modular cross-platform feature rich live environment.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules 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 IPendingAlbumArtRequestAlbumArt (const AlbumInfo &album) const =0
 Initiates search for album art of the given album. 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 96 of file ialbumartprovider.h.

Constructor & Destructor Documentation

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

Definition at line 99 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 IPendingAlbumArt* Media::IAlbumArtProvider::RequestAlbumArt ( const AlbumInfo album) const
pure virtual

Initiates search for album art of the given album.

This function initiates searching for the album art of the given album and returns a search proxy that can be used to be notified when the search finishes.

Parameters
[in]albumThe information about the album.
Returns
The pending search object that will emit IPendingAlbumArt::ready() signal once ready.

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