Firelight Technologies FMOD Studio API

FMOD_CODEC_GETPOSITION_CALLBACK

Tell callback for the codec for when FMOD tries to get the current position within the with Channel::getPosition.

C/C++ Syntax

FMOD_RESULT F_CALLBACK FMOD_CODEC_GETPOSITION_CALLBACK(
  FMOD_CODEC_STATE *codec_state,
  unsigned int *position,
  FMOD_TIMEUNIT postype
);

Parameters

codec_state

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

position

Address of a variable to receive the current position in the codec based on the timeunit specified in the postype parameter.

postype

Timeunit type of the position parameter that is requested. This will be one of the timeunits supplied by the codec author in the FMOD_CODEC_DESCRIPTION structure.

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

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

See Also

• Channel::getPosition
• FMOD_CODEC_STATE
• FMOD_CODEC_DESCRIPTION
• FMOD_CODEC_OPEN_CALLBACK
• FMOD_CODEC_CLOSE_CALLBACK
• FMOD_CODEC_READ_CALLBACK
• FMOD_CODEC_GETLENGTH_CALLBACK
• FMOD_CODEC_SETPOSITION_CALLBACK
• FMOD_CODEC_SOUNDCREATE_CALLBACK

Version 1.10.03 Built on Feb 1, 2018