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

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

#include "iaudiopile.h"

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 IPendingAudioSearchSearch (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 168 of file iaudiopile.h.

Constructor & Destructor Documentation

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

Definition at line 171 of file iaudiopile.h.

References Q_DECLARE_INTERFACE().

+ Here is the call graph for this function:

Member Function Documentation

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.
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.
virtual IPendingAudioSearch* 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 handle that can be used to track the search result state. The handle owns itself and deletes itself after the results are available — see its documentation for details.

Parameters
[in]requestThe structure describing the search request.
Returns
The pending audio search handle.

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