LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
Media::ILyricsFinder Class Referenceabstract

Interface for plugins supporting finding lyrics. More...

#include "ilyricsfinder.h"

Public Types

using LyricsQueryResult_t = LC::Util::Either< QString, LyricsResults >
 The result of a lyrics search query. More...
 

Public Member Functions

virtual ~ILyricsFinder ()
 
virtual QFuture< LyricsQueryResult_tRequestLyrics (const LyricsQuery &query)=0
 Requests searching for lyrics for the given query. More...
 

Detailed Description

Interface for plugins supporting finding lyrics.

Plugins that support searching for lyrics should implement this interface.

Definition at line 76 of file ilyricsfinder.h.

Member Typedef Documentation

◆ LyricsQueryResult_t

The result of a lyrics search query.

The result of a lyrics search query is either a string with a human-readable error text, or a LyricsResults object.

See also
LyricsResults

Definition at line 88 of file ilyricsfinder.h.

Constructor & Destructor Documentation

◆ ~ILyricsFinder()

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

Definition at line 79 of file ilyricsfinder.h.

Member Function Documentation

◆ RequestLyrics()

virtual QFuture<LyricsQueryResult_t> Media::ILyricsFinder::RequestLyrics ( const LyricsQuery query)
pure virtual

Requests searching for lyrics for the given query.

The returned future potentially provides multiple results.

Parameters
[in]queryThe lyrics query.
Returns
The future (potentially providing multiple results) with the search results.

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