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

Pending tags fetch handle. More...

#include "itagsfetcher.h"

Public Member Functions

virtual ~IPendingTagsFetch ()
 
virtual QObject * GetQObject ()=0
 Returns this object as a QObject. More...
 
virtual AudioInfo GetResult () const =0
 Returns the found audio metadata. More...
 

Protected Member Functions

virtual void ready (const QString &filename, const Media::AudioInfo &info)=0
 Emitted when the search result if ready and fetched. More...
 

Detailed Description

Pending tags fetch handle.

Interface to a pending tags fetch job. A descendant of this class is returned from ITagsFetcher::FetchTags() method.

This class has some signals (ready()), and one can use the GetQObject() method to get an object of this class as a QObject and connect to those signals.

Note
The object of this class should schedule its deletion (via QObject::deleteLater(), for example) after ready() signal is emitted. Thus the calling code should never delete it explicitly, neither it should use this object after ready() signal or connect to this signals via Qt::QueuedConnection.
See Also
ITagsFetcher

Definition at line 55 of file itagsfetcher.h.

Constructor & Destructor Documentation

virtual Media::IPendingTagsFetch::~IPendingTagsFetch ( )
inlinevirtual

Definition at line 58 of file itagsfetcher.h.

Member Function Documentation

virtual QObject* Media::IPendingTagsFetch::GetQObject ( )
pure virtual

Returns this object as a QObject.

This function can be used to connect to the signals of this class.

Returns
This object as a QObject.
virtual AudioInfo Media::IPendingTagsFetch::GetResult ( ) const
pure virtual

Returns the found audio metadata.

Returns the best matching audio info, if any, for the file this tags fetch job corresponds to.

Returns
The result of the tags fetching.
virtual void Media::IPendingTagsFetch::ready ( const QString &  filename,
const Media::AudioInfo info 
)
protectedpure virtual

Emitted when the search result if ready and fetched.

The object will be invalid after this signal is emitted and the event loop is run.

Parameters
[out]filenameThe filename this tags fetch job corresponds to.
[out]infoThe audio track metadata fetched for the filename.

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