|  | Home · All Classes · Modules

# Phonon.EffectParameter Class Reference
[phonon module]

The EffectParameter class describes one parameter of an effect. More...

### Types

- enum Hint { ToggledHint, LogarithmicHint, IntegerHint }
- class Hints

### Methods

- __init__ (self, int parameterId, QString name, Hints hints, QVariant defaultValue, QVariant min = QVariant(), QVariant max = QVariant(), QVariant-list values = QVariantList(), QString description = QString())
- __init__ (self, EffectParameter rhs)
- QVariant defaultValue (self)
- QString description (self)
- bool isLogarithmicControl (self)
- QVariant maximumValue (self)
- QVariant minimumValue (self)
- QString name (self)
- QVariant-list possibleValues (self)
- QVariant.Type type (self)

### Special Methods

- long __hash__ (self)

## Detailed Description

Author: Matthias Kretz <kretz@kde.org>

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, and Capabilities Example.

## Type Documentation

### EffectParameter.Hint

Only for backend developers:

Flags to set the return values of isToggleControl(), isLogarithmicControl(), isIntegerControl(), isBoundedBelow() and isBoundedAbove(). The values of the flags correspond to the values used for LADSPA effects.

Constant | Value | Description
--- | --- | ---
`Phonon.EffectParameter.ToggledHint` | `0x04` | If this hint is set it means that the the control has only two states: zero and non-zero (see isToggleControl()).
`Phonon.EffectParameter.LogarithmicHint` | `0x10` | LADSPA's SAMPLE_RATE hint needs to be translated by the backend to normal bounds, as the backend knows the sample rate - and the frontend doesn't (see isLogarithmicControl()).
`Phonon.EffectParameter.IntegerHint` | `0x20` | See isIntegerControl().

The Hints type is a typedef for QFlags<Hint>. It stores an OR combination of Hint values.

## Method Documentation

### EffectParameter.__init__ (self, int parameterId, QString name, Hints hints, QVariant defaultValue, QVariant min = QVariant(), QVariant max = QVariant(), QVariant-list values = QVariantList(), QString description = QString())

### EffectParameter.__init__ (self, EffectParameter rhs)

### QVariant EffectParameter.defaultValue (self)

The default value.

### QString EffectParameter.description (self)

The parameter may come with a description (LADSPA doesn't have a field for this, so don't expect many effects to provide a description).

The description can be used for a tooltip or WhatsThis help.

Returns A text describing the parameter.

### bool EffectParameter.isLogarithmicControl (self)

Returns whether the parameter should be displayed using a logarithmic scale. This is particularly useful for frequencies and gains.

### QVariant EffectParameter.maximumValue (self)

The maximum value to be used for the control to edit the parameter.

If the returned QVariant is invalid the value is not bounded from above.

### QVariant EffectParameter.minimumValue (self)

The minimum value to be used for the control to edit the parameter.

If the returned QVariant is invalid the value is not bounded from below.

### QString EffectParameter.name (self)

The name of the parameter. Can be used as the label.

Returns A label for the parameter.

### QVariant-list EffectParameter.possibleValues (self)

The possible values to be used for the control to edit the parameter.

if the value of this parameter is to be picked from predefined values this returns the list (otherwise it returns an empty QVariantList).

### QVariant.Type EffectParameter.type (self)

Returns the parameter type.

Common types are QVariant.Int, QVariant.Double, QVariant.Bool and QVariant.String. When QVariant.String is returned you get the possible values from possibleValues.

### long EffectParameter.__hash__ (self)