d3c74314e402a42be9777bcb75aa8d65ef10c759
[minwii.git] / src / mxmMidi / readme.txt
1 This is the documentation for the midi package
2 ==============================================
3
4
5 The modules follows the following naming convention:
6
7
8 MidiIn<StreamType>.py
9 ---------------------
10
11 The MidiIn modules reads midi content for a specific type of stream. Ie. a file or a midi port. It then generates events and triggers them on a MidiOutStream.
12
13
14 MidiOut<StreamType>.py
15 ----------------------
16
17 The MidiOut modules are event handlers, that reacts to events generated by a a Midi in module.
18
19
20 MidiInBase.py
21 ---------------
22
23 The base class for input streams.
24
25
26 MidiOutBase.py
27 ----------------
28
29 The base class for the output streams.
30
31
32
33
34
35
36 Internal modules
37 ================
38
39
40 DataTypeConverters.py
41 ---------------------
42
43 A collection of functions that converts the special data types used in midi files to and from strings.
44
45
46 constants.py
47 ------------
48
49 A collection of constants from the midi spec.
50