Wwise SDK 2018.1.11
Go to the documentation of this file.
37 #include <AK/SoundEngine/Common/AkSoundEngineExport.h>
38 #include <AK/SoundEngine/Common/AkTypes.h>
39 #include <AK/SoundEngine/Common/AkCallback.h>
47 AkReal32 fStreamingLookAheadRatio; ///< Multiplication factor for all streaming look-ahead heuristic values.
51 namespace AK
55 namespace MusicEngine
62 /// \warning This function must be called after the base sound engine has been properly initialized.
63 /// There should be no AK API call between AK::SoundEngine::Init() and this call. Any call done in between is potentially unsafe.
68 AkMusicSettings * in_pSettings ///< Initialization settings (can be NULL, to use the default values)
76 AkMusicSettings & out_settings ///< Returned default platform-independent music engine settings
86 /// Query information on the active segment of a music object that is playing. Use the playing ID
87 /// that was returned from AK::SoundEngine::PostEvent(), provided that the event contained a play
88 /// action that was targetting a music object. For any configuration of interactive music hierarchy,
90 /// To be able to query segment information, you must pass the AK_EnableGetMusicPlayPosition flag
91 /// to the AK::SoundEngine::PostEvent() method. This informs the sound engine that the source associated
92 /// with this event should be given special consideration because GetPlayingSegmentInfo() can be called
95 /// - If the music object is a single segment, you will get negative values for AkSegmentInfo::iCurrentPosition
98 /// - The active segment during the pre-entry of the first segment of a Playlist Container or a Music Switch
99 /// Container is "nothing", as well as during the post-exit of the last segment of a Playlist (and beyond).
101 /// - If in_bExtrapolate is true (default), AkSegmentInfo::iCurrentPosition is corrected by the amount of time elapsed
102 /// since the beginning of the audio frame. It is thus possible that it slightly overshoots the total segment length.
103 /// \return AK_Success if there is a playing music structure associated with the specified playing ID.
108 AkPlayingID in_PlayingID, ///< Playing ID returned by AK::SoundEngine::PostEvent().
109 AkSegmentInfo & out_segmentInfo, ///< Structure containing information about the active segment of the music structure that is playing.
110 bool in_bExtrapolate = true ///< Position is extrapolated based on time elapsed since last sound engine update.
AKRESULT __cdecl Init(AkMusicSettings *in_pSettings)
void __cdecl GetDefaultInitSettings(AkMusicSettings &out_settings)
AKRESULT __cdecl GetPlayingSegmentInfo(AkPlayingID in_PlayingID, AkSegmentInfo &out_segmentInfo, bool in_bExtrapolate=true)
Multiplication factor for all streaming look-ahead heuristic values.
void __cdecl Term()