Effect Class Reference

#include <effect.h>

Inherited by ChannelConverter, Dithering, and ReplayGain.

List of all members.

Public Member Functions
	Effect ()
virtual	~Effect ()
virtual void	applyEffect (Buffer *b)=0
virtual void	configure (quint32 srate, ChannelMap map)
quint32	sampleRate () const
int	channels () const
const ChannelMap	channelMap () const
const AudioParameters	audioParameters () const
EffectFactory *	factory () const
Static Public Member Functions
static Effect *	create (EffectFactory *factory)
static QList< EffectFactory * >	factories ()
static QList< EffectFactory * >	enabledFactories ()
static QString	file (EffectFactory *factory)
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

(

)

Object contsructor.

virtual ~Effect

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void applyEffect

(

Buffer *

b

)

[pure virtual]

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

const AudioParameters audioParameters

(

)

const

Returns audio parameters for output data.

const ChannelMap channelMap

(

)

const

Returns map of channels

int channels

(

)

const

Returns channels number.

virtual void configure	(	quint32	srate,
		ChannelMap	map
	)		[virtual]

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

Parameters:

srate	Sample rate.
map	Map of channels.

static Effect* create

(

EffectFactory *

factory

)

[static]

Creates effect object from factory. Returns effect objects if factory is enabled, otherwise returns 0.

static QList<EffectFactory*> enabledFactories

(

)

[static]

Returns a list of enabled effect factories.

static QList<EffectFactory*> factories

(

)

[static]

Returns a list of effect factories.

EffectFactory* factory

(

)

const

Returns assigned factory object.

static QString file

(

EffectFactory *

factory

)

[static]

Returns plugin file path.

Parameters:

factory

Effect plugin factory.

static bool isEnabled

(

EffectFactory *

factory

)

[static]

Returns true if input plugin is enabled, otherwise returns false

Parameters:

factory

Effect plugin factory.

quint32 sampleRate

(

)

const

Returns samplerate.

static void 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:

• /usr/src/RPM/BUILD/qmmp-0.11-svn/src/qmmp/effect.h