diff options
author | David Robillard <d@drobilla.net> | 2020-03-22 16:36:44 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-04-10 19:46:04 +0200 |
commit | 430284545345539c9ffb31df889debac1d3888b5 (patch) | |
tree | dc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/parameters/parameters.meta.ttl | |
parent | c4514483da1ab4f49148f9c4fe4ff5b559323217 (diff) | |
download | lv2-430284545345539c9ffb31df889debac1d3888b5.tar.xz |
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/parameters/parameters.meta.ttl')
-rw-r--r-- | lv2/parameters/parameters.meta.ttl | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/lv2/parameters/parameters.meta.ttl b/lv2/parameters/parameters.meta.ttl index 028b3b0..5fcd047 100644 --- a/lv2/parameters/parameters.meta.ttl +++ b/lv2/parameters/parameters.meta.ttl @@ -1,6 +1,8 @@ @prefix dcs: <http://ontologi.es/doap-changeset#> . @prefix doap: <http://usefulinc.com/ns/doap#> . @prefix foaf: <http://xmlns.com/foaf/0.1/> . +@prefix lv2: <http://lv2plug.in/ns/lv2core#> . +@prefix param: <http://lv2plug.in/ns/ext/parameters#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . <http://lv2plug.in/ns/ext/parameters> @@ -44,5 +46,30 @@ doap:created "2009-00-00" ; doap:shortdesc "Common parameters for audio processing." ; doap:maintainer <http://drobilla.net/drobilla#me> ; - doap:developer <http://lv2plug.in/ns/meta#larsl> . + doap:developer <http://lv2plug.in/ns/meta#larsl> ; + lv2:documentation """ + +This is a vocabulary for parameters that are common in audio processing +software. A <q>parameter</q> 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. + +"""^^lv2:Markdown . + +param:wetDryRatio + a lv2:Parameter ; + rdfs:label "wet/dry ratio" ; + lv2:documentation """ + +The ratio between processed and bypass components in output signal. The dry +and wet percentages can be calculated from the following equations: + + :::c + 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. + +"""^^lv2:Markdown . |