Firelight Technologies FMOD Studio API

Channel::getDSPIndex

Retrieves the index in the DSP chain of the provided DSP.

C++ Syntax

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

C Syntax

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

C# Syntax

RESULT Channel.getDSPIndex(
  DSP dsp,
  out int index
);

JavaScript Syntax

Channel.getDSPIndex(
  dsp,                             
  index                            // writes value to index.val
);

Parameters

dsp

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

index

Address of a variable to receive the offset in the DSP chain of the specified DSP.

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::setDSPIndex

Version 1.10.03 Built on Feb 1, 2018