Firelight Technologies FMOD Studio API

DSP::getParameterInfo

Retrieve information about a specified parameter within the DSP unit.

C++ Syntax

FMOD_RESULT DSP::getParameterInfo(
  int index,
  FMOD_DSP_PARAMETER_DESC **desc
);

C Syntax

FMOD_RESULT FMOD_DSP_GetParameterInfo(
  FMOD_DSP *dsp,
  int index,
  FMOD_DSP_PARAMETER_DESC **desc
);

C# Syntax

RESULT DSP.getParameterInfo(
  int index,
  out DSP_PARAMETER_DESC desc
);

JavaScript Syntax

DSP.getParameterInfo(
  index,                           
  desc                             // writes value to desc.val
);

Parameters

index

Parameter index for this unit. Find the number of parameters with DSP::getNumParameters.

desc

Address of a variable to receive the contents of an array of FMOD_DSP_PARAMETER_DESC structures for this 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.

Remarks

Use DSP::getNumParameters to find out the number of parameters for this DSP unit.

See Also

• DSP::setParameterFloat
• DSP::setParameterInt
• DSP::setParameterBool
• DSP::setParameterData
• DSP::getParameterFloat
• DSP::getParameterInt
• DSP::getParameterBool
• DSP::getParameterData
• DSP::getNumParameters

Version 1.10.03 Built on Feb 1, 2018