Miles Sound System SDK 7.2a

AIL_timbre_status

The function AIL_timbre_status checks to see if a given timbre (synthesizer instrument) is loaded.

S32 AIL_timbre_status(
  HMDIDRIVER mdi,
  S32 bank,
  S32 patch
);

In Parameters

mdi: indicates the driver whose supported device is to be checked.
bank: specifies the XMIDI Patch Bank Select (controller 114) value associated with the desired timbre.
patch: specifies the MIDI Program Change value associated with the desired timbre.

Returns

0 if the timbre bank, patch is not present in the synthesizer memory or local timbre cache associated with driver mdi; otherwise, a non-zero value is returned.

Discussion

General MIDI synthesizers with built-in (ROM) timbres, such as the Roland Sound Canvas, will always return a non-zero value for timbres in bank 0. This is because the 128 possible timbres in bank 0 are mapped directly to the synthesizer's built-in instrument timbres.

This function may be useful by applications which play note-based sound effects with custom timbres. It allows the application to avoid the time delay involved in accessing the Global Timbre Library file and uploading a timbre when the timbre is already present in the local timbre cache. Most application programs, however, will not need to call AIL_timbre_status.

Under DOS, this function must not be invoked from an interrupt-based callback function.

The current version of the Windows and MacOS system does not support custom MIDI instruments. The default MIDI instrument set used by the selected midiOut driver will be used instead.

Group: XMIDI Services
Related Functions: AIL_install_timbre, AIL_protect_timbre, AIL_timbre_status, AIL_unprotect_timbre
Related Basic Types: HMDIDRIVER, S32