AbstractEngine Class Reference

The AbstractEngine class provides the base interface class of audio audio engines. More...

#include <abstractengine.h>

Inherited by QmmpAudioEngine.

List of all members.

Signals

void playbackFinished ()

Public Member Functions

 AbstractEngine (QObject *parent=0)
virtual bool enqueue (InputSource *source)=0
virtual qint64 totalTime ()=0
virtual bool play ()=0
virtual void seek (qint64 time)=0
virtual void stop ()=0
virtual void pause ()=0
QMutex * mutex ()
QWaitCondition * cond ()
virtual void setEQ (double bands[10], double preamp)=0
virtual void setEQEnabled (bool on)=0

Static Public Member Functions

static QList< EngineFactory * > * factories ()
static EngineFactoryfindByPath (const QString &path)
static void setEnabled (EngineFactory *factory, bool enable=true)
static bool isEnabled (EngineFactory *factory)
static QStringList files ()


Detailed Description

The AbstractEngine class provides the base interface class of audio audio engines.

Author:
Ilya Kotov <forkotov02@hotmail.ru>

Constructor & Destructor Documentation

AbstractEngine::AbstractEngine ( QObject *  parent = 0  ) 

Object contsructor.

Parameters:
parent Parent object.


Member Function Documentation

QWaitCondition* AbstractEngine::cond (  ) 

Returns wait condition pointer.

virtual bool AbstractEngine::enqueue ( InputSource source  )  [pure virtual]

Prepares decoder for usage. Subclass should reimplement this function.

static QList<EngineFactory*>* AbstractEngine::factories (  )  [static]

Returns a list of decoder factories.

static QStringList AbstractEngine::files (  )  [static]

Returns a list of engine plugin files.

static EngineFactory* AbstractEngine::findByPath ( const QString &  path  )  [static]

Returns EngineFactory pointer which supports file path or 0 if file path is unsupported

static bool AbstractEngine::isEnabled ( EngineFactory factory  )  [static]

Returns true if engine is enabled, otherwise returns false

Parameters:
factory Engine plugin factory.

QMutex* AbstractEngine::mutex (  ) 

Returns mutex pointer.

virtual void AbstractEngine::pause (  )  [pure virtual]

Pauses/resumes playback

virtual bool AbstractEngine::play (  )  [pure virtual]

Starts playback. Returns true if playback has been started successful, otherwise returns false.

void AbstractEngine::playbackFinished (  )  [signal]

Emitted when the decoder has finished playback.

virtual void AbstractEngine::seek ( qint64  time  )  [pure virtual]

Requests a seek to the time time indicated, specified in milliseconds.

static void AbstractEngine::setEnabled ( EngineFactory factory,
bool  enable = true 
) [static]

Sets whether the engine is enabled.

Parameters:
factory Engine plugin factory.
enable Plugin enable state (true - enable, false - disable)

virtual void AbstractEngine::setEQ ( double  bands[10],
double  preamp 
) [pure virtual]

Sets equalizer settings. Each item of bands[] and reamp should be -20.0..20.0 Subclass should reimplement this function.

virtual void AbstractEngine::setEQEnabled ( bool  on  )  [pure virtual]

Enables equalizer if on is true or disables it if on is false Subclass should reimplement this function.

virtual void AbstractEngine::stop (  )  [pure virtual]

Requests playback to stop

virtual qint64 AbstractEngine::totalTime (  )  [pure virtual]

Returns the total time in milliseconds. Subclass should reimplement this function.


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

Generated on Sat Mar 27 19:43:00 2010 for Qmmp by  doxygen 1.5.9