Firelight Technologies FMOD Studio API

FMOD_OUTPUT_READFROMMIXER

Called by the plugin, when the 'polling' member of FMOD_OUTPUT_DESCRIPTION is set to false.
Use this function from your own driver irq/timer to read some data from FMOD's DSP engine. All of the resulting output caused by playing sounds and specifying effects by the user will be mixed here and written to the memory provided by the plugin writer.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_OUTPUT_READFROMMIXER(
  FMOD_OUTPUT_STATE *output_state,
  void *buffer,
  unsigned int length
);

Parameters

output_state

Pointer to the plugin state. The user can use this variable to access runtime plugin specific variables and plugin writer user data.

buffer

Plugin-writer provided memory for the FMOD Studio mixer to write to.

length

Length of the buffer in samples.

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.

Version 1.10.03 Built on Feb 1, 2018