#include <Phonon/Effect>

Class 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

Definition at line 65 of file effect.h.

Inheritance diagram for Effect:

Public Member Functions
	~Effect ()

	Effect (const EffectDescription &description, QObject *parent=0)
	QObject constructor. More...

EffectDescription	description () const
	Returns the description of this effect. More...

QList< EffectParameter >	parameters () const
	Returns a list of parameters that this effect provides to control its behaviour. More...

QVariant	parameterValue (const EffectParameter &) const

void	setParameterValue (const EffectParameter &, const QVariant &value)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=0)

virtual	~QObject ()

virtual bool	event (QEvent *)

virtual bool	eventFilter (QObject , QEvent )

QString	objectName () const

void	setObjectName (const QString &name)

bool	isWidgetType () const

bool	signalsBlocked () const

bool	blockSignals (bool b)

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

const QObjectList &	children () const

void	setParent (QObject *)

void	installEventFilter (QObject *)

void	removeEventFilter (QObject *)

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectTree ()

void	dumpObjectInfo ()

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

void	setUserData (uint id, QObjectUserData *data)

QObjectUserData *	userData (uint id) const

QObject *	parent () const

bool	inherits (const char *classname) const

Public Member Functions inherited from MediaNode
virtual	~MediaNode ()

bool	isValid () const
	Tells whether the backend provides an implementation of this class. More...

QList< Path >	inputPaths () const

QList< Path >	outputPaths () const

Protected Member Functions
	Effect (EffectPrivate &dd, QObject *parent)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

virtual void	timerEvent (QTimerEvent *)

virtual void	childEvent (QChildEvent *)

virtual void	customEvent (QEvent *)

virtual void	connectNotify (const char *signal)

virtual void	disconnectNotify (const char *signal)

	QObject (QObjectPrivate &dd, QObject *parent=0)

Protected Member Functions inherited from MediaNode
	MediaNode (MediaNodePrivate &dd)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QObject
void	destroyed (QObject *=0)

Static Public Member Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from MediaNode
MediaNodePrivate *const	k_ptr

Static Protected Attributes inherited from QObject
static const QMetaObject	staticQtMetaObject

Properties inherited from QObject
QString	objectName

Constructor & Destructor Documentation

~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

Effect	(	EffectPrivate &	dd,
		QObject *	parent
	)

protected

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

QVariant parameterValue ( const EffectParameter & ) const

void setParameterValue	(	const EffectParameter &	,
		const QVariant &	value
	)

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

phonon/effect.h

Effect Class Reference

Class Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation