Firelight Technologies FMOD Studio API

System::getPluginInfo

Retrieves information to display for the selected plugin.

C++ Syntax

FMOD_RESULT System::getPluginInfo(
  unsigned int handle,
  FMOD_PLUGINTYPE *plugintype,
  char *name,
  int namelen,
  unsigned int *version
);

C Syntax

FMOD_RESULT FMOD_System_GetPluginInfo(
  FMOD_SYSTEM *system,
  unsigned int handle,
  FMOD_PLUGINTYPE *plugintype,
  char *name,
  int namelen,
  unsigned int *version
);

C# Syntax

RESULT System.getPluginInfo(
  uint handle,
  out PLUGINTYPE plugintype,
  StringBuilder name,
  int namelen,
  out uint version
);

JavaScript Syntax

System.getPluginInfo(
  handle,                          
  plugintype,                      // writes value to plugintype.val
  name,                            // writes value to name.val
  version                          // writes value to version.val
);

Parameters

handle

Handle to a pre-existing plugin.

plugintype

Address of a variable that receives the type of the plugin, FMOD_PLUGINTYPE_OUTPUT, FMOD_PLUGINTYPE_CODEC or FMOD_PLUGINTYPE_DSP.

name

Address of a variable that receives the name of the plugin.

namelen

Length in bytes of the target buffer to receieve the string.

version

Address of a variable that receives the version number set by the plugin.

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

JavaScript only :

Note: For the "name" parameter, the maximum string length is 512.

See Also

• FMOD_PLUGINTYPE
• System::getNumPlugins

Version 1.10.03 Built on Feb 1, 2018