Firelight Technologies FMOD Studio API

Channel::getDSP

Retrieve a DSP unit based on an index. The index represents an offset into the chain of DSPs added with ChannelControl::addDSP.

C++ Syntax

FMOD_RESULT Channel::getDSP(
  int index,
  DSP **dsp
);

C Syntax

FMOD_RESULT FMOD_Channel_GetDSP(
  FMOD_CHANNEL *channel,
  int index,
  FMOD_DSP **dsp
);

Parameters

index

Index into the linear DSP chain within the Channel or ChannelGroup. The first added DSP with ChannelControl::addDSP would be represented by index 0.

dsp

Address of a variable to receive a pointer to a DSP unit upon completion.

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

• ChannelControl::addDSP
• ChannelControl::removeDSP
• ChannelControl::getNumDSPs
• FMOD_CHANNELCONTROL_DSP_INDEX

Version 1.03.06 Built on Apr 17, 2014