Firelight Technologies FMOD Studio API

DSP::getType

Retrieves the pre-defined type of a FMOD registered DSP unit.

C++ Syntax

FMOD_RESULT DSP::getType(
  FMOD_DSP_TYPE *type
);

C Syntax

FMOD_RESULT FMOD_DSP_GetType(
  FMOD_DSP *dsp,
  FMOD_DSP_TYPE *type
);

C# Syntax

RESULT DSP.getType(
  out DSP_TYPE type
);

JavaScript Syntax

DSP.getType(
  type                             // writes value to type.val
);

Parameters

type

Address of a variable to receive the FMOD dsp type.

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

This is only valid for built in FMOD effects. Any user plugins will simply return FMOD_DSP_TYPE_UNKNOWN.

See Also

• FMOD_DSP_TYPE

Version 1.10.03 Built on Feb 1, 2018