Firelight Technologies FMOD Studio API

ChannelGroup::addDSP

Add a pre-created DSP unit to the specified index in the DSP chain.

C++ Syntax

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

C Syntax

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

C# Syntax

RESULT ChannelGroup.addDSP(
  int index,
  DSP dsp
);

JavaScript Syntax

ChannelGroup.addDSP(
  index,                           
  dsp                              
);

Parameters

index

Offset to add this DSP unit 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.

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

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

Version 1.10.03 Built on Feb 1, 2018