Version

menu_open
Wwise SDK 2023.1.4

◆ GetSourcePlayPosition()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::GetSourcePlayPosition ( AkPlayingID  in_PlayingID,
AkTimeMs out_puPosition,
bool  in_bExtrapolate = true 
)

Gets the current position of the source associated with this playing ID, obtained from PostEvent(). If more than one source is playing, the first to play is returned. Notes:

  • You need to pass AK_EnableGetSourcePlayPosition to PostEvent() in order to use this function, otherwise it returns AK_Fail, even if the playing ID is valid.
  • The source's position is updated at every audio frame, and the time at which this occurs is stored. When you call this function from your thread, you therefore query the position that was updated in the previous audio frame. If in_bExtrapolate is true (default), the returned position is extrapolated using the elapsed time since last sound engine update and the source's playback rate.
    Returns
  • AK_Success if successful.
  • AK_InvalidParameter if the provided pointer is not valid.
  • AK_PlayingIDNotFound if the playing ID is invalid (not playing yet, or finished playing).
    See also
  • Integration Details - GetSourcePlayPosition
  • Understanding Events
Parameters
in_PlayingIDPlaying ID returned by AK::SoundEngine::PostEvent()
out_puPositionPosition of the source (in ms) associated with the specified playing ID
in_bExtrapolatePosition is extrapolated based on time elapsed since last sound engine update.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise