aboutsummaryrefslogtreecommitdiffstats
path: root/ext/parameter.lv2/parameter.ttl
blob: f136ad9e2c22e6f46faf77cb11b887317cef5228 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# LV2 Parameter Extension
# Copyright (C) 2010 David Robillard <d@drobilla.net>
# 
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.

@prefix atom:  <http://lv2plug.in/ns/ext/atom#> .
@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/parameter#> .
@prefix rdf:   <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs:  <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd:   <http://www.w3.org/2001/XMLSchema#> .

<http://lv2plug.in/ns/ext/parameter>
	a lv2:Specification ;
    doap:name "LV2 Parameter" ;
    doap:shortdesc "Dynamic message-controlled LV2 plugin parameters." ;
    doap:maintainer [
        a foaf:Person ;
        foaf:name     "David Robillard" ;
        foaf:homepage <http://drobilla.net/> ;
        rdfs:seeAlso  <http://drobilla.net/drobilla.rdf>
    ] ;
	rdfs:comment """
""" .


param:Parameter a rdfs:Class ; a lv2:Resource ;
    rdfs:label   "Parameter" ;
    lv2:documentation """
<p>A parameter on an LV2 plugin.  Parameters can be manipulated to alter
the behaviour or output of a plugin.  Unlike lv2:ControlPort:</p>
<ul>
<li>A parameter may have any data type</li>
<li>Parameters can be dynamically added or removed</li>
<li>Parameter values can be manipulated by the plugin</li>
</ul>

<p>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.</p>

<p>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).</p>
""" .


param:supportsType a rdf:Property ;
    rdfs:domain  param:Parameter ;
    rdfs:range   atom:AtomType ;
    rdfs:label   "supports type" ;
    lv2:documentation """
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 <a href="http://lv2plug.in/ns/ext/atom">LV2 Atom</a> Extension
Any type of LV2 Atom may be used as a parameter value.
""" .


param:value a rdf:Property ;
	rdfs:domain param:Parameter ;
	rdfs:label "value" ;
	rdfs:comment """
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.
""" .


param:minimum a rdf:Property ;
	rdfs:domain param:Parameter ;
	rdfs:label "minimum" ;
	rdfs:comment """
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.
""" .


param:maximum a rdf:Property ;
	rdfs:domain param:Parameter ;
	rdfs:label "maximum" ;
	rdfs:comment """
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.
""" .