Contents

Description

Index

Classes
Properties
maximum, minimum, supportsType, value,

Documentation

Class param:Parameter

Parameter

A parameter on an LV2 plugin. Parameters can be manipulated to alter the behaviour or output of a plugin. Unlike lv2:ControlPort:

  • A parameter may have any data type
  • Parameters can be dynamically added or removed
  • Parameter values can be manipulated by the plugin

Note that plugins are not required to support this potential functionality, parameters can be used to provide a basic LADSPA-like set of floating point parameters in a more extensible manner.

Parameters are essentially controls that are not 1:1 associated with ports (manipulation of parameters can be accomplished by e.g. sending messages to a command port).

In domain ofparam:supportsType
param:minimum
param:value
param:maximum

Property param:maximum

maximum
Specifies the maximum value of a Parameter (for Parameters with comparable types for which this makes sense). The type of the maximum must be one of the types specified by param:supportsType. The host MAY attempt to set a parameter to any value (of a legal type), i.e. the plugin MUST NOT assume attempts to change a parameter are within range and SHOULD clamp accordingly.
Domainparam:Parameter

Property param:minimum

minimum
Specifies the minimum value of a Parameter (for Parameters with comparable types for which this makes sense). The type of the minimum must be one of the types specified by param:supportsType. The host MAY attempt to set a parameter to any value (of a legal type), i.e. the plugin MUST NOT assume attempts to change a parameter are within range and SHOULD clamp accordingly.
Domainparam:Parameter

Property param:supportsType

supports type

Indicates that a Parameter has values of a particular type. A Parameter may support many types. Parameter values are always LV2 Atoms as defined by the LV2 Atom Extension Any type of LV2 Atom may be used as a parameter value.

Domainparam:Parameter
Rangeatom:Atom

Property param:value

value
Indicates that a Parameter has a certain value. A Parameter has at most one value at any given time. The type of the value specified must be one of the types specified by param:supportsType. When used in a plugin data file this property specifies the default value of a parameter.
Domainparam:Parameter

Version History