Firelight Technologies FMOD Studio API

System::createDSPByType

Creates an FMOD defined built in DSP unit object to be inserted into a DSP network, for the purposes of sound filtering or sound generation.
This function is used to create special effects that come built into FMOD.

C++ Syntax

FMOD_RESULT System::createDSPByType(
  FMOD_DSP_TYPE type,
  FMOD::DSP **dsp
);

C Syntax

FMOD_RESULT FMOD_System_CreateDSPByType(
  FMOD_SYSTEM *system,
  FMOD_DSP_TYPE type,
  FMOD_DSP **dsp
);

C# Syntax

RESULT System.createDSPByType(
  DSP_TYPE type,
  out DSP dsp
);

JavaScript Syntax

System.createDSPByType(
  type,                            
  dsp                              // writes value to dsp.val
);

Parameters

type

A pre-defined DSP effect or sound generator described by a FMOD_DSP_TYPE.

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 Channel::addDSP, ChannelGroup::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.

Note! Winamp DSP and VST plugins will only return the first plugin of this type that was loaded!
To access all VST or Winamp DSP plugins the System::createDSPByPlugin function! Use the index returned by System::loadPlugin if you don't want to enumerate them all.

See Also

• FMOD_DSP_TYPE
• System::createDSP
• System::createDSPByPlugin
• System::loadPlugin
• Channel::addDSP
• ChannelGroup::addDSP
• DSP::addInput
• DSP::setActive

Version 1.10.03 Built on Feb 1, 2018