Copyright © 2005-2018 MultiMedia Soft

MIDI.SoundFontLoad method

Previous pageReturn to chapter overviewNext page

Remarks

 

Loads in memory presets from a sound font allowing to avoid CPU spikes during playback of MIDI streams. Loaded presets can be unloaded at a later from memory using the MIDI.SoundFontUnload method.

 

For further details about the use of MIDI protocol see the MIDIMan class section and the How to deal with MIDI protocol tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function SoundFontLoad (

nUniqueId As Int32,

nPreset as Int32,

nBank as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes SoundFontLoad (

Int32 nUniqueId,

Int32 nPreset,

Int32 nBank

);


 

[C++]

public: enumErrorCodes SoundFontLoad (

Int32 nUniqueId,

Int32 nPreset,

Int32 nBank

);


 

 

 

Parameter

Description

 

 

nUniqueId

Number representing the unique identifier of the MIDI SoundFont as returned by a previous call to one between the MIDI.SoundFontInit or MIDI.SoundFontInitFromMemory or MIDI.SoundFontInitFromMemory methods.

nPreset

The preset number to load. If this parameter is set to -1, all presets are loaded.

nBank

The bank number to load. If this parameter is set to -1, all banks are loaded.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.