Firelight Technologies FMOD Studio API

FMOD_OUTPUT_UNLOCK_CALLBACK

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

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_OUTPUT_UNLOCK_CALLBACK(
  FMOD_OUTPUT_STATE *output_state,
  void *ptr1,
  void *ptr2,
  unsigned int len1,
  unsigned int len2
);

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.

ptr1

Pointer to the 1st locked portion of sample data, from Sound::lock.

ptr2

Pointer to the 2nd locked portion of sample data, from Sound::lock.

len1

Length of data in bytes that was locked for ptr1.

len2

Length of data in bytes that was locked for ptr2. This will be 0 if the data locked hasn't wrapped at the end of the buffer.

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

This function is normally called after data has been read/written to from Sound::lock. This function will do any post processing nescessary and if needed, send it to sound ram.

See Also

• FMOD_OUTPUT_DESCRIPTION
• FMOD_OUTPUT_LOCK_CALLBACK
• FMOD_OUTPUT_GETPOSITION_CALLBACK

Version 1.03.06 Built on Apr 17, 2014