Effect Class Reference

#include <effect.h>

Inherited by ChannelConverter, Dithering, and ReplayGain.

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 (const EffectFactory *factory)
static void	setEnabled (EffectFactory *factory, bool enable=true)
static bool	isEnabled (const EffectFactory *factory)
static EffectFactory *	findFactory (const QString &shortName)

Detailed Description

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

Author

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

Constructor & Destructor Documentation

Effect()

Effect

(

)

Object contsructor.

~Effect()

virtual ~Effect ( )

virtual

Destructor.

Member Function Documentation

applyEffect()

virtual void applyEffect ( Buffer *  b )

pure virtual

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

audioParameters()

const AudioParameters audioParameters

(

)

const

Returns audio parameters for output data.

channelMap()

const ChannelMap channelMap

(

)

const

Returns map of channels

channels()

int channels

(

)

const

Returns channels number.

configure()

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.

create()

static Effect* create ( EffectFactory *  factory )

static

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

enabledFactories()

static QList<EffectFactory*> enabledFactories ( )

static

Returns a list of enabled effect factories.

factories()

static QList<EffectFactory*> factories ( )

static

Returns a list of effect factories.

factory()

EffectFactory* factory

(

)

const

Returns assigned factory object.

file()

static QString file ( const EffectFactory *  factory )

static

Returns plugin file path.

Parameters

factory

Effect plugin factory.

findFactory()

static EffectFactory* findFactory ( const QString &  shortName )

static

Finds effect factory object by short name shortName. Returns effect factory pointer. If no match is found, 0 is returned. The search is case sensitive.

isEnabled()

static bool isEnabled ( const EffectFactory *  factory )

static

Returns true if input plugin is enabled, otherwise returns false

Parameters

factory

Effect plugin factory.

sampleRate()

quint32 sampleRate

(

)

const

Returns samplerate.

setEnabled()

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-2.1.5/src/qmmp/effect.h