Wwise SDK 2019.1.11
_ak_dynamic_sequence_8h_source
Version
menu_open
link
Wwise SDK 2019.1.11
|
AkDynamicSequence.h
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.
134 };
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.
AKSOUNDENGINE_API AKRESULT Stop(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
AKRESULT SetExternalSources(AkUInt32 in_nExternalSrc, AkExternalSourceInfo *in_pExternalSrc)
AKSOUNDENGINE_API AKRESULT GetPlayingItem(AkPlayingID in_playingID, AkUniqueID &out_audioNodeID, void *&out_pCustomInfo)
DynamicSequenceType
Definition: AkDynamicSequence.h:131
AkTimeMs msDelay
Delay before playing this item, in milliseconds.
Definition: AkDynamicSequence.h:74
PlaylistItem & operator=(const PlaylistItem &in_rCopy)
AKSOUNDENGINE_API AKRESULT Resume(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
Resume specified Dynamic Sequence.
PlaylistItem()
AKSOUNDENGINE_API AKRESULT Pause(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
PlaylistItem(const PlaylistItem &in_rCopy)
~PlaylistItem()
AKSOUNDENGINE_API Playlist * LockPlaylist(AkPlayingID in_playingID)
Definition: AkTypes.h:214
AKSOUNDENGINE_API AKRESULT Play(AkPlayingID in_playingID, AkTimeMs in_uTransitionDuration=0, AkCurveInterpolation in_eFadeCurve=AkCurveInterpolation_Linear)
Play specified Dynamic Sequence.
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
AkExternalSourceArray * GetExternalSources()
Get the external source array. Internal use only.
Definition: AkDynamicSequence.h:71
AkForceInline PlaylistItem * AddLast()
Definition: AkArray.h:448
AKSOUNDENGINE_API AKRESULT UnlockPlaylist(AkPlayingID in_playingID)
AKSOUNDENGINE_API AkPlayingID Open(AkGameObjectID in_gameObjectID, AkUInt32 in_uFlags=0, AkCallbackFunc in_pfnCallback=NULL, void *in_pCookie=NULL, DynamicSequenceType in_eDynamicSequenceType=DynamicSequenceType_SampleAccurate)
@ DynamicSequenceType_NormalTransition
Normal transition mode, allows the entire playlist to be edited at all times.
Definition: AkDynamicSequence.h:133
AKSOUNDENGINE_API AKRESULT GetPauseTimes(AkPlayingID in_playingID, AkUInt32 &out_uTime, AkUInt32 &out_uDuration)
Get pause times.
bool operator==(const PlaylistItem &in_rCopy)
Definition: AkDynamicSequence.h:57
AKSOUNDENGINE_API AKRESULT Close(AkPlayingID in_playingID)
AKSOUNDENGINE_API AKRESULT Break(AkPlayingID in_playingID)
Break specified Dynamic Sequence. The sequence will stop after the current item.
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