Skip to content

Commit

Permalink
Fix MidiFile doc references
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
Xrayez committed Dec 5, 2021
1 parent d26d210 commit 6fbeee8
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/MidiFile.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
</brief_description>
<description>
This is a resource which represents the internal MIDI data used by [MidiPlayer]. Depending on the file type, format will be set accordingly.
To load data into the MidiPlayer simply call on [method MidiPlayer.load_midi] or [method MidiPlayer.set_midi] for a midi file or [method MidiPlayer.load_soundfont] or [method MidiPlayer.set_soundfont] for a SoundFont file.
[b]Note[/b]: It is not recommended that you set byte data directly using [method=set_data] or change the format using [method=set_format]. These methods are more useful when loading midi data from a [File] and you need to set byte data and format manually.
To load data into the MidiPlayer simply call on [method MidiPlayer.load_midi] or set [member MidiPlayer.midi] property for a MIDI file or [method MidiPlayer.load_soundfont] or [member MidiPlayer.soundfont] property for a SoundFont file.
[b]Note[/b]: It is not recommended that you set byte [member data] or change the [member format]. These properties are more useful when loading MIDI data from a [File] and you need to set byte data and format manually.
</description>
<tutorials>
</tutorials>
Expand All @@ -17,7 +17,7 @@
A stream of bytes which represents MIDI data. This data is not meant to be modified, as MIDI files are imported automatically.
</member>
<member name="format" type="int" setter="set_format" getter="get_format" default="0">
Represents the internal format of the Midi data. This is set automatically when data gets set.
Represents the internal format of the MIDI data. This is set automatically when data gets set.
</member>
</members>
<constants>
Expand Down

0 comments on commit 6fbeee8

Please sign in to comment.