Firelight Technologies FMOD Studio API

System::createDSP

Creates a user defined DSP unit object to be inserted into a DSP network, for the purposes of sound filtering or sound generation.

C++ Syntax

FMOD_RESULT System::createDSP(
  const FMOD_DSP_DESCRIPTION *description,
  FMOD::DSP **dsp
);

C Syntax

FMOD_RESULT FMOD_System_CreateDSP(
  FMOD_SYSTEM *system,
  const FMOD_DSP_DESCRIPTION *description,
  FMOD_DSP **dsp
);

Parameters

description
Address of an FMOD_DSP_DESCRIPTION structure containing information about the unit to be created. 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.
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.
The data is created or filtered through use of the read callback that is defined by the user.
See the definition for the FMOD_DSP_DESCRIPTION structure to find out what each member means.
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




Version 1.03.06 Built on Apr 17, 2014