path: root/lv2/event/event.ttl
diff options
authorDavid Robillard <d@drobilla.net>2020-03-22 16:36:44 +0100
committerDavid Robillard <d@drobilla.net>2020-04-10 19:46:04 +0200
commit430284545345539c9ffb31df889debac1d3888b5 (patch)
treedc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/event/event.ttl
parentc4514483da1ab4f49148f9c4fe4ff5b559323217 (diff)
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/event/event.ttl')
1 files changed, 13 insertions, 47 deletions
diff --git a/lv2/event/event.ttl b/lv2/event/event.ttl
index a5210ed..8cbf3ba 100644
--- a/lv2/event/event.ttl
+++ b/lv2/event/event.ttl
@@ -8,73 +8,45 @@
a owl:Ontology ,
lv2:Specification ;
owl:deprecated true ;
+ rdfs:label "LV2 Event" ;
+ rdfs:comment "A port-based real-time generic event interface." ;
rdfs:seeAlso <event.h> ,
<event-helpers.h> ,
- <event.meta.ttl> ;
- lv2:documentation """
-<p>This extension defines a generic time-stamped event port type, which can be
-used to create plugins that read and write real-time events, such as MIDI,
-OSC, or any other type of event payload. The type(s) of event supported by
-a port is defined in the data file for a plugin, for example:</p>
-<pre class="turtle-code">
- lv2:port [
- a ev:EventPort, lv2:InputPort ;
- lv2:index 0 ;
- ev:supportsEvent &lt;http://lv2plug.in/ns/ext/midi#MidiEvent&gt; ;
- lv2:symbol "midi_input" ;
- lv2:name "MIDI input" ;
- ] .
-""" .
+ <event.meta.ttl> .
a rdfs:Class ;
rdfs:label "Event Port" ;
rdfs:subClassOf lv2:Port ;
- rdfs:comment "Ports of this type will be connected to a struct of type LV2_Event_Buffer, defined in event.h. These ports contain a sequence of generic events (possibly several types mixed in a single stream), the specific types of which are defined by some URI in another LV2 extension." .
+ rdfs:comment "An LV2 event port." .
a rdfs:Class ;
rdfs:label "Event" ;
- rdfs:comment """A single generic time-stamped event.
-An ev:EventPort contains an LV2_Event_Buffer which contains a sequence of these events. The binary format of LV2 events is defined by the LV2_Event struct in event.h.
-Specific event types (e.g. MIDI, OSC) are defined by extensions, and should be rdfs:subClassOf this class.""" .
+ rdfs:comment "A single generic time-stamped event." .
a rdfs:Class ;
rdfs:label "Event Time Stamp" ;
- rdfs:comment """The time stamp of an Event.
-This defines the meaning of the 'frames' and 'subframes' fields of an LV2_Event (both unsigned 32-bit integers).""" .
+ rdfs:comment "The time stamp of an Event." .
a rdfs:Class ;
rdfs:subClassOf ev:TimeStamp ;
rdfs:label "Audio Frame Time Stamp" ;
- rdfs:comment """The default time stamp unit for an LV2 event: the frames field represents
-audio frames (in the sample rate passed to intantiate), and the subframes
-field is 1/UINT32_MAX of a frame.""" .
+ rdfs:comment "The default time stamp unit for an event." .
a lv2:PortProperty ;
rdfs:label "generic event port" ;
- rdfs:comment """Indicates that this port does something meaningful for any event type (e.g. event mixers, delays, serialisers, etc).
-If this property is set, hosts should consider the port suitable for any type of event. Otherwise, hosts should consider the port 'appropriate' only for the specific event types listed with :supportsEvent. Note that plugins must gracefully handle unknown event types whether or not this property is present.""" .
+ rdfs:comment "Port works with generic events." .
a rdf:Property ;
rdfs:domain ev:EventPort ;
rdfs:range rdfs:Class ;
rdfs:label "supports event type" ;
- rdfs:comment """Indicates that this port supports or "understands" a certain event type.
-For input ports, this means the plugin understands and does something useful with events of this type. For output ports, this means the plugin may generate events of this type. If the plugin never actually generates events of this type, but might pass them through from an input, this property should not be set (use ev:inheritsEvent for that).
-Plugins with event input ports must always gracefully handle any type of event, even if it does not 'support' it. This property should always be set for event types the plugin understands/generates so hosts can discover plugins appropriate for a given scenario (e.g. plugins with a MIDI input). Hosts are not expected to consider event ports suitable for some type of event if the relevant :supportsEvent property is not set, unless the ev:generic property for that port is also set.""" .
+ rdfs:comment "An event type supported by this port." .
a rdf:Property ;
@@ -82,7 +54,7 @@ ev:inheritsEvent
lv2:OutputPort ;
rdfs:range lv2:Port ;
rdfs:label "inherits event type" ;
- rdfs:comment "Indicates that this output port might pass through events that arrived at some other input port (or generate an event of the same type as events arriving at that input). The host must always check the stamp type of all outputs when connecting an input, but this property should be set whenever it applies." .
+ rdfs:comment "Output port inherits event types from an input port." .
a rdf:Property ;
@@ -90,7 +62,7 @@ ev:supportsTimeStamp
lv2:InputPort ;
rdfs:range rdfs:Class ;
rdfs:label "supports time stamp type" ;
- rdfs:comment """Indicates that this port supports or "understands" a certain time stamp type. Meaningful only for input ports, the host must never connect a port to an event buffer with a time stamp type that isn't supported by the port.""" .
+ rdfs:comment "A time stamp type suported by this input port." .
a rdf:Property ;
@@ -98,11 +70,7 @@ ev:generatesTimeStamp
lv2:OutputPort ;
rdfs:range rdfs:Class ;
rdfs:label "generates time stamp type" ;
- rdfs:comment """Indicates that this port may output a certain time stamp type, regardless of the time stamp type of any input ports.
-If the port outputs stamps based on what type inputs are connected to, this property should not be set (use the ev:inheritsTimeStamp property for that). Hosts MUST check the time_stamp value of any output port buffers after a call to connect_port on ANY event input port on the plugin.
-If the plugin changes the stamp_type field of an output event buffer during a call to run(), the plugin must call the stamp_type_changed function provided by the host in the LV2_Event_Feature struct, if it is non-NULL.""" .
+ rdfs:comment "A time stamp type generated by this input port." .
a rdf:Property ;
@@ -110,7 +78,5 @@ ev:inheritsTimeStamp
lv2:OutputPort ;
rdfs:range lv2:Port ;
rdfs:label "inherits time stamp type" ;
- rdfs:comment """Indicates that this port follows the time stamp type of an input port.
-This property is not necessary, but it should be set for outputs that base their output type on an input port so the host can make more sense of the plugin and provide a more sensible interface.""" .
+ rdfs:comment "Output port inherits time stamp types from an input port." .