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

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

#include "iaudiopile.h"

Public Member Functions

virtual ~IAudioPile ()
 
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 167 of file iaudiopile.h.

Constructor & Destructor Documentation

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

Definition at line 170 of file iaudiopile.h.

Member Function Documentation

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: