# class EffectParameter

###

Module | phonon
Namespace | Phonon
Class | EffectParameter
Inherits |

\class EffectParameter effectparameter.h Phonon/EffectParameter This class describes one parameter of an effect.

Author Matthias Kretz <kretz@kde.org>

See also Effect

### enums

- Hint { ToggledHint, LogarithmicHint, IntegerHint }

enum details

### methods

- EffectParameter ( )

  returns ctor

  Internal

  Creates an invalid effect parameter.

- EffectParameter (rhs)

  returns ctor

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

- EffectParameter (parameterId, name, hints, defaultValue, min, max, values, description)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  parameterId | int |
  name | QString |
  hints | Phonon::EffectParameter.Hints |
  defaultValue | QVariant |
  min | QVariant | QVariant()
  max | QVariant | QVariant()
  values | QVariantList | QVariantList()
  description | QString | QString()

  Only to be used by backend implementations:

  Creates a new effect parameter.

  parameterId - This is a number to uniquely identify the parameter. The id is used for value() and setValue().

  name - The name/label for this parameter.

  hints - Sets the hints for the type of parameter.

  defaultValue - The value that should be used as a default.

  min - The minimum value allowed for this parameter. You only need to set this if the BoundedBelowHint is set.

  max - The maximum value allowed for this parameter. You only need to set this if the BoundedAboveHint is set.

  description - A descriptive text for the parameter (explaining what it controls) to be used as a tooltip or WhatsThis help.

- defaultValue ( )

  returns QVariant

  The default value.

- description ( )

  returns QString

  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.

- id ( )

  returns int

  Internal

  Returns the parameter's id.

- isLogarithmicControl ( )

  returns bool

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

- maximumValue ( )

  returns QVariant

  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.

- minimumValue ( )

  returns QVariant

  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.

- name ( )

  returns QString

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

  Returns A label for the parameter.

- operator < (rhs)

  returns bool

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

  Internal compares the ids of the parameters

- operator == (rhs)

  returns bool

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

  Internal compares the ids of the parameters

- operator > (rhs)

  returns bool

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

  Internal compares the ids of the parameters

- possibleValues ( )

  returns QVariantList

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

- type ( )

  returns QVariant.Type

  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.

### enums - detail

- Hint { ToggledHint, LogarithmicHint, IntegerHint }

  If this hint is set it means that the the control has only two states: zero and non-zero.

  See also isToggleControl()

  | ToggledHint | - 0x04 | - | If this hint is set it means that the the control has only two states: zero and non-zero. < p> See also isToggleControl()
  | LogarithmicHint | - 0x10 | - |
  | IntegerHint | - 0x20 | - |