Ksp reference Manual

MIDI Object Commands
142
KSP Reference Manual

---

16.2. mf_insert_file()
mf_insert_file(
,,
tion-offset>,)
Inserts a MIDI file into the object
The absolute path of the MIDI file, including the file name

Applies a track offset to the MIDI data
Applies a position offset, in ticks, to the MIDI data

Defines the mode of insertion:
0:
Replace all existing events
1:
Replace only overlapping events
2:
Merge all events
Remarks
• The loading of MIDI files with this command is asynchronous, so it is advised to use the
async_complete
callback to check the status of the load. However, the 
async_complete
callback will not be called if this command is used in the init callback.
• This command will pair Note On and Note Off events to a single Note On with a Note Length
parameter. The Note Off events will be discarded.
Example
(see next page)
on init
declare @file_name
declare @filepath
@file_name := "test.mid"
@filepath := get_folder($GET_FOLDER_FACTORY_DIR) & @file_name
declare $load_mf_id
declare ui_button $load_file
end on
on ui_control($load_file)
$load_mf_id := mf_insert_file(@filepath,0,0,0)
end on
on async_complete
if ($NI_ASYNC_ID = $load_mf_id)
$load_mf_id := -1
if ($NI_ASYNC_EXIT_STATUS = 0)
message("FATAL ERROR: MIDI file not found!")
else