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
);

Parameters

handle
Handle to a pre-existing DSP plugin.
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.




Version 1.03.06 Built on Apr 17, 2014