DSPConnection::getMix

FMOD Studio API

Firelight Technologies FMOD Studio API

DSPConnection::getMix

Retrieves the volume of the connection - the scale level of the input before being passed to the output.

C++ Syntax

FMOD_RESULT DSPConnection::getMix(
  float *volume
);

C Syntax

FMOD_RESULT FMOD_DSPConnection_GetMix(
  FMOD_DSPCONNECTION *dspconnection,
  float *volume
);

C# Syntax

RESULT DSPConnection.getMix(
  out float volume
);

JavaScript Syntax

DSPConnection.getMix(
  volume                           // writes value to volume.val
);

Parameters

volume
Address of a variable to receive the volume or mix level of the specified input. 0.0 = silent, 1.0 = full volume.

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.

See Also




Version 1.10.03 Built on Feb 1, 2018