|
MIDI.SoundFontPresetDescGet method |
  
|
|
MIDI.SoundFontPresetDescGet method |
|
Remarks
Obtains a the friendly description of a preset available inside the given MIDI SoundFont.
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 SoundFontPresetDescGet ( nUniqueId As Int32, nPreset as Int32, nBank as Int32 ) as String |
[C#] public string SoundFontPresetDescGet ( Int32 nUniqueId, Int32 nPreset, Int32 nBank ); |
[C++] public: string SoundFontPresetDescGet ( 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. This parameter can be set to 0 when the request is related to the system default SoundFont. |
nPreset |
The preset number which may be in the range from 0 to 127. If this value is set to -1 the information will be related to the first encountered preset |
nBank |
The bank number. If this value is set to -1 the information will be related to the first encountered bank |
Return value
Value |
Meaning |
|
|
Empty string |
An error occurred (see the LastError property for further error details) |
Valid string |
String containing the preset friendly description. The returned string is empty when the preset is not available inside the given SoundFont |
