Firelight Technologies FMOD Studio API

System::getNestedPlugin

Returns nested plugin definition for the given index.

C++ Syntax

FMOD_RESULT System::getNestedPlugin(
  unsigned int handle,
  int index,
  unsigned int *nestedhandle
);

C Syntax

FMOD_RESULT FMOD_System_GetNestedPlugin(
  FMOD_SYSTEM *system,
  unsigned int handle,
  int index,
  unsigned int *nestedhandle
);

C# Syntax

RESULT System.getNestedPlugin(
  uint handle,
  int index,
  out uint nestedhandle
);

JavaScript Syntax

System.getNestedPlugin(
  handle,                          
  index,                           
  nestedhandle                     // writes value to nestedhandle.val
);

Parameters

handle

Handle obtained from System::loadPlugin.

index

Index into the list of plugin definitions.

nestedhandle

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

This function is used to iterate handles for plugins that have a list of definitions.

For plugins consisting of a single definition, only index 0 is valid and the returned handle is the same as the handle passed in.

See the DSP Plugin API Programmer Topic for more information.

See Also

• System::loadPlugin
• System::getNumNestedPlugins
• FMOD_PLUGINLIST

Version 1.10.03 Built on Feb 1, 2018