This vocabulary describes parameters 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 (e.g. using lv2:designation for ports) so they can be used more intelligently or presented to the user more efficiently.

Reference

ClassesInstances

Classes

ControlGroup

Subclass ofpg:Group

A group representing a set of associated controls.

Instances

amplitude

Typelv2:Parameter
amplitude

attack

Typelv2:Parameter
attack

The duration of an envelope's attack stage.

bypass

Typelv2:Parameter
bypass

A boolean parameter that disabled processing if true.

cutoffFrequency

Typelv2:Parameter
cutoff frequency

decay

Typelv2:Parameter
decay

The duration of an envelope's decay stage.

delay

Typelv2:Parameter
delay

The duration of an envelope's delay stage.

dryLevel

Typelv2:Parameter
dry level

The level of the unprocessed component of a signal.

frequency

Typelv2:Parameter
frequency

gain

Typelv2:Parameter
units:unit units:db
lv2:default 0.0
lv2:maximum 20.0
lv2:minimum -20.0
gain

Gain in decibels.

hold

Typelv2:Parameter
hold

The duration of an envelope's hold stage.

pulseWidth

Typelv2:Parameter
pulse width

The width of a pulse of a rectangular waveform.

ratio

Typelv2:Parameter
ratio

Compression ratio.

release

Typelv2:Parameter
release

The duration of an envelope's release stage.

resonance

Typelv2:Parameter
resonance

The resonance of a filter.

sampleRate

Typelv2:Parameter
sample rate

A sample rate in Hz.

sustain

Typelv2:Parameter
sustain

The level (not duration) of an envelope's sustain stage.

threshold

Typelv2:Parameter
threshold

Compression threshold.

waveform

Typelv2:Parameter
waveform

wetDryRatio

Typelv2:Parameter
wet/dry ratio

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.

wetLevel

Typelv2:Parameter
wet level

The level of the processed component of a signal.

History

Version 1.4 (2015-04-07)
  • Add range to parameters so hosts know how to control them.
Version 1.2 (2012-10-14)
  • Use consistent label style.
  • Add param:sampleRate.
  • Add parameters.h of URI defines for convenience.
Version 1.0 (2012-04-17)
  • Initial release.