LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
Public Types | Public Member Functions | List of all members
Media::IAlbumArtProvider Class Referenceabstract

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

#include "ialbumartprovider.h"

Public Types

using Result_t = LC::Util::Either< QString, QList< QUrl > >
 The result of an album art search query. More...
 

Public Member Functions

virtual ~IAlbumArtProvider ()
 
virtual QString GetAlbumArtProviderName () const =0
 Returns the human-readable name of this provider. More...
 
virtual QFuture< Result_t > RequestAlbumArt (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.

Definition at line 55 of file ialbumartprovider.h.

Member Typedef Documentation

◆ Result_t

using Media::IAlbumArtProvider::Result_t = LC::Util::Either<QString, QList<QUrl> >

The result of an album art search query.

The result of an album art search query is either a string with a human-readable error text, or a list of URLs matching the album art.

Definition at line 65 of file ialbumartprovider.h.

Constructor & Destructor Documentation

◆ ~IAlbumArtProvider()

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

Definition at line 58 of file ialbumartprovider.h.

Member Function Documentation

◆ GetAlbumArtProviderName()

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.

◆ RequestAlbumArt()

virtual QFuture<Result_t> 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 future with the album art search result.

Parameters
[in]albumThe description of the album.
Returns
The future with the album art search result.
The documentation for this class was generated from the following file: