Qmmp
Public Member Functions | Static Public Member Functions
AbstractEngine Class Reference

#include <abstractengine.h>

Inherited by QmmpAudioEngine.

List of all members.

Public Member Functions

 AbstractEngine (QObject *parent=0)
virtual ~AbstractEngine ()
virtual bool enqueue (InputSource *source)=0
virtual bool play ()=0
virtual void seek (qint64 time)=0
virtual void stop ()=0
virtual void pause ()=0
virtual void setMuted (bool muted)=0
QMutex * mutex ()

Static Public Member Functions

static AbstractEnginecreate (InputSource *s, QObject *parent=0)
static QList< EngineFactory * > factories ()
static QList< EngineFactory * > enabledFactories ()
static EngineFactoryfindByPath (const QString &path)
static void setEnabled (EngineFactory *factory, bool enable=true)
static bool isEnabled (EngineFactory *factory)
static QString file (EngineFactory *factory)
static QStringList protocols ()

Detailed Description

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

Author:
Ilya Kotov <forkotov02@hotmail.ru>

Constructor & Destructor Documentation

AbstractEngine ( QObject *  parent = 0)

Object contsructor.

Parameters:
parentParent object.
virtual ~AbstractEngine ( ) [virtual]

Destructor.


Member Function Documentation

static AbstractEngine* create ( InputSource s,
QObject *  parent = 0 
) [static]

Creates Engine object.

Parameters:
sInputSource object.
parentParent object. Returns 0 if the given source is not supported.
static QList<EngineFactory*> enabledFactories ( ) [static]

Returns a list of enabled engine factories.

virtual bool enqueue ( InputSource source) [pure virtual]

Prepares decoder for usage. Subclass should reimplement this function.

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

Returns a list of engine factories.

static QString file ( EngineFactory factory) [static]

Returns plugin file path.

Parameters:
factoryEngine plugin factory.
static EngineFactory* findByPath ( const QString &  path) [static]

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

static bool isEnabled ( EngineFactory factory) [static]

Returns true if engine is enabled, otherwise returns false

Parameters:
factoryEngine plugin factory.
QMutex* mutex ( )

Returns mutex pointer.

virtual void pause ( ) [pure virtual]

Pauses/resumes playback

virtual bool play ( ) [pure virtual]

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

static QStringList protocols ( ) [static]

Returns a list of supported protocols (including meta-protocols). This fuction ignores disabled engines.

virtual void seek ( qint64  time) [pure virtual]

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

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

Sets whether the engine is enabled.

Parameters:
factoryEngine plugin factory.
enablePlugin enable state (true - enable, false - disable)
virtual void setMuted ( bool  muted) [pure virtual]

Mutes/Restores volume. Subclass should reimplement this function.

Parameters:
mute- state of volume (true - mute, false - restore)
virtual void stop ( ) [pure virtual]

Requests playback to stop


The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator