This is a vocabulary for describing extra plugin data specific to MOD software and devices.

Reference

ClassesPropertiesInstances

Classes

CVPort

Subclass oflv2:CVPort
MOD CV Port

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:

  • - Unipolar mode (minimum: -10, maximum: 0)
  • Bipolar mode (minimum: -5, maximum: +5)
  • + Unipolar mode (minimum: 0, maximum: +10)

It is assumed these ports use mod:volts as unit.

ControlVoltagePlugin

Subclass oflv2:Plugin
Control Voltage

Forces Control Voltage as the plugin category.

DelayPlugin

Subclass oflv2:Plugin
Delay

Forces Delay as the plugin category.

DistortionPlugin

Subclass oflv2:Plugin
Distortion

Forces Distortion as the plugin category.

DynamicsPlugin

Subclass oflv2:Plugin
Dynamics

Forces Dynamics as the plugin category.

FilterPlugin

Subclass oflv2:Plugin
Filter

Forces Filter as the plugin category.

GeneratorPlugin

Subclass oflv2:Plugin
Generator

Forces Generator as the plugin category.

MIDIPlugin

Subclass oflv2:Plugin
MIDI Utility

Forces MIDI Utility as the plugin category.

MaxGenPlugin

Subclass oflv2:Plugin
MAX gen~ Plugin

A plugin made with MAX gen~ export function.

ModulatorPlugin

Subclass oflv2:Plugin
Modulator

Forces Modulator as the plugin category.

ReverbPlugin

Subclass oflv2:Plugin
Reverb

Forces Reverb as the plugin category.

SimulatorPlugin

Subclass oflv2:Plugin

Forces Simulator as the plugin category.

SpatialPlugin

Subclass oflv2:Plugin
Spatial

Forces Spatial as the plugin category.

SpectralPlugin

Subclass oflv2:Plugin
Spectral

Forces Spectral as the plugin category.

UtilityPlugin

Subclass oflv2:Plugin
Utility

Forces Utility as the plugin category.

Properties

brand

TypeDatatype Property
Rangexsd:string
brand

A short plugin brand name. Maximum of 11 characters

buildEnvironment

TypeDatatype Property
cloud build environment

The environment of the MOD cloud builder used to compile a plugin. MUST be 'prod', 'dev' or 'labs'.

buildId

TypeDatatype Property
cloud build id

The id for build process the MOD cloud builder used to compile a plugin.

builderVersion

TypeDatatype Property
Rangexsd:nonNegativeInteger
builder version

The version of the MOD cloud builder used to compile a plugin.

default

TypeDatatype Property
rdfs:seeAlso lv2:default
default

A custom default value specific to MOD devices, used in place of lv2:default.

fileTypes

TypeDatatype Property
file types

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

TypeDatatype Property
Rangexsd:string
label

A short plugin label. Maximum of 16 characters

maximum

TypeDatatype Property
rdfs:seeAlso lv2:maximum
maximum

A custom maximum value specific to MOD devices, used in place of lv2:maximum.

minimum

TypeDatatype Property
rdfs:seeAlso lv2:minimum
minimum

A custom minimum value specific to MOD devices, used in place of lv2:minimum.

rangeSteps

Domainlv2:Port
Rangexsd:nonNegativeInteger
rdfs:seeAlso pprops:rangeSteps
number of value steps

A custom rangeSteps value specific to MOD devices, used in place of pprops:rangeSteps.

rawMIDIClockAccess

Domainatom:AtomPort
access raw midi clock

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

TypeDatatype Property
Rangexsd:nonNegativeInteger
release number

The MOD build release number of a bundle. This number is auto-incremented everytime the cloud rebuilds or updates the plugin.

Instances

preferColouredListByDefault

Typelv2:PortProperty
preferColouredListByDefault

Indicates that, when addressing the port to a MOD device actuator, it is prefered to do so in the 'Cycle' LED colour mode

preferMomentaryOffByDefault

Typelv2:PortProperty
preferMomentaryOffByDefault

Indicates that, when addressing the port to a MOD device actuator, it is prefered to do so in the 'Momentary Off' mode

preferMomentaryOnByDefault

Typelv2:PortProperty
preferMomentaryOnByDefault

Indicates that, when addressing the port to a MOD device actuator, it is prefered to do so in the 'Momentary On' mode

tapTempo

Typelv2:PortProperty
tap tempo

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

Typelv2:PortProperty
tempo related dynamic scale points

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

Typeunits:Unit
units:render %f v
units:symbol v
volts

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.