Firelight Technologies FMOD Studio API

DSP::getIdle

Retrieves the idle state of a DSP. A DSP is idle when no signal is coming into it. This can be a useful method of determining if a DSP sub branch is finished processing, so it can be disconnected for example.

C++ Syntax

FMOD_RESULT DSP::getIdle(
  bool *idle
);

C Syntax

FMOD_RESULT FMOD_DSP_GetIdle(
  FMOD_DSP *dsp,
  FMOD_BOOL *idle
);

C# Syntax

RESULT DSP.getIdle(
  out bool idle
);

JavaScript Syntax

DSP.getIdle(
  idle                             // writes value to idle.val
);

Parameters

idle

Address of a variable to receive the idle state for the 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.

Remarks

The idle state takes into account things like tails of echo filters, even if a wavetable or dsp has finished generating sound. When all nodes in a graph have finished processing, only then will it set the top level DSP state to idle.

Version 1.10.03 Built on Feb 1, 2018