LeechCraft  0.6.70-10870-g558588d6ec
Modular cross-platform feature rich live environment.
Media::IAudioPile Class Referenceabstract

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 >
 
using AudioSearchResult_t = LeechCraft::Util::Either< QString, Results_t >
 

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< AudioSearchResult_tSearch (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 91 of file iaudiopile.h.

Member Typedef Documentation

◆ AudioSearchResult_t

◆ Results_t

Definition at line 109 of file iaudiopile.h.

Constructor & Destructor Documentation

◆ ~IAudioPile()

virtual Media::IAudioPile::~IAudioPile ( )
inlinevirtual

Definition at line 94 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<AudioSearchResult_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]requestThe structure describing the search request.
Returns
The future with the audio search results.

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