Firelight Technologies FMOD Studio API

ChannelGroup::getDSPIndex

Retrieves the index inside the ChannelGroup DSP chain.

C++ Syntax

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

C Syntax

FMOD_RESULT FMOD_ChannelGroup_GetDSPIndex(
  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).

index

Address of a variable to receive the index into the ChannelGroup's DSP chain.

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 unit specified must exist inside the ChannelGroup, or an error will be returned.

See Also

• ChannelGroup::setDSPIndex
• ChannelGroup::addDSP

Version 1.03.06 Built on Apr 17, 2014