Firelight Technologies FMOD Studio API

DSP::getParameterBool

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

C++ Syntax

FMOD_RESULT DSP::getParameterBool(
  int index,
  bool *value,
  char *valuestr,
  int valuestrlen
);

C Syntax

FMOD_RESULT FMOD_DSP_GetParameterBool(
  FMOD_DSP *dsp,
  int index,
  FMOD_BOOL *value,
  char *valuestr,
  int valuestrlen
);

C# Syntax

RESULT DSP.getParameterBool(
  int index,
  out bool value
);

JavaScript Syntax

DSP.getParameterBool(
  index,                           
  value,                           // writes value to value.val
  valuestr                         // writes value to valuestr.val
);

Parameters

index

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

value

Address of a variable that receives the boolean parameter value for the parameter specified.

valuestr

Address of a variable that receives the string containing a formatted or more meaningful representation of the DSP parameter's value. For example if a switch parameter has on and off (0.0 or 1.0) it will display "ON" or "OFF" by using this parameter. Optional. Specify 0 or NULL to ignore.

valuestrlen

Length of the user supplied memory in bytes that valuestr will write to. This will not exceed 16 bytes.

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 can be retrieved with DSP::getParameterInfo.

JavaScript only :

Note: For the "valuestr" parameter, the maximum string length is 512.

See Also

• DSP::getParameterInfo
• DSP::getNumParameters
• DSP::setParameterBool
• 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