Description

Index

Classes
Properties
element, group, mainInput, mainOutput, sideChainOf, source, subGroupOf
Instances
center, centerLeft, centerRight, left, lowFrequencyEffects, rearCenter, rearLeft, rearRight, right, side, sideLeft, sideRight

Reference

Class pg:AmbisonicBH1P0Group

Ambisonic B stream of horizontal order 1 and peripheral order 0.
Sub-class ofpg:AmbisonicGroup
pg:element
lv2:index 1
lv2:designation amb:ACN1
lv2:designation amb:ACN0
lv2:index 0
pg:element
lv2:index 2
lv2:designation amb:ACN3

Class pg:AmbisonicBH1P1Group

Class pg:AmbisonicBH2P0Group

Class pg:AmbisonicBH2P1Group

Class pg:AmbisonicBH2P2Group

Class pg:AmbisonicBH3P0Group

Class pg:AmbisonicBH3P1Group

Class pg:AmbisonicBH3P2Group

Class pg:AmbisonicBH3P3Group

Class pg:AmbisonicGroup

"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.

Sub-class ofpg:Group

Class pg:DiscreteGroup

"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.

Sub-class ofpg:Group

Class pg:Element

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.
In range ofpg:element

Class pg:FivePointOneGroup

Class pg:FivePointZeroGroup

Class pg:FourPointZeroGroup

Class pg:Group

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.
In domain ofpg:subGroupOf
In range ofpg:group
pg:subGroupOf

Class pg:InputGroup

Input Group

A group which contains exclusively inputs.

Sub-class ofpg:Group
In range ofpg:source
pg:mainInput

Class pg:MidSideGroup

Class pg:MonoGroup

Class pg:OutputGroup

Output Group

A group which contains exclusively outputs.

Sub-class ofpg:Group
In domain ofpg:source
In range ofpg:mainOutput

Class pg:SevenPointOneGroup

Class pg:SevenPointOneWideGroup

Class pg:SixPointOneGroup

Class pg:StereoGroup

Class pg:ThreePointZeroGroup

Property pg:element

element

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

OWL TypeObject Property
Rangepg:Element

Property pg:group

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.

OWL TypeObject Property
Domainlv2:Port
Rangepg:Group

Property pg:mainInput

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.

OWL TypeObject Property
Domainlv2:Plugin
Rangepg:InputGroup

Property pg:mainOutput

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.

OWL TypeObject Property
Domainlv2:Plugin
Rangepg:OutputGroup

Property pg:sideChainOf

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.

OWL TypeObject Property

Property pg:source

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.

OWL TypeObject Property
Domainpg:OutputGroup
Rangepg:InputGroup

Property pg:subGroupOf

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.

OWL TypeObject Property
Domainpg:Group
Rangepg:Group

Instance pg:center

center
Typelv2:Channel

Instance pg:centerLeft

center left
Typelv2:Channel

Instance pg:centerRight

center right
Typelv2:Channel

Instance pg:left

left
Typelv2:Channel

Instance pg:lowFrequencyEffects

low-frequency effects
Typelv2:Channel

Instance pg:rearCenter

rear center
Typelv2:Channel

Instance pg:rearLeft

rear left
Typelv2:Channel

Instance pg:rearRight

rear right
Typelv2:Channel

Instance pg:side

side
Typelv2:Channel

Instance pg:sideLeft

side left
Typelv2:Channel

Instance pg:sideRight

side right
Typelv2:Channel

History

Version 2.2 (2014-08-08)
  • Add patch:sequenceNumber for associating replies with requests.
Version 2.2 (2014-01-04)
  • Add missing include string.h to logger.h for memset.
Version 1.6 (2013-05-26)
  • Fix crash in forge.h when pushing atoms to a full buffer.
Version 1.4 (2013-01-27)
  • Fix lv2_atom_sequence_end().
  • Remove atom:stringType in favour of owl:onDatatype so generic tools can understand and validate atom literals.
  • Improve atom documentation.
Version 1.10 (2013-01-13)
  • Fix incorrect return type in lv2_event_get().
Version 2.0 (2013-01-10)
  • Make patch:Set a compact message for setting one property.
  • Add patch:readable and patch:writable for describing available properties.
Version 2.0 (2013-01-08)
  • Add logger convenience API.
Version 1.2 (2012-12-21)
  • Fix typo in bufsz:sequenceSize label.
Version 1.2 (2012-10-14)
  • Use consistent label style.
Version 1.0 (2012-04-17)
  • Initial release.
Version 1.4 (2011-11-21)
  • Improve documentation.
  • Update packaging.
Version 1.4 (2011-11-21)
  • Improve documentation.
  • Update packaging.
Version 1.4 (2011-11-21)
  • Update packaging.
Version 1.4 (2011-11-21)
  • Improve documentation.
  • Update packaging.
Version 1.2 (2011-05-26)
  • Switch to ISC license.
  • Add build system for installation.
Version 1.2 (2011-05-26)
  • Switch to ISC license.
  • Add build system for installation.
Version 1.2 (2011-05-26)
  • Use lv2:Specification to be discovered as an extension.
  • Add build system (for installation).
  • Convert documentation to HTML and use lv2:documentation.
Version 1.2 (2011-05-26)
  • Switch to ISC license.
  • Add build system for installation.
Version 1.0 (2010-11-24)
  • Initial release.
Version 1.0 (2010-10-04)
  • Initial release.
Version 1.0 (2010-10-04)
  • Initial release.
Version 1.0 (2010-10-04)
  • Initial release.