This is a vocabulary for parameters that are common in audio processing
software. A parameter
is purely a metadata concept, unrelated to any
particular code mechanism. Parameters are used to assign meaning to controls
(for example, using lv2:designation for ports) so they can be used more
intelligently or presented to the user more efficiently.
Index
Classes
CompressorControls
Class| Label | Compressor Controls | ||
|---|---|---|---|
| Subclass of | ControlGroup | ||
| pg:element |
| ||
| pg:element |
|
ControlGroup
Class| Label | Control Group |
|---|---|
| Subclass of | pg:Group |
| Superclass of | CompressorControls |
| EnvelopeControls | |
| FilterControls | |
| OscillatorControls |
A group representing a set of associated controls.
EnvelopeControls
Class| Label | Envelope Controls | ||||
|---|---|---|---|---|---|
| Subclass of | ControlGroup | ||||
| pg:element |
| ||||
| pg:element |
| ||||
| pg:element |
| ||||
| pg:element |
| ||||
| pg:element |
| ||||
| pg:element |
|
Typical controls for a DAHDSR envelope.
FilterControls
Class| Label | Filter Controls | ||
|---|---|---|---|
| Subclass of | ControlGroup | ||
| pg:element |
| ||
| pg:element |
|
Typical controls for a filter.
OscillatorControls
Class| Label | Oscillator Controls | ||
|---|---|---|---|
| Subclass of | ControlGroup | ||
| pg:element |
| ||
| pg:element |
| ||
| pg:element |
| ||
| pg:element |
|
Typical controls for an oscillator.
Instances
amplitude
Instance| Label | amplitude |
|---|---|
| Type | lv2:Parameter |
An amplitude as a factor, where 0 is silent and 1 is unity.
cutoffFrequency
Instance| Label | cutoff frequency |
|---|---|
| Type | lv2:Parameter |
The cutoff frequency, typically in Hz, for a filter.
dryLevel
Instance| Label | dry level |
|---|---|
| Type | lv2:Parameter |
The level of the unprocessed component of a signal.
gain
Instance| Label | gain |
|---|---|
| Type | lv2:Parameter |
| units:unit | units:db |
| lv2:default | 0.0 |
| lv2:maximum | 20.0 |
| lv2:minimum | -20.0 |
Gain in decibels.
pulseWidth
Instance| Label | pulse width |
|---|---|
| Type | lv2:Parameter |
The width of a pulse of a rectangular waveform.
waveform
Instance| Label | waveform |
|---|---|
| Type | lv2:Parameter |
The waveform "fader" for oscillators or modulators that have several.
wetDryRatio
Instance| Label | wet/dry ratio |
|---|---|
| Type | lv2:Parameter |
The ratio between processed and bypassed levels in the output.
The ratio between processed and bypass components in output signal. The dry and wet percentages can be calculated from the following equations:
dry = (wetDryRatio.maximum - wetDryRatio.value) / wetDryRatio.maximum
wet = wetDryRatio.value / wetDryRatio.maximum
Typically, maximum value of 1 or 100 and minimum value of 0 should be used.
Typical controls for a compressor.