Firelight Technologies FMOD Studio API

System::createDSPByPlugin

Creates a DSP unit object which is either built in or loaded as a plugin, to be inserted into a DSP network, for the purposes of sound filtering or sound generation.
This function creates a DSP unit that can be enumerated by using System::getNumPlugins and System::getPluginInfo.

C++ Syntax

FMOD_RESULT System::createDSPByPlugin(
  unsigned int handle,
  FMOD::DSP **dsp
);

C Syntax

FMOD_RESULT FMOD_System_CreateDSPByPlugin(
  FMOD_SYSTEM *system,
  unsigned int handle,
  FMOD_DSP **dsp
);

C# Syntax

RESULT System.createDSPByPlugin(
  uint handle,
  out DSP dsp
);

JavaScript Syntax

System.createDSPByPlugin(
  handle,                          
  dsp                              // writes value to dsp.val
);

Parameters

handle

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

dsp

Address of a variable to receive a newly created FMOD::DSP object.

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

A DSP unit can generate or filter incoming data.
To be active, a unit must be inserted into the FMOD DSP network to be heard. Use functions such as ChannelGroup::addDSP, Channel::addDSP or DSP::addInput to do this.
For more information and a detailed description (with diagrams) see the tutorial on the DSP system in the documentation.

See Also

• System::getNumPlugins
• System::getPluginInfo
• System::createDSPByType
• System::createDSP
• ChannelGroup::addDSP
• Channel::addDSP
• DSP::addInput
• DSP::setActive

Version 1.10.03 Built on Feb 1, 2018