Wwise SDK 2018.1.11
_ak_dynamic_sequence_8h_source
Version
menu_open
link
Wwise SDK 2018.1.11
|
AkDynamicSequence.h
Go to the documentation of this file.
96 AkExternalSourceInfo *in_pExternalSources = NULL///< Optional array of external source resolution information
114 /// In sample accurate mode, when a dynamic sequence item finishes playing and there is another item\n
115 /// pending in its playlist, the next sound will be stitched to the end of the ending sound. In this \n
116 /// mode, if there are one or more pending items in the playlist while the dynamic sequence is playing,\n
118 /// can remove the next item to be played from the playlist and prepare it for sample accurate playback before\n
119 /// the first sound is finished playing. This mechanism helps keep sounds sample accurate, but then\n
123 /// playlist at any time, then you should use the DynamicSequenceType_NormalTransition option instead.\n
126 /// Note that a Stop or a Break will always prevent the next to be played sound from actually being played.
133 DynamicSequenceType_NormalTransition ///< Normal transition mode, allows the entire playlist to be edited at all times.
145 void* in_pCookie = NULL, ///< Callback cookie that will be sent to the callback function along with additional information;
146 DynamicSequenceType in_eDynamicSequenceType = DynamicSequenceType_SampleAccurate ///< See : \ref AK::SoundEngine::DynamicSequence::DynamicSequenceType
159 AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear ///< Curve type to be used for the transition
163 /// To restart the sequence, call Resume. The item paused will resume its playback, followed by the rest of the sequence.
167 AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear ///< Curve type to be used for the transition
174 AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear ///< Curve type to be used for the transition
183 AkCurveInterpolation in_eFadeCurve = AkCurveInterpolation_Linear ///< Curve type to be used for the transition
194 AkUInt32 &out_uTime, ///< If sequence is currently paused, returns time when pause started, else 0.
195 AkUInt32 &out_uDuration ///< Returns total pause duration since last call to GetPauseTimes, excluding the time elapsed in the current pause.
Playlist *__cdecl LockPlaylist(AkPlayingID in_playingID)
AkForceInline AKRESULT Enqueue(AkUniqueID in_audioNodeID, AkTimeMs in_msDelay=0, void *in_pCustomInfo=NULL, AkUInt32 in_cExternals=0, AkExternalSourceInfo *in_pExternalSources=NULL)
Definition: AkDynamicSequence.h:91
DynamicSequenceType
Definition: AkDynamicSequence.h:130
Normal transition mode, allows the entire playlist to be edited at all times.
Definition: AkDynamicSequence.h:133
AkPlayingID __cdecl Open(AkGameObjectID in_gameObjectID, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, DynamicSequenceType in_eDynamicSequenceType=DynamicSequenceType_SampleAccurate)
AkTimeMs msDelay
Delay before playing this item, in milliseconds.
Definition: AkDynamicSequence.h:74
~PlaylistItem()
AKRESULT __cdecl Close(AkPlayingID in_playingID)
AKRESULT __cdecl Stop(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
Sample accurate mode.
Definition: AkDynamicSequence.h:132
PlaylistItem * AddLast()
Definition: AkArray.h:409
bool operator==(const PlaylistItem &in_rCopy)
Definition: AkDynamicSequence.h:57
AKRESULT __cdecl Resume(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
Resume specified Dynamic Sequence.
AKRESULT __cdecl UnlockPlaylist(AkPlayingID in_playingID)
AKRESULT __cdecl GetPauseTimes(AkPlayingID in_playingID, AkUInt32 &out_uTime, AkUInt32 &out_uDuration)
Get pause times.
AKRESULT SetExternalSources(AkUInt32 in_nExternalSrc, AkExternalSourceInfo *in_pExternalSrc)
AKRESULT __cdecl Pause(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
AKRESULT __cdecl Play(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
Play specified Dynamic Sequence.
AkExternalSourceArray * GetExternalSources()
Get the external source array. Internal use only.
Definition: AkDynamicSequence.h:71
PlaylistItem & operator=(const PlaylistItem &in_rCopy)
PlaylistItem()
void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:234
Definition: AkTypes.h:242
AKRESULT __cdecl Break(AkPlayingID in_playingID)
Break specified Dynamic Sequence. The sequence will stop after the current item.
AKRESULT __cdecl GetPlayingItem(AkPlayingID in_playingID, AkUniqueID &out_audioNodeID, void *&out_pCustomInfo)
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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