Firelight Technologies FMOD Studio API

System::registerDSP

Register a user-defined DSP effect for use with the System. This function allows you to register statically-linked DSP effects. Once registered, you can create instances of the DSP effect by using System::createDSPByPlugin.

C++ Syntax

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

C Syntax

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

C# Syntax

RESULT System.registerDSP(
  ref DSP_DESCRIPTION description,
  out uint handle
);

JavaScript Syntax

System.registerDSP(
  description,                     
  handle                           
);

Parameters

description

Address of an FMOD_DSP_DESCRIPTION structure, containing information about the DSP effect. Some members of FMOD_DSP_DESCRIPTION are referenced directly inside FMOD so the structure should be allocated statically or at least remain in memory for the lifetime of the system.

handle

Address of a variable to receive the plugin handle of the newly-registered DSP effect.

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

• FMOD_DSP_DESCRIPTION
• System::createDSPByPlugin
• System::getNumPlugins
• System::getPluginInfo
• System::registerCodec

Version 1.10.03 Built on Feb 1, 2018