Media::IAudioPile Class Reference

Interface for plugins supporting searching for tracks. More...

#include "iaudiopile.h"

Classes
struct	Result
	A structure describing a single entry in search result. More...

Public Types
using	Results_t = QList< Result >
	A list of successful audio search results. More...
using	Result_t = LC::Util::Either< QString, Results_t >
	The result of an audio search query. More...

Public Member Functions
virtual	~IAudioPile ()
virtual QString	GetServiceName () const =0
	Returns the name of this service. More...
virtual QIcon	GetServiceIcon () const =0
	Returns the icon of this service. More...
virtual QFuture< Result_t >	Search (const AudioSearchRequest &request)=0
	Requests a search by the given request. More...

Detailed Description

Interface for plugins supporting searching for tracks.

Plugins that support searching for audio tracks in huge loosely categorized audio collections like VKontakte should implement this interface.

Definition at line 70 of file iaudiopile.h.

Member Typedef Documentation

Result_t

using Media::IAudioPile::Result_t = LC::Util::Either<QString, Results_t>

The result of an audio search query.

The result of an audio search query is either a string with a human-readable error text, or a list of result items.

See also

Results_t

Definition at line 99 of file iaudiopile.h.

Results_t

using Media::IAudioPile::Results_t = QList<Result>

A list of successful audio search results.

Definition at line 90 of file iaudiopile.h.

Constructor & Destructor Documentation

~IAudioPile()

virtual Media::IAudioPile::~IAudioPile ( )

inlinevirtual

Definition at line 73 of file iaudiopile.h.

Member Function Documentation

GetServiceIcon()

virtual QIcon Media::IAudioPile::GetServiceIcon ( ) const

pure virtual

Returns the icon of this service.

This function returns the icon of the service this IAudioPile represents.

Returns

The service icon.

GetServiceName()

virtual QString Media::IAudioPile::GetServiceName ( ) const

pure virtual

Returns the name of this service.

This function returns the name of the service this IAudioPile represents, like "VKontakte".

Returns

The well-known service name.

Search()

virtual QFuture<Result_t> Media::IAudioPile::Search ( const AudioSearchRequest &  request )

pure virtual

Requests a search by the given request.

This function initiates a search by the given request and returns a future with the search results.

Parameters

[in]

request

The structure describing the search request.

Returns

The future with the audio search results.

---

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

• /home/d34df00d/leechcraft/src/interfaces/media/iaudiopile.h