Firelight Technologies FMOD Studio API

System::loadPlugin

Loads an FMOD plugin. This could be a DSP, file format or output plugin.

C++ Syntax

FMOD_RESULT System::loadPlugin(
  const char *filename,
  unsigned int *handle,
  unsigned int priority
);

C Syntax

FMOD_RESULT FMOD_System_LoadPlugin(
  FMOD_SYSTEM *system,
  const char *filename,
  unsigned int *handle,
  unsigned int priority
);

C# Syntax

RESULT System.loadPlugin(
  string filename,
  out uint handle
);

JavaScript Syntax

System.loadPlugin(
);

Parameters

filename

Filename of the plugin to be loaded encoded in a UTF-8 string.

handle

Pointer to an unsigned int to receive the plugin handle, for later use.

priority

FMOD_PLUGINTYPE_CODEC only, priority of the codec compared to other codecs. 0 = most important, higher numbers = less importance.

Return Values

If the function succeeds then the return value is FMOD_OK.
If the function fails then the return value will be one of the values defined in the FMOD_RESULT enumeration.

Remarks

Plugins can be created for FMOD by the user, see the relevant section in the documentation on creating plugins.

Once the plugin is loaded, it can be enumerated and used. For file format plugins, FMOD will automatically try to use them during System::createSound. For DSP plugins, you can enumerate them with System::getNumPlugins, System::getPluginHandle and System::getPluginInfo.

The format of the plugin is dependant on the operating system:

• Windows uses .dll
• Linux uses .so
• Macintosh uses .dylib

JavaScript only :

This function is not currently supported

See Also

• System::setPluginPath
• System::unloadPlugin
• System::getNumPlugins
• System::getPluginHandle
• System::getPluginInfo
• System::setOutputByPlugin
• System::getOutputByPlugin
• System::createDSPByPlugin
• System::createSound
• FMOD_PLUGINTYPE

Version 1.10.03 Built on Feb 1, 2018