# class Effect

###

Module | phonon
Namespace | Phonon
Class | Effect
Inherits | QObject,Phonon::MediaNode

\class Effect effect.h Phonon/Effect 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>

### methods

- Effect (description, parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  description | Phonon.EffectDescription |
  parent | QObject | 0

  QObject constructor.

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

  parent - QObject parent

- Effect (dd, parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  dd | EffectPrivate |
  parent | QObject |

- description ( )

  returns Phonon.EffectDescription

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

- parameterValue (a0)

  returns QVariant

  Argument | Type | Default
  --- | --- | ---
  a0 | Phonon.EffectParameter |

- parameters ( )

  returns QList<Phonon::EffectParameter>

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

  See also EffectParameter

  See also EffectWidget

- setParameterValue (a0, value)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  a0 | Phonon.EffectParameter |
  value | QVariant |