Maestro - Midi Player Tool Kit for Unity Version 2.18.2
Loading...
Searching...
No Matches
Best Practices for External SoundFonts

Recommendations for using external SoundFonts efficiently and safely.

External SoundFonts provide flexibility, but they also introduce loading time, network dependency, and cache management concerns.

Cache Strategy

For frequently reused SoundFonts:

  • enable SaveToCache,
  • keep LoadFromCache enabled,
  • avoid unnecessary repeated downloads.

For test scenarios:

  • disable LoadFromCache to force a fresh download.

Callbacks

Always assign LoadedCallback when using asynchronous loading.

Use ProgressCallback to:

  • display loading progress,
  • update a loading indicator,
  • detect slow network conditions.

User Experience

When loading from a remote source:

  • show a progress indicator,
  • avoid assuming immediate availability,
  • defer preset browsing until loading is complete.

Activation

DownloadOnly can be used to retrieve a SoundFont without immediately activating it. This is useful when preparing assets ahead of time for later use.

See also
MidiPlayerTK.MPTKSoundFont.LoadFromCache
MidiPlayerTK.MPTKSoundFont.SaveToCache
MidiPlayerTK.MPTKSoundFont.DownloadOnly
MidiPlayerTK.MPTKSoundFont.Load