Phonon

Phonon::Effect

Effect Class Reference
[Effects]

#include <Phonon/Effect>

Inheritance diagram for Effect:

[legend]

List of all members.

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@kde.org>


Public Member Functions
	Effect (const EffectDescription &description, QObject *parent=0)
EffectDescription	description () const
QList< EffectParameter >	parameters () const

Constructor & Destructor Documentation

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 description ( ) const

Returns the description of this effect.

This is the same type as was passed to the constructor.

QList<EffectParameter> 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 file:

effect.h

Phonon

Effect Class Reference [Effects]

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Phonon

kdelibs

Effect Class Reference
[Effects]