Firelight Technologies FMOD Studio API

ChannelGroup::addDSP

Add a pre-created DSP unit to the head of the DSP chain.

C++ Syntax

FMOD_RESULT ChannelGroup::addDSP(
  int index,
  DSP *dsp,
  DSPConnection **dspconnection
);

C Syntax

FMOD_RESULT FMOD_ChannelGroup_AddDSP(
  FMOD_CHANNELGROUP *channelgroup,
  int index,
  FMOD_DSP *dsp,
  FMOD_DSPCONNECTION **dspconnection
);

Parameters

index

Offset to add this DSP at in the DSP chain, see FMOD_CHANNELCONTROL_DSP_INDEX for special named offsets.

dsp

Pointer to a pre-created DSP unit to be inserted at the specified offset.

dspconnection

Address of a variable that receives the DSP connection between the specified dsp unit and its parent. Optional, specify 0 or NULL to ignore.

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

The connection pointer retrieved here will become invalid if you disconnect the 2 dsp units that use it.

See Also

• System::createDSP
• System::createDSPByType
• System::createDSPByPlugin
• ChannelControl::getDSP
• ChannelControl::removeDSP
• ChannelControl::getNumDSPs
• FMOD_CHANNELCONTROL_DSP_INDEX

Version 1.03.06 Built on Apr 17, 2014