1
2 """
3 This is the documentation for the midi package
4 ==============================================
5
6
7 The modules follows the following naming convention:
8
9
10 MidiIn<StreamType>.py
11 ---------------------
12
13 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.
14
15
16 MidiOut<StreamType>.py
17 ----------------------
18
19 The MidiOut modules are event handlers, that reacts to events generated by a a Midi in module.
20
21
22 MidiInBase.py
23 ---------------
24
25 The base class for input streams.
26
27
28 MidiOutBase.py
29 ----------------
30
31 The base class for the output streams.
32
33
34
35
36
37
38 Internal modules
39 ================
40
41
42 DataTypeConverters.py
43 ---------------------
44
45 A collection of functions that converts the special data types used in midi files to and from strings.
46
47
48 constants.py
49 ------------
50
51 A collection of constants from the midi spec.
52
53 """
54
55
56
57
58