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

Detailed Description

The EffectParameter class describes one parameter of an effect.

You fetch the parameters of an Effect with Effect::parameters().

     QList<Phonon::EffectParameter> parameters = effect->parameters();

     foreach(Phonon::EffectParameter parameter, parameters) {
         // Do something with parameter
     }

To describe itself, an effect parameter gives a name() and possibly description() (depending on the backend used). These are suited to present the effect parameter to the user of a Phonon application.

Note that effects are created by the backend, and that their name and descriptions may vary.

The value of an effect parameter is stored in a QVariant, of which type() is usually int or double.

The value is retrieved with Effect::parameterValue() and set with setParameterValue() - both of which takes the EffectParameter as argument. Note that not all effect parameters support setting of their value.

You get the values a parameter can take with possibleValues(); an empty list is returned if the values are continuous.

A parameter may also specify default(), minimum(), and maximum() values. Values are returned as QVariants. If the parameter does not have the requested value, an QVariant::Invalid invalid QVariant is returned from these functions.

The EffectWidget provides a widget with which one can control the parameters of an Effect.

     Phonon::EffectWidget *effectWidget = new Phonon::EffectWidget(effect);

See also Effect, EffectWidget, Capabilities Example, and Phonon Module.

Member Type Documentation