Firelight Technologies FMOD Studio API

ChannelGroup::getDSP

Retrieve the DSP unit at the specified index.

C++ Syntax

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

C Syntax

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

C# Syntax

RESULT ChannelGroup.getDSP(
  int index,
  out DSP dsp
);

JavaScript Syntax

ChannelGroup.getDSP(
  index,                           
  dsp                              // writes value to dsp.val
);

Parameters

index

Offset into the DSP chain, see FMOD_CHANNELCONTROL_DSP_INDEX for special named offsets.

dsp

Address of a variable to receive a pointer to the requested DSP unit.

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.10.03 Built on Feb 1, 2018