→ home
 
→ index of namespace default
 
→ index of project tkmidi
 
→ index of module tkmidi

Class tkmidi.MIDIIn

Synopsis: Represents a MIDI input device.  

  Base classes:
  Methods: Description:


 
The MIDIIn class uses a ring buffer to record incoming MIDI events.
Each event is time-stamped for later evaluation in e.g. a sequencer application.


 
→ top of page
Method clearEvents
Discard previously recorded MIDI events
Signature
clearEvents()

 
→ top of page
Method close
Close MIDI device
Signature
close()

 
→ top of page
Method getDeviceIdx
Return device index.
Signature
getDeviceIdx():int
Returns
int–
Description

This can be used for finding the matching output device for an input device.

 
→ top of page
Method getDeviceName
Query MIDI device name
Signature
getDeviceName():String
Returns
String–MIDI device name

 
→ top of page
Method GetDeviceNameByIdx
Query device name by index (pseudo-static method)
Signature
GetDeviceNameByIdx(intdevIdx)
 :String
Arguments
intdevIdx–MIDI input device index (0..GetNumDevices())
Returns
String–Device name string

 
→ top of page
Method getEnableParam
Query (N)RPN parser state (on/off).
Signature
getEnableParam():boolean
Returns
boolean–true if parser is currently enabled

 
→ top of page
Method getFltCC
Query continuous controller filter.
Signature
getFltCC():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltChannelPressure
Query channel pressure filter.
Signature
getFltChannelPressure():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltNoteOff
Query note-off filter.
Signature
getFltNoteOff():boolean
Returns
boolean–true if note off filter is currently enabled

 
→ top of page
Method getFltNoteOn
Query note-on filter.
Signature
getFltNoteOn():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltNrpn
Query NRPN filter.
Signature
getFltNrpn():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltNrpnSelect
Query NRPN select filter.
Signature
getFltNrpnSelect():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltPitchbend
Query pitch bend filter.
Signature
getFltPitchbend():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltPolyPressure
Query polyphonic key pressure filter.
Signature
getFltPolyPressure():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltProgramChange
Query program change filter.
Signature
getFltProgramChange():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltRpn
Query RPN filter.
Signature
getFltRpn():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltRpnSelect
Query RPN select filter.
Signature
getFltRpnSelect():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysComSongPosition
Query system common song position filter.
Signature
getFltSysComSongPosition():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysComSongSelect
Query system common song select filter.
Signature
getFltSysComSongSelect():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysComTimeCode
Query system common MIDI quarter tick time code filter.
Signature
getFltSysComTimeCode():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysComTuneRequest
Query system common tune request filter.
Signature
getFltSysComTuneRequest():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysEx
Query system exclusive filter.
Signature
getFltSysEx():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysRTActiveSensing
Query system realtime active sensing filter.
Signature
getFltSysRTActiveSensing():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysRTContinue
Query system realtime continue filter.
Signature
getFltSysRTContinue():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysRTStart
Query system realtime start filter.
Signature
getFltSysRTStart():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysRTStop
Query system realtime stop filter.
Signature
getFltSysRTStop():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysRTSystemReset
Query system realtime system reset filter.
Signature
getFltSysRTSystemReset():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getFltSysRTTimingClock
Query system realtime timing clock filter.
Signature
getFltSysRTTimingClock():boolean
Returns
boolean–true if filter is currently enabled

 
→ top of page
Method getNextEvent
Return RecordedMIDIEvent* or null if no event is available
Signature
getNextEvent():RecordedMIDIEvent
Returns
RecordedMIDIEvent–Next MIDI event or null

 
→ top of page
Method getNrpn
Query last seen NRPN.
Signature
getNrpn():short
Returns
short–NRPN or -1 if RPN is (possibly) active

 
→ top of page
Method GetNumDevices
Query number of available MIDI input devices (pseudo-static method)
Signature
GetNumDevices():int
Returns
int–Number of available MIDI input devices

 
→ top of page
Method getNumEvent
Query number of recorded input events
Signature
getNumEvent():int
Returns
int–Number of recorded input events

 
→ top of page
Method getRpn
Query last seen RPN.
Signature
getRpn():short
Returns
short–RPN or -1 if NRPN is (possibly) active

 
→ top of page
Method openByIdx
Open MIDI input device by index
Signature
openByIdx(intdevIdx)
 :boolean
Arguments
intdevIdx–Index of the input device
Returns
boolean–true(1) if the device has been opened, false(0) if an error occured.

 
→ top of page
Method openByName
Open MIDI input device by name
Signature
openByName(StringdevName)
 :boolean
Arguments
StringdevName–Name of the input device (platform dependent)
Returns
boolean–true(1) if the device has been opened, false(0) if an error occured.

 
→ top of page
Method reset
Reset MIDI device
Signature
reset()

 
→ top of page
Method setEnableParam
Switch (N)RPN parser on or off.
Signature
setEnableParam(boolean)
Arguments
boolean–

 
→ top of page
Method setFltCC
Configure continuous controller filter.
Signature
setFltCC(boolean)
Arguments
boolean–

 
→ top of page
Method setFltChannelPressure
Configure channel pressure filter.
Signature
setFltChannelPressure(boolean)
Arguments
boolean–

 
→ top of page
Method setFltNoteOff
Configure note-off filter.
Signature
setFltNoteOff(boolean)
Arguments
boolean–

 
→ top of page
Method setFltNoteOn
Configure note-off filter.
Signature
setFltNoteOn(boolean)
Arguments
boolean–

 
→ top of page
Method setFltNrpn
Configure NRPN filter.
Signature
setFltNrpn(boolean)
Arguments
boolean–

 
→ top of page
Method setFltNrpnSelect
Configure NRPN select filter.
Signature
setFltNrpnSelect(boolean)
Arguments
boolean–

 
→ top of page
Method setFltPitchbend
Configure pitch bend filter.
Signature
setFltPitchbend(boolean)
Arguments
boolean–

 
→ top of page
Method setFltPolyPressure
Configure polyphonic key pressure filter.
Signature
setFltPolyPressure(boolean)
Arguments
boolean–

 
→ top of page
Method setFltProgramChange
Configure program change filter.
Signature
setFltProgramChange(boolean)
Arguments
boolean–

 
→ top of page
Method setFltRpn
Configure RPN filter.
Signature
setFltRpn(boolean)
Arguments
boolean–

 
→ top of page
Method setFltRpnSelect
Configure RPN select filter.
Signature
setFltRpnSelect(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysComSongPosition
Configure system common song position filter.
Signature
setFltSysComSongPosition(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysComSongSelect
Configure system common song select filter.
Signature
setFltSysComSongSelect(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysComTimeCode
Configure system common MIDI quarter tick time code filter.
Signature
setFltSysComTimeCode(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysComTuneRequest
Configure system common tune request filter.
Signature
setFltSysComTuneRequest(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysEx
Configure system exclusive filter.
Signature
setFltSysEx(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysRTActiveSensing
Configure system realtime active sensing filter.
Signature
setFltSysRTActiveSensing(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysRTContinue
Configure system realtime continue filter.
Signature
setFltSysRTContinue(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysRTStart
Configure system realtime start filter.
Signature
setFltSysRTStart(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysRTStop
Configure system realtime stop filter.
Signature
setFltSysRTStop(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysRTSystemReset
Configure system realtime system reset filter.
Signature
setFltSysRTSystemReset(boolean)
Arguments
boolean–

 
→ top of page
Method setFltSysRTTimingClock
Configure system realtime timing clock filter.
Signature
setFltSysRTTimingClock(boolean)
Arguments
boolean–

 
→ top of page
Method start
Start input event recording
Signature
start()

 
→ top of page
Method stop
Stop input event recording
Signature
stop()

 
→ top of page
Method waitNextEvent
Wait for next event and return RecordedMIDIEvent* or null if no event is available and the timeout expired.
Signature
waitNextEvent(inttimeout)
 :RecordedMIDIEvent
Arguments
inttimeout–Maximum wait time in milliseconds
Returns
RecordedMIDIEvent–Next MIDI event or null

 
→ top of page
 
Project Modules:tkmidi 
Project Classes:MIDIIn , MIDIOut , MIDITimer , RecordedMIDIEvent 
Project Functions:
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54