Firelight Technologies FMOD Studio API

ChannelGroup::setDSPIndex

Moves a DSP inside a Channelgroup's DSP chain.

C++ Syntax

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

C Syntax

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

Parameters

dsp

Address of a DSP unit that exists inside the ChannelGroup's DSP chain (added with ChannelGroup::addDSP) to be moved.

index

Index in the ChannelGroup's DSP chain to position the dsp. Must not equal or exceed value retrieved with ChannelGroup::getNumDSPs.

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

This function is useful for reordering DSP units inside a ChannelGroup, so that processing can happen in a certain order.
The unit specified must exist inside the ChannelGroup, or an error will be returned.
Verify the order using enumeration/iteration using ChannelGroup::getDSP or use the FMOD Studio Profiler tool which visualizes the units.
If a unit is specified at the location of an existing unit (as it always will be) then the existing unit's index is shifted down one.

See Also

• ChannelGroup::getDSPIndex
• ChannelGroup::getNumDSPs
• ChannelGroup::getDSP

Version 1.03.06 Built on Apr 17, 2014