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
);

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.
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.

See Also




Version 1.03.06 Built on Apr 17, 2014