This is a vocabulary for describing extra plugin data specific to MOD software and devices.
Reference
Classes | Properties | Instances |
---|---|---|
Classes
CVPort
Subclass of | lv2:CVPort |
---|
ControlVoltagePlugin
Subclass of | lv2:Plugin |
---|
Forces Control Voltage as the plugin category.
DelayPlugin
Subclass of | lv2:Plugin |
---|
Forces Delay as the plugin category.
DistortionPlugin
Subclass of | lv2:Plugin |
---|
Forces Distortion as the plugin category.
DynamicsPlugin
Subclass of | lv2:Plugin |
---|
Forces Dynamics as the plugin category.
FilterPlugin
Subclass of | lv2:Plugin |
---|
Forces Filter as the plugin category.
GeneratorPlugin
Subclass of | lv2:Plugin |
---|
Forces Generator as the plugin category.
MIDIPlugin
Subclass of | lv2:Plugin |
---|
Forces MIDI Utility as the plugin category.
MaxGenPlugin
Subclass of | lv2:Plugin |
---|
A plugin made with MAX gen~ export function.
ModulatorPlugin
Subclass of | lv2:Plugin |
---|
Forces Modulator as the plugin category.
ReverbPlugin
Subclass of | lv2:Plugin |
---|
Forces Reverb as the plugin category.
SimulatorPlugin
Subclass of | lv2:Plugin |
---|
Forces Simulator as the plugin category.
SpatialPlugin
Subclass of | lv2:Plugin |
---|
Forces Spatial as the plugin category.
SpectralPlugin
Subclass of | lv2:Plugin |
---|
Forces Spectral as the plugin category.
UtilityPlugin
Subclass of | lv2:Plugin |
---|
Forces Utility as the plugin category.
Properties
brand
Type | Datatype Property |
---|---|
Range | xsd:string |
A short plugin brand name. Maximum of 11 characters
buildEnvironment
Type | Datatype Property |
---|
The environment of the MOD cloud builder used to compile a plugin. MUST be 'prod', 'dev' or 'labs'.
buildId
Type | Datatype Property |
---|
The id for build process the MOD cloud builder used to compile a plugin.
builderVersion
Type | Datatype Property |
---|---|
Range | xsd:nonNegativeInteger |
The version of the MOD cloud builder used to compile a plugin.
default
Type | Datatype Property |
---|---|
rdfs:seeAlso | lv2:default |
A custom default value specific to MOD devices, used in place of lv2:default.
fileTypes
Type | Datatype Property |
---|
The file types that a path parameter supports, written as a comma-separated string without whitespace.
As of v1.10, the currently supported file types are:
- audioloop: Audio Loops, meant to be used for looper-style plugins.
- audiorecording: Audio Recordings, triggered by plugins and stored in the unit.
- audiosample: One-shot Audio Samples, meant to be used for sampler-style plugins.
- audiotrack: Audio Tracks, meant to be used as full-performance/song or backtrack.
- cabsim: Speaker Cabinets, meant as small IR audio files.
- h2drumkit: Hydrogen Drumkits, must use h2drumkit file extension.
- ir: Impulse Responses.
- midiclip: MIDI Clips, to be used in sync with host tempo, must have mid or midi file extension.
- midisong: MIDI Songs, meant to be used as full-performance/song or backtrack.
- sf2: SF2 Instruments, must have sf2 or sf3 file extension.
- sfz: SFZ Instruments, must have sfz file extension.
For audio files the supported file extensions are (usually through libsndfile) "aif", "aifc", "aiff", "au", "bwf", "flac", "htk", "iff", "mat4", "mat5", "oga", "ogg",
"paf", "pvf", "pvf5", "sd2", "sf", "snd", "svx", "vcc", "w64", "wav", "xi",
(extra through ffmpeg)
"3g2", "3gp", "aac", "ac3", "amr", "ape", "mp2", "mp3", "mpc", and "wma".
For Speaker Cabinets and Impulse Responses, the supported file extensions are "aif", "aifc", "aiff", "flac", "w64" and "wav".
label
Type | Datatype Property |
---|---|
Range | xsd:string |
A short plugin label. Maximum of 16 characters
maximum
Type | Datatype Property |
---|---|
rdfs:seeAlso | lv2:maximum |
A custom maximum value specific to MOD devices, used in place of lv2:maximum.
minimum
Type | Datatype Property |
---|---|
rdfs:seeAlso | lv2:minimum |
A custom minimum value specific to MOD devices, used in place of lv2:minimum.
rangeSteps
Domain | lv2:Port |
---|---|
Range | xsd:nonNegativeInteger |
rdfs:seeAlso | pprops:rangeSteps |
A custom rangeSteps value specific to MOD devices, used in place of pprops:rangeSteps.
rawMIDIClockAccess
Domain | atom:AtomPort |
---|
Hides the atom port and connects it to the raw MIDI inputs currently active, allowing to receive all messages before they are filtered by mod-host, such as MIDI Clock.
releaseNumber
Type | Datatype Property |
---|---|
Range | xsd:nonNegativeInteger |
The MOD build release number of a bundle. This number is auto-incremented everytime the cloud rebuilds or updates the plugin.
Instances
preferColouredListByDefault
Type | lv2:PortProperty |
---|
Indicates that, when addressing the port to a MOD device actuator, it is prefered to do so in the 'Cycle' LED colour mode
preferMomentaryOffByDefault
Type | lv2:PortProperty |
---|
Indicates that, when addressing the port to a MOD device actuator, it is prefered to do so in the 'Momentary Off' mode
preferMomentaryOnByDefault
Type | lv2:PortProperty |
---|
Indicates that, when addressing the port to a MOD device actuator, it is prefered to do so in the 'Momentary On' mode
tapTempo
Type | lv2:PortProperty |
---|
Indicates that the port is suitable for a MOD foot-switch addressing, by using hardware-side tap tempo. Please note that a unit of time is required on the port for tap tempo to work properly. The supported unit types are 'ms', 's', 'Hz' and 'bpm'.
tempoRelatedDynamicScalePoints
Type | lv2:PortProperty |
---|
Indicates that the port is suitable for scale points related to musical tempo, e.g. 'quarter note'.
Please note that a unit of time is required on the port for tap tempo to work properly.
The supported unit types are 'ms', 's', 'min', 'Hz', 'MHz' and 'kHz'.
volts
Type | units:Unit |
---|---|
units:render | %f v |
units:symbol | v |
Volts as an LV2 unit type, often used for CV related ports.
History
- Version 1.3 (2020-09-03)
- Add mod:preferColouredListByDefault and mod:preferMomentary{On/Off}ByDefault properties.
- Remove mod:notStompboxCapable.
- Version 1.2 (2020-02-28)
- Add CVPort port type.
- Add volts unit.
- Add buildId and buildEnvironment for tracking origin of plugin build.
- Specify rdfs:range for mod:builderVersion and mod:releaseNumber.
- Version 1.1 (2019-03-27)
- Add ControlVoltagePlugin category.
- Add tempoRelatedDynamicScalePoints.
- Version 1.0 (2016-03-28)
- First stable release.
An lv2:CVPort with strict range restrictions.
Ports with the type mod:CVPort MUST define their minimum and maximum values. and those need to be within the possible 3 cases:
It is assumed these ports use mod:volts as unit.