Firelight Technologies FMOD Studio API

System::getDSPInfoByPlugin

Retrieve the description structure for a pre-existing DSP plugin.

C++ Syntax

FMOD_RESULT System::getDSPInfoByPlugin(
  unsigned int handle,
  const FMOD_DSP_DESCRIPTION **description
);

C Syntax

FMOD_RESULT FMOD_System_GetDSPInfoByPlugin(
  FMOD_SYSTEM *system,
  unsigned int handle,
  const FMOD_DSP_DESCRIPTION **description
);

C# Syntax

RESULT System.getDSPInfoByPlugin(
  uint handle,
  out IntPtr description
);

JavaScript Syntax

System.getDSPInfoByPlugin(
  handle,                          
  description                      // writes value to description.val
);

Parameters

handle

Handle to a pre-existing DSP plugin, loaded by System::loadPlugin.

description

Address of a variable to receive the description structure for the DSP.

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

• System::loadPlugin

Version 1.10.03 Built on Feb 1, 2018