simMIDI Plugin API reference

simMIDI.closeMidiIn
simMIDI.closeMidiOut
simMIDI.getMessage
simMIDI.ignoreTypes
simMIDI.openMidiIn
simMIDI.openMidiOut
simMIDI.processIncomingMessages
simMIDI.sendMessage

simMIDI.closeMidiIn

Lua synopsis simMIDI.closeMidiIn(string inputPortHandle)
Lua parameters
inputPortHandle (string):
Lua return values -
Python synopsis simMIDI.closeMidiIn(string inputPortHandle)

simMIDI.closeMidiOut

Lua synopsis simMIDI.closeMidiOut(string outputPortHandle)
Lua parameters
outputPortHandle (string):
Lua return values -
Python synopsis simMIDI.closeMidiOut(string outputPortHandle)

simMIDI.getMessage

Lua synopsis int[] messageData = simMIDI.getMessage(string inputPortHandle)
Lua parameters
inputPortHandle (string):
Lua return values
messageData (table of int):
Python synopsis list messageData = simMIDI.getMessage(string inputPortHandle)

simMIDI.ignoreTypes

Lua synopsis simMIDI.ignoreTypes(string inputPortHandle, bool sysex, bool timing, bool activeSensing)
Lua parameters
inputPortHandle (string):
sysex (bool):
timing (bool):
activeSensing (bool):
Lua return values -
Python synopsis simMIDI.ignoreTypes(string inputPortHandle, bool sysex, bool timing, bool activeSensing)

simMIDI.openMidiIn

Lua synopsis string inputPortHandle = simMIDI.openMidiIn(int inputPortIndex)
Lua parameters
inputPortIndex (int):
Lua return values
inputPortHandle (string):
Python synopsis string inputPortHandle = simMIDI.openMidiIn(int inputPortIndex)

simMIDI.openMidiOut

Lua synopsis string outputPortHandle = simMIDI.openMidiOut(int outputPortIndex)
Lua parameters
outputPortIndex (int):
Lua return values
outputPortHandle (string):
Python synopsis string outputPortHandle = simMIDI.openMidiOut(int outputPortIndex)

simMIDI.processIncomingMessages

Description Process incoming messages on given input port, on the specified channels (or all channels) passing the data to the handlers specified in the third argument.
Lua synopsis simMIDI.processIncomingMessages(string midiInPortHandle, int[] channels, table funcs)
Lua parameters
midiInPortHandle (string): handle of a MIDI input device
channels (table of int): a list of MIDI channels, or if nil all channels from 1 to 16 will be used
funcs (table): a map of functions, e.g. {onNoteOn = function(note, velocity) ... end, onNoteOff = function(note, velocity) ... end, onPolyAftertouch = function(note, value) ... end, onControlChange = function(cc, value) ... end, onChannelAftertouch = function(v) ... end, onPitchBend = function(p) ... end, onMessage = function(m1, m2, m3) ... end} all keys are optional
Lua return values -
Python synopsis simMIDI.processIncomingMessages(string midiInPortHandle, list channels, list funcs)

simMIDI.sendMessage

Lua synopsis simMIDI.sendMessage(string outputPortHandle, int[] messageData)
Lua parameters
outputPortHandle (string):
messageData (table of int):
Lua return values -
Python synopsis simMIDI.sendMessage(string outputPortHandle, list messageData)