Phonon::Effect Class Reference

Effects that can be inserted into a Path. An effect is a special object which can perform transformations on the specified path. Examples may include simple modifiers such as fading or pitch shifting, or more complex mathematical transformations. More...

#include <phonon/Effect>

Inheritance diagram for Phonon::Effect:

Public Member Functions
	Effect (const EffectDescription &description, QObject *parent=0)
EffectDescription	description () const
QList< EffectParameter >	parameters () const
QVariant	parameterValue (const EffectParameter &) const
void	setParameterValue (const EffectParameter &, const QVariant &value)
Public Member Functions inherited from Phonon::MediaNode
bool	isValid () const
QList< Path >	inputPaths () const
QList< Path >	outputPaths () const

Protected Member Functions
	Effect (EffectPrivate &dd, QObject *parent)
Protected Member Functions inherited from Phonon::MediaNode
	MediaNode (MediaNodePrivate &dd)

Additional Inherited Members
Protected Attributes inherited from Phonon::MediaNode
MediaNodePrivate *const	k_ptr

Detailed Description

Effects that can be inserted into a Path. An effect is a special object which can perform transformations on the specified path. Examples may include simple modifiers such as fading or pitch shifting, or more complex mathematical transformations.

In order to use an effect, insert it into the path as follows:

Path path = Phonon::createPath(...);
Effect *effect = new Effect(this);
path.insertEffect(effect);

The effect will immediately begin applying it's transformations on the path. To stop it, remove the Effect from the path.

Author

Matthias Kretz kretz.nosp@m.@kde.nosp@m..org

Constructor & Destructor Documentation

Phonon::Effect::Effect ( const EffectDescription &  description, QObject *  parent = 0  )

explicit

QObject constructor.

Parameters

description	An EffectDescription object to determine the type of effect. See BackendCapabilities::availableAudioEffects().
parent	QObject parent

Member Function Documentation

EffectDescription Phonon::Effect::description

(

)

const

Returns the description of this effect. This is the same type as was passed to the constructor.

QList< EffectParameter > Phonon::Effect::parameters

(

)

const

Returns a list of parameters that this effect provides to control its behaviour.

See Also

EffectParameter

EffectWidget

---

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

• /home/me/src/git/p/phonon/phonon/effect.h
• /home/me/src/git/p/phonon/phonon/effect.cpp