Firelight Technologies FMOD Studio API

DSP::setParameterData

Sets a DSP unit's binary data parameter by index. To find out the parameter names and range, see the see also field.

C++ Syntax

FMOD_RESULT DSP::setParameterData(
  int index,
  void *data,
  unsigned int length
);

C Syntax

FMOD_RESULT FMOD_DSP_SetParameterData(
  FMOD_DSP *dsp,
  int index,
  void *data,
  unsigned int length
);

C# Syntax

RESULT DSP.setParameterData(
  int index,
  byte[] data
);

JavaScript Syntax

DSP.setParameterData(
  index,                           
  data,                            
  length                           
);

Parameters

index

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

data

Data block parameter. This will be raw binary data to be passed to the DSP unit.

length

Length of data block in byte sbeing passed in.

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 parameter properties (such as min/max values) can be retrieved with DSP::getParameterInfo.

Certain data types are predefined by the system and can be specified via the FMOD_DSP_PARAMETER_DESC_DATA, see FMOD_DSP_PARAMETER_DATA_TYPE

See Also

• DSP::getParameterInfo
• DSP::getNumParameters
• DSP::getParameterData
• FMOD_DSP_PARAMETER_DATA_TYPE
• FMOD_DSP_OSCILLATOR
• FMOD_DSP_LOWPASS
• FMOD_DSP_ITLOWPASS
• FMOD_DSP_HIGHPASS
• FMOD_DSP_ECHO
• FMOD_DSP_FLANGE
• FMOD_DSP_DISTORTION
• FMOD_DSP_NORMALIZE
• FMOD_DSP_LIMITER
• FMOD_DSP_PARAMEQ
• FMOD_DSP_PITCHSHIFT
• FMOD_DSP_CHORUS
• FMOD_DSP_ITECHO
• FMOD_DSP_COMPRESSOR
• FMOD_DSP_SFXREVERB
• FMOD_DSP_LOWPASS_SIMPLE
• FMOD_DSP_DELAY
• FMOD_DSP_TREMOLO
• FMOD_DSP_SEND
• FMOD_DSP_RETURN
• FMOD_DSP_HIGHPASS_SIMPLE
• FMOD_DSP_PAN
• FMOD_DSP_THREE_EQ
• FMOD_DSP_FFT

Version 1.10.03 Built on Feb 1, 2018