Firelight Technologies FMOD Studio API

ChannelGroup::setDSPIndex

Moves the position in the DSP chain of a specified DSP unit.

C++ Syntax

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

C Syntax

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

C# Syntax

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

JavaScript Syntax

ChannelGroup.setDSPIndex(
  dsp,                             
  index                            
);

Parameters

dsp

Pointer to a DSP unit that exists in the DSP chain.

index

Offset in the DSP chain to move the DSP to, see FMOD_CHANNELCONTROL_DSP_INDEX for special named offsets.

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 Channel or ChannelGroup so that processing can happen in the desired order.

You can verify the order of the DSP chain using iteration via ChannelControl::getNumDSPs and ChannelControl::getDSP or with the FMOD Profiler tool.

See Also

• ChannelControl::getDSPIndex
• ChannelControl::getNumDSPs
• ChannelControl::getDSP
• FMOD_CHANNELCONTROL_DSP_INDEX

Version 1.10.03 Built on Feb 1, 2018