Qmmp
Loading...
Searching...
No Matches
Public Member Functions | List of all members
EngineFactory Class Referenceabstract

#include <enginefactory.h>

Public Member Functions

virtual ~EngineFactory ()
 
virtual bool supports (const QString &source) const =0
 
virtual EngineProperties properties () const =0
 
virtual AbstractEnginecreate (QObject *parent=nullptr)=0
 
virtual QList< TrackInfo * > createPlayList (const QString &fileName, TrackInfo::Parts parts, QStringList *ignoredPaths)=0
 
virtual MetaDataModelcreateMetaDataModel (const QString &path, bool readOnly)=0
 
virtual void showSettings (QWidget *parent)=0
 
virtual void showAbout (QWidget *parent)=0
 
virtual QString translation () const =0
 

Detailed Description

Engine plugin interface.

Author
Ilya Kotov forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Constructor & Destructor Documentation

◆ ~EngineFactory()

virtual ~EngineFactory ( )
inlinevirtual

Object destructor.

Member Function Documentation

◆ create()

virtual AbstractEngine * create ( QObject * parent = nullptr)
pure virtual

Creates engine object.

Parameters
parentParent object File path

◆ createMetaDataModel()

virtual MetaDataModel * createMetaDataModel ( const QString & path,
bool readOnly )
pure virtual

Creats metadata object, which provides full access to file tags.

Parameters
pathFile path.
readOnlyOpen file in read-only mode (true - enabled, false - disable).
Returns
MetaDataModel pointer.

◆ createPlayList()

virtual QList< TrackInfo * > createPlayList ( const QString & fileName,
TrackInfo::Parts parts,
QStringList * ignoredPaths )
pure virtual

Extracts metadata and audio information from file path and returns a list of FileInfo items. One file may contain several playlist items (for example: cda disk or flac with embedded cue).

Parameters
fileNameFile path.
ignoredPathsPointer to a list of the files which should be ignored by the recursive search.
partsparts of metadata which should be extracted from file. (useful to exclude cue data files from playlist).

◆ properties()

virtual EngineProperties properties ( ) const
pure virtual

Returns general plugin properties.

◆ showAbout()

virtual void showAbout ( QWidget * parent)
pure virtual

Shows about dialog.

Parameters
parentParent widget.

◆ showSettings()

virtual void showSettings ( QWidget * parent)
pure virtual

Shows settings dialog.

Parameters
parentParent widget.

◆ supports()

virtual bool supports ( const QString & source) const
pure virtual

Returns true if plugin supports source, otherwise returns false

◆ translation()

virtual QString translation ( ) const
pure virtual

Returns translation file path without locale code and extension


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