|  | Home · All Classes · Modules

# Phonon.Effect Class Reference
[phonon module]

The Effect class is used to transform audio streams. More...

Inherits QObject and MediaNode.

### Methods

- __init__ (self, EffectDescription, QObject parent = None)
- EffectDescription description (self)
- QList<Phonon::EffectParameter>list-of-Phonon.EffectParameter parameters (self)
- QVariantQVariant parameterValue (self, EffectParameter)
- setParameterValue (self, EffectParameter, QVariantQVariant)

## Detailed Description

The Effect class is used to transform audio streams.

An effect is a media node which is inserted into a path between a MediaObject and an audio output node, for instance, an AudioOutput. The Effect transforms the media stream on that path.

Examples may include simple modifiers, such as fading or pitch shifting, and more complex mathematical transformations. You can query the backend for available effects with BackendCapabilities.availableAudioEffects(). Note that the effects available is dependent on the underlying system (DirectDraw, GStreamer, or QuickTime).

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.

To create an effect, you use the EffectDescription class, which you get from availableAudioEffects(). We give a code example below.

         QList<Phonon.EffectDescription> effectDescriptions =
                 Phonon.BackendCapabilities.availableAudioEffects();
         Phonon.EffectDescription effectDescription = effectDescriptions.at(4);

         Phonon.Path path = Phonon.createPath(mediaObject, audioOutput);

         Phonon.Effect *effect = new Phonon.Effect(effectDescription);
         path.insertEffect(effect);

An effect can have one or more parameters, which let you alter how the effect works, for instance, by specifying the depth of a reverb effect. See the EffectParameter class description for details.

Phonon also provides EffectWidget, which lets the user modify the parameters of an effect an the fly; e.g., with combo boxes.

See also Phonon Module and EffectWidget.

## Method Documentation

### Effect.__init__ (self, EffectDescription, QObject parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a new effect object with the given description and parent object.

The EffectDescription object determines the type of the effect.

See also Phonon.BackendCapabilities.availableAudioEffects().

### EffectDescription Effect.description (self)

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

### QList<Phonon::EffectParameter>list-of-Phonon.EffectParameter Effect.parameters (self)

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

See also EffectParameter and EffectWidget.

### QVariantQVariant Effect.parameterValue (self, EffectParameter)

Returns the value of the given effect parameter. You can fetch the available parameters for an effect with parameters().

See also setParameterValue() and EffectParameter.

### Effect.setParameterValue (self, EffectParameter, QVariantQVariant)

Sets the given effect parameter to the specified value.

Parameters for an effect are returned by parameters(). You can check which QVariant.Type an EffectParameter takes with the EffectParameter.type() function.

See also parameterValue() and EffectParameter.