Path Class Reference
(Phonon::Path)
[Phonon module]

Effect * Path::insertEffect ( const EffectDescription & desc, Effect * insertBefore = 0 )

Creates and inserts an effect into the path.

You may insert effects of the same class as often as you like, but if you insert the same object, the call will fail.

desc is the EffectDescription object for the effect to be inserted.

If you already inserted an effect you can tell with insertBefore in which order the data gets processed. If this is 0 the effect is appended at the end of the processing list. If the effect has not been inserted before the method will do nothing and return false.

Returns a pointer to the effect object if it could be inserted at the specified position. If 0 is returned, the effect was not inserted.

Below is a code example for inserting an effect into a path:

     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);

See also removeEffect() and effects().

bool Path::insertEffect ( Effect * effect, Effect * insertBefore = 0 )

Inserts the given effect into the path before the effect specified by insertBefore and returns true if successful; otherwise returns false.

If insertBefore is zero, the effect is appended to the processing list.

You may insert effects of the same class as often as you like, but if you insert the same object, the call will fail.

effect will be inserted right before insertBefore. If insertBefore is 0, the effect is appended at the end of the processing list. If the effect has not been inserted before the method will do nothing and return false.

Returns whether the effect could be inserted at the specified position. If false is returned the effect was not inserted.

See also removeEffect() and effects().