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

Class tkmidi.MIDIIn


SynopsisRepresents 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 getDeviceName
Query MIDI device name
Signature
getDeviceName():String
Returns
StringMIDI device name

 
 top of page
Method GetDeviceName
Query device name by index (pseudo-static method)
Signature
GetDeviceName(intdevIdx)
 :String
Arguments
intdevIdxMIDI input device index (0..GetNumDevices())
Returns
StringDevice name string

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

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

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

 
 top of page
Method openById
Open MIDI input device by index
Signature
openById(intdevIdx)
 :boolean
Arguments
intdevIdxIndex of the input device
Returns
booleantrue(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
StringdevNameName of the input device (platform dependent)
Returns
booleantrue(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 start
Start input event recording
Signature
start()

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

 
 top of page
 

Project Modules:tkmidi 
Project Classes:MIDIIn , MIDIOut , 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. Sat, 31/Dec/2011 16:12:19