FMOD_OUTPUT_MIXER_CALLBACK

FMOD Studio API

Firelight Technologies FMOD Studio API

FMOD_OUTPUT_MIXER_CALLBACK

Called from the mixer thread, only when the 'polling' member of FMOD_OUTPUT_DESCRIPTION is set to FALSE.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_OUTPUT_MIXER_CALLBACK(
  FMOD_OUTPUT_STATE *output_state
);

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.

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

Called repeatedly to give a thread for waiting on an audio hardware synchronization primitive, used in conjunction with FMOD_OUTPUT_READFROMMIXER.

Ensure you have a reasonable timeout (~200ms) on your synchronization primitive and allow this callback to return once per wakeup to avoid deadlocks.

Remember to return FMOD_OK at the bottom of the function, or an appropriate error code from FMOD_RESULT.

See Also




Version 1.10.03 Built on Feb 1, 2018