Wwise SDK 2023.1.5

◆ GetSourcePlayPositions()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::GetSourcePlayPositions ( AkPlayingID  in_PlayingID,
AkSourcePosition out_puPositions,
AkUInt32 io_pcPositions,
bool  in_bExtrapolate = true 

Gets the current position of the sources associated with this playing ID, obtained from PostEvent(). 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.
  • If 0 is passed in for the number of entries (*in_pcPositions == 0) then only the number of positions will be returned and the position array (out_puPositions) will not be updated.
  • The io_pcPositions pointer must be non-NULL. out_puPositions may be NULL if *io_pcPositions == 0, otherwise it must be non-NULL.
  • 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
in_PlayingIDPlaying ID returned by AK::SoundEngine::PostEvent()
out_puPositionsAudio Node IDs and positions of sources associated with the specified playing ID
io_pcPositionsNumber of entries in out_puPositions. Needs to be set to the size of the array: it is adjusted to the actual number of returned entries
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