Firelight Technologies FMOD Studio API

DSP::getDataParameterIndex

Retrieve the index of the first data parameter of a particular data type.

C++ Syntax

FMOD_RESULT DSP::getDataParameterIndex(
  int datatype,
  int *index
);

C Syntax

FMOD_RESULT FMOD_DSP_GetDataParameterIndex(
  FMOD_DSP *dsp,
  int datatype,
  int *index
);

C# Syntax

RESULT DSP.getDataParameterIndex(
  int datatype,
  out int index
);

JavaScript Syntax

DSP.getDataParameterIndex(
  datatype,                        
  index                            // writes value to index.val
);

Parameters

datatype

The type of data to find. This would usually be set to a value defined in FMOD_DSP_PARAMETER_DATA_TYPE but can be any value for custom types.

index

Contains the index of the first data parameter of type 'datatype' after the function is called. Will be -1 if no matches were found. Can be null.

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 function returns FMOD_OK if a parmeter of matching type is found and FMOD_ERR_INVALID_PARAM if no matches were found.

The return code can therefore be used to check whether the DSP supports specific functionality through data parameters of certain types without the need to pass in 'index'.

See Also

• FMOD_DSP_PARAMETER_DATA_TYPE

Version 1.10.03 Built on Feb 1, 2018