Contents

Description

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.

Index

Classes
Instances
amplitude, attack, bypass, cutoffFrequency, decay, delay, dryLevel, frequency, gain, hold, pulseWidth, ratio, release, resonance, sampleRate, sustain, threshold, waveform, wetDryRatio, wetLevel

Documentation

Class param:CompressorControls

Compressor Controls
Sub-class ofparam:ControlGroup
pg:element
lv2:designation param:threshold
pg:element
lv2:designation param:ratio

Class param:ControlGroup

A group representing a set of associated controls.

Sub-class ofpg:Group

Class param:EnvelopeControls

DAHDSR Envelope Controls
Sub-class ofparam:ControlGroup
pg:element
lv2:index 2
lv2:designation param:hold
lv2:designation param:sustain
lv2:index 4
pg:element
lv2:designation param:decay
lv2:index 3
lv2:designation param:delay
lv2:index 0
lv2:index 5
lv2:designation param:release
pg:element
lv2:index 1
lv2:designation param:attack

Class param:FilterControls

Filter Controls
Sub-class ofparam:ControlGroup
pg:element
lv2:designation param:cutoffFrequency
pg:element
lv2:designation param:resonance

Class param:OscillatorControls

Oscillator Controls
Sub-class ofparam:ControlGroup
pg:element
lv2:designation param:pulseWidth
pg:element
lv2:designation param:amplitude
lv2:designation param:frequency
lv2:designation param:waveform

Instance param:amplitude

amplitude
Typelv2:Parameter

Instance param:attack

attack

The duration of an envelope's attack stage.

Typelv2:Parameter

Instance param:bypass

bypass

A boolean parameter that disabled processing if true.

Typelv2:Parameter

Instance param:cutoffFrequency

cutoff frequency
Typelv2:Parameter

Instance param:decay

decay

The duration of an envelope's decay stage.

Typelv2:Parameter

Instance param:delay

delay

The duration of an envelope's delay stage.

Typelv2:Parameter

Instance param:dryLevel

dry level

The level of the unprocessed component of a signal.

Typelv2:Parameter

Instance param:frequency

frequency
Typelv2:Parameter

Instance param:gain

gain

A factor which controls an output level.

Typelv2:Parameter

Instance param:hold

hold

The duration of an envelope's hold stage.

Typelv2:Parameter

Instance param:pulseWidth

pulse width

The width of a pulse of a rectangular waveform.

Typelv2:Parameter

Instance param:ratio

ratio

Compression ration.

Typelv2:Parameter

Instance param:release

release

The duration of an envelope's release stage.

Typelv2:Parameter

Instance param:resonance

resonance

The resonance of a filter.

Typelv2:Parameter

Instance param:sampleRate

sample rate

A sample rate in Hz.

Typelv2:Parameter

Instance param:sustain

sustain

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

Typelv2:Parameter

Instance param:threshold

threshold

Compression threshold.

Typelv2:Parameter

Instance param:waveform

waveform
Typelv2:Parameter

Instance param:wetDryRatio

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.

Typelv2:Parameter

Instance param:wetLevel

wet level

The level of the processed component of a signal.

Typelv2:Parameter

Releases

Version 1.2 (2012-10-14)
  • Add parameters.h of URI defines for convenience.
  • Add param:sampleRate.
  • Use consistent label style.
Version 1.0 (2012-04-17)
  • Initial release.