Firelight Technologies FMOD Studio API

FMOD_OUTPUT_LOCK_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_LOCK_CALLBACK(
  FMOD_OUTPUT_STATE *output_state,
  unsigned int offset,
  unsigned int length,
  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.

offset

Offset in bytes to the position the caller wants to lock in the sample buffer.

length

Number of bytes the caller want to lock in the sample buffer.

ptr1

Address of a pointer that will point to the first part of the locked data.

ptr2

Address of a pointer that will point to the second part of the locked data. This will be null if the data locked hasn't wrapped at the end of the buffer.

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.

See Also

• FMOD_OUTPUT_DESCRIPTION
• FMOD_OUTPUT_STATE
• FMOD_OUTPUT_UNLOCK_CALLBACK
• FMOD_OUTPUT_GETPOSITION_CALLBACK

Version 1.10.03 Built on Feb 1, 2018