Skip to content

Commit 2dc4f95

Browse files
committed
add structure to README
1 parent ca18667 commit 2dc4f95

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,22 @@ trackData.events contains the midi events in the track, and each event has a sta
1717
MidiEvents.py.
1818
TrackData, MidiData, and Note may need to imported.
1919

20-
Structure (only intended output values listed):
21-
MidiData: contains all data for a midi file (created by calling MidiData("midi_file.mid")
22-
where "midi_file.mid" is the path to the midi file)
23-
getNumTracks(): number of tracks in the midi file
24-
tracks: list of TrackData (one TrackData for each track in the file)
25-
getTrack(index): returns the TrackData with the given index (ex. data.getTrack(1) to get the data for the second track)
20+
Structure (only intended output values listed):
21+
MidiData: contains all data for a midi file (created by calling MidiData("midi_file.mid") where "midi_file.mid" is the path to the midi file)
22+
* getNumTracks(): number of tracks in the midi file
23+
* tracks: list of TrackData (one TrackData for each track in the file)
24+
* getTrack(index): returns the TrackData with the given index (ex. data.getTrack(1) to get the data for the second track)
2625

27-
TrackData: contains all the data for a single track
28-
notes: list of Note (one Note for each note in the track)
29-
channel: channel
30-
events: list of MidiEvents that make up the track (see MidiEvents.py for definitions)
31-
name: name of the track
26+
TrackData: contains all the data for a single track
27+
* notes: list of Note (one Note for each note in the track)
28+
* channel: channel
29+
* events: list of MidiEvents that make up the track (see MidiEvents.py for definitions)
30+
* name: name of the track
3231

3332
Note:
34-
pitch: note number
35-
startTime: start time in ms
36-
endTime: end time in ms
37-
velocity: velocity
38-
releaseVelocity: release velocity
39-
length(): length of the note in ms
33+
* pitch: note number
34+
* startTime: start time in ms
35+
* endTime: end time in ms
36+
* velocity: velocity
37+
* releaseVelocity: release velocity
38+
length(): length of the note in ms

0 commit comments

Comments
 (0)