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

Interface for plugins supporting finding lyrics. More...

#include "ilyricsfinder.h"

Public Member Functions

virtual ~ILyricsFinder ()
 
virtual void RequestLyrics (const LyricsQuery &query, QueryOptions options=NoOption)=0
 Requests searching for lyrics for the given query. More...
 

Protected Member Functions

virtual void gotLyrics (const LyricsQuery &query, const QStringList &lyrics)=0
 Emitted when search for lyrics is complete. More...
 

Detailed Description

Interface for plugins supporting finding lyrics.

Plugins that support searching for lyrics should implement this interface.

Fetching lyrics is asynchronous in nature, so one should request fetching the lyrics via RequestLyrics() method and wait for the gotLyrics() signal with the corresponding query parameter.

Todo:
Consider migrating to handle-based results, like for IArtistBioFetcher.

Definition at line 105 of file ilyricsfinder.h.

Constructor & Destructor Documentation

virtual Media::ILyricsFinder::~ILyricsFinder ( )
inlinevirtual

Definition at line 108 of file ilyricsfinder.h.

Member Function Documentation

virtual void Media::ILyricsFinder::gotLyrics ( const LyricsQuery query,
const QStringList &  lyrics 
)
protectedpure virtual

Emitted when search for lyrics is complete.

Parameters
[out]queryThe query for which the search is complete.
[out]lyricsThe list of possible lyrics variants, may be empty or contain duplicates.
virtual void Media::ILyricsFinder::RequestLyrics ( const LyricsQuery query,
QueryOptions  options = NoOption 
)
pure virtual

Requests searching for lyrics for the given query.

Parameters
[in]queryThe lyrics query.
[in]optionsAdditional search options.

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