Firelight Technologies FMOD Studio API
System::getNumNestedPlugins
Returns the number of plugins nested in the one plugin file.
C++ Syntax
FMOD_RESULT System::getNumNestedPlugins(
unsigned int handle,
int *count
);
C Syntax
FMOD_RESULT FMOD_System_GetNumNestedPlugins(
FMOD_SYSTEM *system,
unsigned int handle,
int *count
);
C# Syntax
RESULT System.getNumNestedPlugins(
uint handle,
out int count
);
JavaScript Syntax
System.getNumNestedPlugins(
handle,
count // writes value to count.val
);
Parameters
- handle
- Handle obtained from System::loadPlugin.
- count
- Returned number of plugins.
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 normally have a single definition in them, in which case the count is always 1.
For plugins that have a list of definitions, this function returns the number of plugins that have been defined. System::getNestedPlugin can be used to find each handle.
See the DSP Plugin API Programmer Topic for more information.
See Also
Version 1.10.03 Built on Feb 1, 2018