Firelight Technologies FMOD Studio API

System::getPluginHandle

Retrieves the handle of a plugin based on its type and relative index. Use System::getNumPlugins to enumerate plugins.

C++ Syntax

FMOD_RESULT System::getPluginHandle(
  FMOD_PLUGINTYPE plugintype,
  int index,
  unsigned int *handle
);

C Syntax

FMOD_RESULT FMOD_System_GetPluginHandle(
  FMOD_SYSTEM *system,
  FMOD_PLUGINTYPE plugintype,
  int index,
  unsigned int *handle
);

C# Syntax

RESULT System.getPluginHandle(
  PLUGINTYPE plugintype,
  int index,
  out uint handle
);

JavaScript Syntax

System.getPluginHandle(
  plugintype,                      
  index,                           
  handle                           // writes value to handle.val
);

Parameters

plugintype

The type of plugin type such as FMOD_PLUGINTYPE_OUTPUT, FMOD_PLUGINTYPE_CODEC or FMOD_PLUGINTYPE_DSP.

index

The relative index for the type of plugin.

handle

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.

See Also

• FMOD_PLUGINTYPE
• System::getNumPlugins

Version 1.10.03 Built on Feb 1, 2018