Reference

ClassesPropertiesInstances

Classes

AmbisonicGroup

Subclass ofGroup

Ambisonic channel configurations. 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.

DiscreteGroup

Subclass ofGroup

Discrete channel configurations. 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.

Element

In range ofelement
Element

An element of a group, which has a designation and an optional index.

Restriction on lv2:designation
owl:cardinality 1
An element MUST have exactly one lv2:designation.

Group

In domain ofsubGroupOf
In range ofgroup
subGroupOf
Port Group

A set of ports/channels/controls/etc that are are logically grouped together, e.g. two audio ports in a group may form a stereo stream. In order to avoid the need to define large numbers of identical group definitions, a group definition may be shared. For example, a plugin collection may define a single URI for a pg:StereoGroup with the symbol "input" and use it in many plugins.

Restriction on lv2:symbol
owl:cardinality 1
A pg:Group MUST have exactly one string lv2:symbol. This symbol must be unique according to the same rules as the lv2:symbol for an lv2:Port, 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 another group or a 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.

InputGroup

Subclass ofGroup
In range ofmainInput
source
Input Group

A group which contains exclusively inputs.

OutputGroup

Subclass ofGroup
In domain ofsource
In range ofmainOutput
Output Group

A group which contains exclusively outputs.

Properties

element

TypeObject Property
RangeElement
element

Indicates that a group has a certain element (a parameter or channel designation with a possible index).

group

TypeObject Property
Domainlv2:Port
RangeGroup
group

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.

mainInput

TypeObject Property
Domainlv2:Plugin
RangeInputGroup
main input

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.

mainOutput

TypeObject Property
Domainlv2:Plugin
RangeOutputGroup
main output

Indicates that this group should be considered the "main" output. The main output group SHOULD have the main input group as a pg:source.

sideChainOf

TypeObject Property
side-chain of

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.

source

TypeObject Property
DomainOutputGroup
RangeInputGroup
source

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, e.g. a mono->stereo plugin.

subGroupOf

TypeObject Property
DomainGroup
RangeGroup
sub-group of

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.

Instances

center

Typelv2:Channel
center

centerLeft

Typelv2:Channel
center left

centerRight

Typelv2:Channel
center right

left

Typelv2:Channel
left

lowFrequencyEffects

Typelv2:Channel
low-frequency effects

rearCenter

Typelv2:Channel
rear center

rearLeft

Typelv2:Channel
rear left

rearRight

Typelv2:Channel
rear right

side

Typelv2:Channel
side

sideLeft

Typelv2:Channel
side left

sideRight

Typelv2:Channel
side right

History

Version 1.2 (2012-10-14)
  • Use consistent label style.
Version 1.0 (2012-04-17)
  • Initial release.