Effect Class Reference

The Effect class provides the base interface class of audio effects. More...

#include <effect.h>

Inherited by AudioConverter.

List of all members.

Public Member Functions

 Effect ()
virtual ~Effect ()
virtual void applyEffect (Buffer *b)=0
virtual void configure (quint32 srate=44100, int chan=2, Qmmp::AudioFormat f=Qmmp::PCM_S16LE)
quint32 sampleRate ()
int channels ()
Qmmp::AudioFormat format ()
const AudioParameters audioParameters () const
EffectFactoryfactory () const

Static Public Member Functions

static QList< Effect * > create ()
static QList< EffectFactory * > * factories ()
static QStringList files ()
static void setEnabled (EffectFactory *factory, bool enable=true)
static bool isEnabled (EffectFactory *factory)


Detailed Description

The Effect class provides the base interface class of audio effects.

Author:
Ilya Kotov <forkotov02@hotmail.ru>

Constructor & Destructor Documentation

Effect::Effect (  ) 

Object contsructor.

virtual Effect::~Effect (  )  [virtual]

Destructor.


Member Function Documentation

virtual void Effect::applyEffect ( Buffer b  )  [pure virtual]

Adds audio effect to the buffer b. Subclass should implement this function.

const AudioParameters Effect::audioParameters (  )  const

Returns audio parameters for output data.

int Effect::channels (  ) 

Returns channels number.

virtual void Effect::configure ( quint32  srate = 44100,
int  chan = 2,
Qmmp::AudioFormat  f = Qmmp::PCM_S16LE 
) [virtual]

Prepares object for usage. Subclasses that reimplement this function must call the base implementation.

Parameters:
srate Sample rate.
chan Number of channels.
f Audio format.

static QList<Effect*> Effect::create (  )  [static]

Creates a list of enabled effects.

static QList<EffectFactory*>* Effect::factories (  )  [static]

Returns a list of effect factories.

EffectFactory* Effect::factory (  )  const

Returns assigned factory object.

static QStringList Effect::files (  )  [static]

Returns a list of effect plugin file names.

Qmmp::AudioFormat Effect::format (  ) 

Returns audio format.

static bool Effect::isEnabled ( EffectFactory factory  )  [static]

Returns true if input plugin is enabled, otherwise returns false

Parameters:
factory Effect plugin factory.

quint32 Effect::sampleRate (  ) 

Returns samplerate.

static void Effect::setEnabled ( EffectFactory factory,
bool  enable = true 
) [static]

Sets whether the effect plugin is enabled.

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


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