aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/port-groups/port-groups.meta.ttl
diff options
context:
space:
mode:
Diffstat (limited to 'lv2/port-groups/port-groups.meta.ttl')
-rw-r--r--lv2/port-groups/port-groups.meta.ttl97
1 files changed, 97 insertions, 0 deletions
diff --git a/lv2/port-groups/port-groups.meta.ttl b/lv2/port-groups/port-groups.meta.ttl
index 975e4ee..f6e78ed 100644
--- a/lv2/port-groups/port-groups.meta.ttl
+++ b/lv2/port-groups/port-groups.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 pg: <http://lv2plug.in/ns/ext/port-groups#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
<http://lv2plug.in/ns/ext/port-groups>
@@ -42,3 +44,98 @@
]
] .
+pg:Group
+ lv2:documentation """
+
+A group logically combines ports which should be considered part of the same
+stream. For example, two audio ports in a group may form a stereo stream.
+
+Like ports, groups have a lv2:symbol that is unique within the context of the
+plugin, where group symbols and port symbols reside in the same namespace. In
+other words, a group on a plugin MUST NOT have the same symbol as any other
+group or port on that plugin. This makes it possible to uniquely reference a
+port or group on a plugin with a single identifier and no context.
+
+Group definitions may be shared across plugins for brevity. For example, a
+plugin collection may define a single URI for a pg:StereoGroup with the symbol
+"input" and use it in many plugins.
+
+"""^^lv2:Markdown .
+
+pg:sideChainOf
+ lv2:documentation """
+
+Indicates that this port or group should be considered a "side chain" of some
+other port or group. The precise definition of "side chain" depends on the
+plugin, but in general this group should be considered a modifier to some other
+group, rather than an independent input itself.
+
+"""^^lv2:Markdown .
+
+pg:subGroupOf
+ lv2:documentation """
+
+Indicates that this group is a child of another group. This property has no
+meaning with respect to plugin execution, but the host may find this
+information useful (e.g. to provide a compact user interface). Note that being
+a sub-group does not relax the restriction that the group MUST have a unique
+symbol with respect to the plugin.
+
+"""^^lv2:Markdown .
+
+pg:source
+ lv2:documentation """
+
+Indicates that this port or group should be considered the "result" of some
+other port or group. This property only makes sense on groups with outputs
+when the source is a group with inputs. This can be used to convey a
+relationship between corresponding input and output groups with different
+types, for example in a mono to stereo plugin.
+
+"""^^lv2:Markdown .
+
+pg:mainInput
+ lv2:documentation """
+
+Indicates that this group should be considered the "main" input, i.e. the
+primary task is processing the signal in this group. A plugin MUST NOT have
+more than one pg:mainInput property.
+
+"""^^lv2:Markdown .
+
+pg:mainOutput
+ lv2:documentation """
+
+Indicates that this group should be considered the "main" output. The main
+output group SHOULD have the main input group as a pg:source.
+
+"""^^lv2:Markdown .
+
+pg:group
+ lv2:documentation """
+
+Indicates that this port is a part of a group of ports on the plugin. The port
+should also have an lv2:designation property to define its designation within
+that group.
+
+"""^^lv2:Markdown .
+
+pg:DiscreteGroup
+ lv2:documentation """
+
+These groups are divided into channels where each represents a particular
+speaker location. The position of sound in one of these groups depends on a
+particular speaker configuration.
+
+"""^^lv2:Markdown .
+
+pg:AmbisonicGroup
+ lv2:documentation """
+
+These groups are divided into channels which together represent a position in
+an abstract n-dimensional space. The position of sound in one of these groups
+does not depend on a particular speaker configuration; a decoder can be used to
+convert an ambisonic stream for any speaker configuration.
+
+"""^^lv2:Markdown .
+