Version
menu_open
link
Wwise SDK 2023.1.4
AkCallback.h
Go to the documentation of this file.
1 /*******************************************************************************
2 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
3 released in source code form as part of the SDK installer package.
4 
5 Commercial License Usage
6 
7 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
8 may use this file in accordance with the end user license agreement provided
9 with the software or, alternatively, in accordance with the terms contained in a
10 written agreement between you and Audiokinetic Inc.
11 
12 Apache License Usage
13 
14 Alternatively, this file may be used under the Apache License, Version 2.0 (the
15 "Apache License"); you may not use this file except in compliance with the
16 Apache License. You may obtain a copy of the Apache License at
17 http://www.apache.org/licenses/LICENSE-2.0.
18 
19 Unless required by applicable law or agreed to in writing, software distributed
20 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
21 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
22 the specific language governing permissions and limitations under the License.
23 
24  Copyright (c) 2024 Audiokinetic Inc.
25 *******************************************************************************/
26 
27 // AkCallback.h
28 
29 /// \file
30 /// Declaration of callback prototypes
31 
32 
33 #ifndef _AK_CALLBACK_H_
34 #define _AK_CALLBACK_H_
35 
38 
39 namespace AK
40 {
41  class IAkGlobalPluginContext;
42  class IAkMixerInputContext;
43  class IAkMixerPluginContext;
44 }
45 
46 /// Type of callback. Used as a bitfield in methods AK::SoundEngine::PostEvent() and AK::SoundEngine::DynamicSequence::Open().
48 {
49  AK_EndOfEvent = 0x0001, ///< Callback triggered when reaching the end of an event. AkCallbackInfo can be cast to AkEventCallbackInfo.
50  AK_EndOfDynamicSequenceItem = 0x0002, ///< Callback triggered when reaching the end of a dynamic sequence item. AkCallbackInfo can be cast to AkDynamicSequenceItemCallbackInfo.
51  AK_Marker = 0x0004, ///< Callback triggered when encountering a marker during playback. AkCallbackInfo can be cast to AkMarkerCallbackInfo.
52  AK_Duration = 0x0008, ///< Callback triggered when the duration of the sound is known by the sound engine. AkCallbackInfo can be cast to AkDurationCallbackInfo.
53 
54  AK_SpeakerVolumeMatrix = 0x0010, ///< Callback triggered at each frame, letting the client modify the speaker volume matrix. AkCallbackInfo can be cast to AkSpeakerVolumeMatrixCallbackInfo.
55 
56  AK_Starvation = 0x0020, ///< Callback triggered when playback skips a frame due to stream starvation. AkCallbackInfo can be cast to AkEventCallbackInfo.
57 
58  AK_MusicPlaylistSelect = 0x0040, ///< Callback triggered when music playlist container must select the next item to play. AkCallbackInfo can be cast to AkMusicPlaylistCallbackInfo.
59  AK_MusicPlayStarted = 0x0080, ///< Callback triggered when a "Play" or "Seek" command has been executed ("Seek" commands are issued from AK::SoundEngine::SeekOnEvent()). Applies to objects of the Interactive-Music Hierarchy only. AkCallbackInfo can be cast to AkEventCallbackInfo.
60 
61  AK_MusicSyncBeat = 0x0100, ///< Enable notifications on Music Beat. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
62  AK_MusicSyncBar = 0x0200, ///< Enable notifications on Music Bar. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
63  AK_MusicSyncEntry = 0x0400, ///< Enable notifications on Music Entry Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
64  AK_MusicSyncExit = 0x0800, ///< Enable notifications on Music Exit Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
65  AK_MusicSyncGrid = 0x1000, ///< Enable notifications on Music Grid. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
66  AK_MusicSyncUserCue = 0x2000, ///< Enable notifications on Music Custom Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
67  AK_MusicSyncPoint = 0x4000, ///< Enable notifications on Music switch transition synchronization point. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
68  AK_MusicSyncAll = 0x7f00, ///< Use this flag if you want to receive all notifications concerning AK_MusicSync registration.
69 
70  AK_MIDIEvent = 0x10000, ///< Enable notifications for MIDI events. AkCallbackInfo can be cast to AkMIDIEventCallbackInfo.
71 
72  AK_CallbackBits = 0xfffff, ///< Bitmask for all callback types.
73 
74  // Not callback types, but need to be part of same bitfield for AK::SoundEngine::PostEvent().
75  AK_EnableGetSourcePlayPosition = 0x100000, ///< Enable play position information for use by AK::SoundEngine::GetSourcePlayPosition().
76  AK_EnableGetMusicPlayPosition = 0x200000, ///< Enable play position information of music objects, queried via AK::MusicEngine::GetPlayingSegmentInfo().
77  AK_EnableGetSourceStreamBuffering = 0x400000 ///< Enable stream buffering information for use by AK::SoundEngine::GetSourceStreamBuffering().
78 };
79 
80 /// Callback information structure used as base for all notifications handled by \ref AkCallbackFunc.
81 /// \sa
82 /// - AK::SoundEngine::PostEvent()
83 /// - \ref soundengine_events
85 {
86  void * pCookie; ///< User data, passed to PostEvent()
87  AkGameObjectID gameObjID; ///< Game object ID
88 };
89 
90 /// Callback information structure corresponding to \ref AK_EndOfEvent, \ref AK_MusicPlayStarted and \ref AK_Starvation.
91 /// \sa
92 /// - AK::SoundEngine::PostEvent()
93 /// - \ref soundengine_events
95 {
96  AkPlayingID playingID; ///< Playing ID of Event, returned by PostEvent()
97  AkUniqueID eventID; ///< Unique ID of Event, passed to PostEvent()
98 };
99 
100 /// Callback information structure corresponding to \ref AkCallbackType::AK_MIDIEvent
101 /// \sa
102 /// - AK::SoundEngine::PostEvent()
103 /// - \ref soundengine_events
105 {
106  AkMIDIEvent midiEvent; ///< MIDI event triggered by event.
107 };
108 
109 
110 /// Callback information structure corresponding to \ref AK_Marker.
111 /// \sa
112 /// - AK::SoundEngine::PostEvent()
113 /// - \ref soundengine_events
114 /// - \ref soundengine_markers
116 {
117  AkUInt32 uIdentifier; ///< Cue point identifier
118  AkUInt32 uPosition; ///< Position in the cue point (unit: sample frames)
119  const char* strLabel; ///< Label of the marker (null-terminated)
120  AkUInt32 uLabelSize; ///< Size of the label string (including the terminating null character)
121 };
122 
123 /// Callback information structure corresponding to \ref AK_Duration.
124 /// \sa
125 /// - AK::SoundEngine::PostEvent()
126 /// - \ref soundengine_events
128 {
129  AkReal32 fDuration; ///< Duration of the sound (unit: milliseconds)
130  AkReal32 fEstimatedDuration; ///< Estimated duration of the sound depending on source settings such as pitch. (unit: milliseconds)
131  AkUniqueID audioNodeID; ///< Audio Node ID of playing item
132  AkUniqueID mediaID; ///< Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file)
133  bool bStreaming; ///< True if source is streaming, false otherwise.
134 };
135 
136 /// Callback information structure corresponding to \ref AK_EndOfDynamicSequenceItem.
137 /// \sa
138 /// - AK::SoundEngine::PostEvent()
139 /// - AK::SoundEngine::DynamicSequence::Open()
140 /// - \ref soundengine_events
142 {
143  AkPlayingID playingID; ///< Playing ID of Dynamic Sequence, returned by AK::SoundEngine:DynamicSequence::Open()
144  AkUniqueID audioNodeID; ///< Audio Node ID of finished item
145  void* pCustomInfo; ///< Custom info passed to the DynamicSequence::Open function
146 };
147 
148 /// Callback information structure corresponding to \ref AK_SpeakerVolumeMatrix, and passed to callbacks registered in RegisterBusVolumeCallback()
149 /// or PostEvent() with AK_SpeakerVolumeMatrix. These callbacks are called at every audio frame for every connection from an input (voice
150 /// or bus) to an output bus (standard or auxiliary), at the point when an input signal is about to be mixed into a mixing bus, but just before
151 /// having been scaled in accordance to volumes authored in Wwise. The volumes are passed via this structure as pointers because they can be modified
152 /// in the callbacks. They are factored into two linear values ([0..1]): a common base value (pfBaseVolume), that is channel-agnostic and represents
153 /// the collapsed gain of all volume changes in Wwise (sliders, actions, RTPC, attenuations, ...), and a matrix of gains per input/output channel,
154 /// which depends on spatialization. Use the methods of AK::SpeakerVolumes::Matrix, defined in AkCommonDefs.h, to perform operations on them.
155 /// Access each input channel of the volumes matrix with AK::SpeakerVolumes::Matrix::GetChannel(), passing it the input and output channel configuration.
156 /// Then, you may access each element of the output vector using the standard bracket [] operator. See AK::SpeakerVolumes for more details.
157 /// It is crucial that the processing done in the callback be lightweight and non-blocking.
158 /// \sa
159 /// - \ref goingfurther_speakermatrixcallback
160 /// - AK::SoundEngine::PostEvent()
161 /// - \ref soundengine_events
162 /// - AK::SoundEngine::RegisterBusVolumeCallback()
164 {
165  AK::SpeakerVolumes::MatrixPtr pVolumes; ///< Pointer to volume matrix describing the contribution of each source channel to destination channels. Use methods of AK::SpeakerVolumes::Matrix to interpret them.
166  AkChannelConfig inputConfig; ///< Channel configuration of the voice/bus.
167  AkChannelConfig outputConfig; ///< Channel configuration of the output bus.
168  AkReal32 * pfBaseVolume; ///< Base volume, common to all channels.
169  AkReal32 * pfEmitterListenerVolume; ///< Emitter-listener pair-specific gain. When there are multiple emitter-listener pairs, this volume is set to that of the loudest pair, and the relative gain of other pairs is applied directly on the channel volume matrix pVolumes.
170  AK::IAkMixerPluginContext * pMixerContext; ///< Output mixing bus context. Use it to access a few useful panning and mixing services, as well as the ID of the output bus. NULL if pContext is the master audio bus.
171 };
172 
173 /// Callback information structure allowing to query signal metering on busses, at each frame, after having mixed all their inputs and processed their effects.
174 /// Register the callback using AK::SoundEngine::RegisterBusMeteringCallback.
176 {
177  AK::AkMetering* pMetering; ///< Struct containing metering information.
178  AkChannelConfig channelConfig; ///< Channel configuration of the bus.
179  AkMeteringFlags eMeteringFlags; ///< Metering flags that were asked for in RegisterBusMeteringCallback(). You may only access corresponding meter values from in_pMeteringInfo. Others will fail.
180 };
181 
182 /// Callback information structure allowing to query signal metering on output devices, at each frame.
183 /// Register the callback using AK::SoundEngine::RegisterOutputDeviceMeteringCallback.
185 {
186  AK::AkMetering * pMainMixMetering; ///< Metering information for the main mix
187  AkChannelConfig mainMixConfig; ///< Channel configuration of the main mix
188  AK::AkMetering * pPassthroughMetering; ///< Metering information for the passthrough mix (if any; will be null otherwise)
189  AkChannelConfig passthroughMixConfig; ///< Channel configuration of the passthrough mix (if any; will be invalid otherwise)
190  AkUInt32 uNumSystemAudioObjects; ///< Number of System Audio Objects going out of the output device
191  AK::AkMetering ** ppSystemAudioObjectMetering; ///< Metering information for each System Audio Object (number of elements is equal to uNumSystemAudioObjects)
192  AkMeteringFlags eMeteringFlags; ///< Metering flags that were asked for in RegisterOutputDeviceMeteringCallback(). You may only access corresponding meter values from the metering objects. Others will fail.
193 };
194 
195 /// Callback information structure corresponding to \ref AK_MusicPlaylistSelect.
196 /// Called when a music playlist container must select its next item to play.
197 /// The members uPlaylistSelection and uPlaylistItemDone are set by the sound
198 /// engine before the callback function call. They are set to the next item
199 /// selected by the sound engine. They are to be modified by the callback
200 /// function if the selection is to be changed.
201 /// \sa
202 /// - \ref soundengine_events
203 /// - AK::SoundEngine::PostEvent()
204 /// - \ref soundengine_music_callbacks
206 {
207  AkUniqueID playlistID; ///< ID of playlist node
208  AkUInt32 uNumPlaylistItems; ///< Number of items in playlist node (may be segments or other playlists)
209  AkUInt32 uPlaylistSelection; ///< Selection: set by sound engine, modified by callback function (if not in range 0 <= uPlaylistSelection < uNumPlaylistItems then ignored).
210  AkUInt32 uPlaylistItemDone; ///< Playlist node done: set by sound engine, modified by callback function (if set to anything but 0 then the current playlist item is done, and uPlaylistSelection is ignored)
211 };
212 
213 /// Structure used to query info on active playing segments.
215 {
216  AkTimeMs iCurrentPosition; ///< Current position of the segment, relative to the Entry Cue, in milliseconds. Range is [-iPreEntryDuration, iActiveDuration+iPostExitDuration].
217  AkTimeMs iPreEntryDuration; ///< Duration of the pre-entry region of the segment, in milliseconds.
218  AkTimeMs iActiveDuration; ///< Duration of the active region of the segment (between the Entry and Exit Cues), in milliseconds.
219  AkTimeMs iPostExitDuration; ///< Duration of the post-exit region of the segment, in milliseconds.
220  AkTimeMs iRemainingLookAheadTime;///< Number of milliseconds remaining in the "looking-ahead" state of the segment, when it is silent but streamed tracks are being prefetched.
221  AkReal32 fBeatDuration; ///< Beat Duration in seconds.
222  AkReal32 fBarDuration; ///< Bar Duration in seconds.
223  AkReal32 fGridDuration; ///< Grid duration in seconds.
224  AkReal32 fGridOffset; ///< Grid offset in seconds.
225 };
226 
227 /// Callback information structure corresponding to \ref AK_MusicSyncEntry, \ref AK_MusicSyncBeat, \ref AK_MusicSyncBar, \ref AK_MusicSyncExit, \ref AK_MusicSyncGrid, \ref AK_MusicSyncPoint and \ref AK_MusicSyncUserCue.
228 /// If you need the Tempo, you can compute it using the fBeatDuration
229 /// Tempo (beats per minute) = 60/fBeatDuration
230 /// \sa
231 /// - \ref soundengine_events
232 /// - AK::SoundEngine::PostEvent()
233 /// - \ref soundengine_music_callbacks
235 {
236  AkPlayingID playingID; ///< Playing ID of Event, returned by PostEvent()
237  AkSegmentInfo segmentInfo; ///< Segment information corresponding to the segment triggering this callback.
238  AkCallbackType musicSyncType; ///< Would be either \ref AK_MusicSyncEntry, \ref AK_MusicSyncBeat, \ref AK_MusicSyncBar, \ref AK_MusicSyncExit, \ref AK_MusicSyncGrid, \ref AK_MusicSyncPoint or \ref AK_MusicSyncUserCue.
239  char * pszUserCueName; ///< Cue name (UTF-8 string). Set for notifications AK_MusicSyncUserCue. NULL if cue has no name.
240 };
241 
242 /// Resources data summary structure containing general information about the system
244 {
245  AkReal32 totalCPU; ///< Pourcentage of the cpu time used for processing audio. Please note that the numbers may add up when using multiple threads.
246  AkReal32 pluginCPU; ///< Pourcentage of the cpu time used by plugin processing. Please note that the numbers may add up when using multiple threads.
247  AkUInt32 physicalVoices; ///< Number of active physical voices
248  AkUInt32 virtualVoices; ///< Number of active virtual voices
249  AkUInt32 totalVoices; ///< Number of active physical and virtual voices
250  AkUInt32 nbActiveEvents; ///< Number of events triggered at a certain time
251 };
252 
253 /// Function called on completion of an event, or when a marker is reached.
254 /// \param in_eType Type of callback.
255 /// \param in_pCallbackInfo Pointer to structure containing callback information. This pointer is invalidated as soon as the callback function returns.
256 /// \remarks An event is considered completed once all of its actions have been executed and all the playbacks in this events are terminated.
257 /// \remarks This callback is executed from the audio processing thread. The processing time in the callback function should be minimal. Having too much processing time could result in slowing down the audio processing.
258 /// \remarks Before waiting on an \ref AK_EndOfEvent, make sure that the event is going to end.
259 /// Some events can be continuously playing or infinitely looping, and the callback will not occur unless a specific stop event is sent to terminate the event.
260 /// \sa
261 /// - AK::SoundEngine::PostEvent()
262 /// - AK::SoundEngine::DynamicSequence::Open()
263 /// - \ref soundengine_events
264 /// - \ref soundengine_markers
265 /// - \ref soundengine_music_callbacks
267  AkCallbackType in_eType, ///< Callback type.
268  AkCallbackInfo* in_pCallbackInfo ///< Structure containing desired information. You can cast it to the proper sub-type, depending on the callback type.
269  );
270 
271 /// Function called on at every audio frame for the specified registered busses.
272 /// \sa
273 /// - AkSpeakerVolumeMatrixCallbackInfo
274 /// - AK::SoundEngine::RegisterBusVolumeCallback()
275 /// - \ref goingfurther_speakermatrixcallback
277  AkSpeakerVolumeMatrixCallbackInfo* in_pCallbackInfo ///< Structure containing desired bus information.
278  );
279 
280 /// Function called on at every audio frame for the specified registered busses, just after metering has been computed.
281 /// \sa
282 /// - AK::SoundEngine::RegisterBusMeteringCallback()
283 /// - AK::AkMetering
284 /// - AkBusMeteringCallbackInfo
285 /// - \ref goingfurther_speakermatrixcallback
287  AkBusMeteringCallbackInfo * in_pCallbackInfo ///< Structure containing desired bus information.
288  );
289 
290 /// Function called on at every audio frame for the specified registered output devices, just after metering has been computed.
291 /// \sa
292 /// - AK::SoundEngine::RegisterOutputDeviceMeteringCallback()
293 /// - AK::AkMetering
294 /// - AkOutputDeviceMeteringCallbackInfo
295 /// - \ref goingfurther_speakermatrixcallback
297  AkOutputDeviceMeteringCallbackInfo * in_pCallbackInfo ///< Structure containing desired output device information.
298  );
299 
300 /// Callback prototype used with asynchronous bank load/unload requests.
301 /// This function is called when the bank request has been processed
302 /// and indicates if it was successfully executed or if an error occurred.
303 /// \param in_bankID Identifier of the bank that was explicitly loaded/unloaded.
304 /// In the case of PrepareEvent() or PrepareGameSyncs(), this value contains
305 /// the AkUniqueID of the event/game sync that was prepared/unprepared, if the array contained only
306 /// one element. Otherwise, in_bankID equals AK_INVALID_UNIQUE_ID.
307 /// \param in_pInMemoryBankPtr Value returned when the unloaded bank was loaded using an in memory location
308 /// \param in_eLoadResult Result of the requested action.
309 /// - AK_Success: Load or unload successful.
310 /// - AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() or PrepareGameSyncs() does not exist.
311 /// - AK_InsufficientMemory: Insufficient memory to store bank data.
312 /// - AK_BankReadError: I/O error.
313 /// - AK_WrongBankVersion: Invalid bank version: make sure the version of Wwise that
314 /// you used to generate the SoundBanks matches that of the SDK you are currently using.
315 /// - AK_InvalidFile: File specified could not be opened.
316 /// - AK_InvalidParameter: Invalid parameter.
317 /// - AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
318 /// \param in_pCookie Optional cookie that was passed to the bank request.
319 /// \remarks This callback is executed from the bank thread. The processing time in the callback function should be minimal. Having too much processing time could slow down the bank loading process.
320 /// \sa
321 /// - AK::SoundEngine::LoadBank()
322 /// - AK::SoundEngine::UnloadBank()
323 /// - AK::SoundEngine::PrepareEvent()
324 /// - AK::SoundEngine::PrepareGameSyncs()
325 /// - \ref soundengine_banks
327  AkUInt32 in_bankID,
328  const void * in_pInMemoryBankPtr,
329  AKRESULT in_eLoadResult,
330  void * in_pCookie
331  );
332 
333 /// Bit field of various locations in the audio processing loop where the game can be called back.
335 {
336  AkGlobalCallbackLocation_Register = (1 << 0), ///< Right after successful registration of callback/plugin. Typically used by plugins along with AkGlobalCallbackLocation_Term for allocating memory for the lifetime of the sound engine.
337 
338  AkGlobalCallbackLocation_Begin = (1 << 1), ///< Start of audio processing. The number of frames about to be rendered depends on the sink/end-point and can be zero.
339 
340  AkGlobalCallbackLocation_PreProcessMessageQueueForRender = (1 << 2), ///< Start of frame rendering, before having processed game messages.
341  AkGlobalCallbackLocation_PostMessagesProcessed = (1 << 3), ///< After one or more messages have been processed, but before updating game object and listener positions internally.
342  AkGlobalCallbackLocation_BeginRender = (1 << 4), ///< Start of frame rendering, after having processed game messages.
343  AkGlobalCallbackLocation_EndRender = (1 << 5), ///< End of frame rendering.
344 
345  AkGlobalCallbackLocation_End = (1 << 6), ///< End of audio processing.
346 
347  AkGlobalCallbackLocation_Term = (1 << 7), ///< Sound engine termination.
348 
349  AkGlobalCallbackLocation_Monitor = (1 << 8), ///< Send monitor data
350  AkGlobalCallbackLocation_MonitorRecap = (1 << 9), ///< Send monitor data connection to recap.
351 
352  AkGlobalCallbackLocation_Init = (1 << 10), ///< Sound engine initialization.
353 
354  AkGlobalCallbackLocation_Suspend = (1 << 11), ///< Sound engine suspension through \ref AK::SoundEngine::Suspend
355  AkGlobalCallbackLocation_WakeupFromSuspend = (1 << 12), ///< Sound engine awakening through \ref AK::SoundEngine::WakeupFromSuspend
356 
357  // IMPORTANT: Keep in sync with number of locations.
358  AkGlobalCallbackLocation_Num = 13 ///< Total number of global callback locations.
359 };
360 
361 /// Callback prototype used for global callback registration.
362 /// This callback may be called from various locations within the audio processing loop. The exact location from which it is called is passed in in_eLocation, and corresponds to one of the values
363 /// that were passed to RegisterGlobalCallback(). See the possible values of AkGlobalCallbackLocation for more details about the available locations.
364 /// \remarks This callback is normally executed from the main audio thread. The processing time in the callback function should be minimal. Having too much processing time could cause voice starvation.
365 /// \sa
366 /// - AK::SoundEngine::RegisterGlobalCallback()
367 /// - AK::SoundEngine::UnregisterGlobalCallback()
369  AK::IAkGlobalPluginContext * in_pContext, ///< Engine context.
370  AkGlobalCallbackLocation in_eLocation, ///< Location where this callback is fired.
371  void * in_pCookie ///< User cookie passed to AK::SoundEngine::RegisterGlobalCallback().
372  );
373 
374 
376  const AkResourceMonitorDataSummary * in_pdataSummary ///< Data summary passed to the function registered using AK::SoundEngine::RegisterResourceMonitorCallback().
377  );
378 
379 namespace AK
380 {
382  {
383  AkAudioDeviceEvent_Initialization, ///< Sent after an Audio Device has initialized. Initialization might have failed, check the AKRESULT.
384  AkAudioDeviceEvent_Removal, ///< Audio device was removed through explicit call (AK::SoundEngine::RemoveOutput or AK::SoundEngine::Term)
385  AkAudioDeviceEvent_SystemRemoval ///< Audio device was removed because of a system event (disconnection), hardware or driver problem. Check the AKRESULT when called through AkDeviceStatusCallbackFunc, it may give more context.
386  };
387 
388  /// Callback for Audio Device status changes.
389  /// \sa AK::SoundEngine::AddOutput
391  AK::IAkGlobalPluginContext * in_pContext, ///< Engine context.
392  AkUniqueID in_idAudioDeviceShareset, ///< The audio device shareset attached, as passed to AK::SoundEngine::AddOutput or AK::SoundEngine::Init
393  AkUInt32 in_idDeviceID, ///< The audio device specific id, as passed to AK::SoundEngine::AddOutput or AK::SoundEngine::Init
394  AkAudioDeviceEvent in_idEvent, ///< The event for which this callback was called. See AK::AkAudioDeviceEvent. AKRESULT may provide more information.
395  AKRESULT in_AkResult ///< Result of the last operation.
396  );
397 }
398 
399 /// Callback prototype used for audio capture callback registration.
400 /// This callback will be called at the end of each audio frame for each output device that has been registered.
401 /// \remarks This callback will be executed on the main audio thread during real-time rendering and will be executed on the thread that \ref AK::SoundEngine::RenderAudio is called from when offline rendering is enabled.
402 /// \remarks The processing time in the callback function should be minimal. Having too much processing time could cause voice starvation during real-time rendering.
403 /// \remarks Note that a callback registered with <tt>in_idOutput</tt> equal to <tt>AK_INVALID_OUTPUT_DEVICE_ID</tt>, will receive the <tt>AkOutputDeviceID</tt> associated with the main output device.
404 /// \sa
405 /// - AK::SoundEngine::RenderAudio()
406 /// - AK::SoundEngine::RegisterCaptureCallback()
407 /// - AK::SoundEngine::UnregisterCaptureCallback()
409  AkAudioBuffer& in_CaptureBuffer, ///< Capture audio buffer. The data is always float interleaved.
410  AkOutputDeviceID in_idOutput, ///< The audio device specific id, as passed to AK::SoundEngine::AddOutput or AK::SoundEngine::Init
411  void* in_pCookie ///< Callback cookie that will be sent to the callback function along with additional information
412  );
413 
414 #endif // _AK_CALLBACK_H_
415 
Interface to retrieve contextual information for a mixer.
Definition: IAkPlugin.h:443
@ AK_MIDIEvent
Enable notifications for MIDI events. AkCallbackInfo can be cast to AkMIDIEventCallbackInfo.
Definition: AkCallback.h:70
@ AkGlobalCallbackLocation_Num
Total number of global callback locations.
Definition: AkCallback.h:358
const char * strLabel
Label of the marker (null-terminated)
Definition: AkCallback.h:119
AkUniqueID audioNodeID
Audio Node ID of playing item.
Definition: AkCallback.h:131
Resources data summary structure containing general information about the system.
Definition: AkCallback.h:244
AK::AkMetering ** ppSystemAudioObjectMetering
Metering information for each System Audio Object (number of elements is equal to uNumSystemAudioObje...
Definition: AkCallback.h:191
AkInt32 AkTimeMs
Time in ms.
Definition: AkTypes.h:56
Audiokinetic namespace.
char * pszUserCueName
Cue name (UTF-8 string). Set for notifications AK_MusicSyncUserCue. NULL if cue has no name.
Definition: AkCallback.h:239
@ AK_EndOfEvent
Callback triggered when reaching the end of an event. AkCallbackInfo can be cast to AkEventCallbackIn...
Definition: AkCallback.h:49
AkGameObjectID gameObjID
Game object ID.
Definition: AkCallback.h:87
@ AkAudioDeviceEvent_Initialization
Sent after an Audio Device has initialized. Initialization might have failed, check the AKRESULT.
Definition: AkCallback.h:383
@ AK_MusicSyncEntry
Enable notifications on Music Entry Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:63
void(* AkResourceMonitorCallbackFunc)(const AkResourceMonitorDataSummary *in_pdataSummary)
Definition: AkCallback.h:375
@ AK_MusicSyncBar
Enable notifications on Music Bar. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:62
AkReal32 * pfBaseVolume
Base volume, common to all channels.
Definition: AkCallback.h:168
@ AkGlobalCallbackLocation_EndRender
End of frame rendering.
Definition: AkCallback.h:343
AkChannelConfig mainMixConfig
Channel configuration of the main mix.
Definition: AkCallback.h:187
AkUInt32 uPlaylistSelection
Selection: set by sound engine, modified by callback function (if not in range 0 <= uPlaylistSelectio...
Definition: AkCallback.h:209
@ AkGlobalCallbackLocation_Begin
Start of audio processing. The number of frames about to be rendered depends on the sink/end-point an...
Definition: AkCallback.h:338
@ AkGlobalCallbackLocation_Register
Right after successful registration of callback/plugin. Typically used by plugins along with AkGlobal...
Definition: AkCallback.h:336
AkChannelConfig outputConfig
Channel configuration of the output bus.
Definition: AkCallback.h:167
@ AK_Duration
Callback triggered when the duration of the sound is known by the sound engine. AkCallbackInfo can be...
Definition: AkCallback.h:52
@ AkGlobalCallbackLocation_End
End of audio processing.
Definition: AkCallback.h:345
AkTimeMs iActiveDuration
Duration of the active region of the segment (between the Entry and Exit Cues), in milliseconds.
Definition: AkCallback.h:218
AkChannelConfig inputConfig
Channel configuration of the voice/bus.
Definition: AkCallback.h:166
AkUInt64 AkGameObjectID
Game object ID.
Definition: AkTypes.h:60
@ AK_MusicSyncAll
Use this flag if you want to receive all notifications concerning AK_MusicSync registration.
Definition: AkCallback.h:68
@ AkGlobalCallbackLocation_Term
Sound engine termination.
Definition: AkCallback.h:347
AKRESULT
Standard function call result.
Definition: AkTypes.h:131
void(* AkGlobalCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkGlobalCallbackLocation in_eLocation, void *in_pCookie)
Definition: AkCallback.h:368
AkMeteringFlags
Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...
Definition: AkTypes.h:1153
AK::IAkMixerPluginContext * pMixerContext
Output mixing bus context. Use it to access a few useful panning and mixing services,...
Definition: AkCallback.h:170
Structure used to query info on active playing segments.
Definition: AkCallback.h:215
AkReal32 fBeatDuration
Beat Duration in seconds.
Definition: AkCallback.h:221
@ AK_CallbackBits
Bitmask for all callback types.
Definition: AkCallback.h:72
@ AkAudioDeviceEvent_SystemRemoval
Audio device was removed because of a system event (disconnection), hardware or driver problem....
Definition: AkCallback.h:385
void(* AkBusMeteringCallbackFunc)(AkBusMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:286
@ AkGlobalCallbackLocation_Suspend
Sound engine suspension through AK::SoundEngine::Suspend.
Definition: AkCallback.h:354
AkCallbackType
Type of callback. Used as a bitfield in methods AK::SoundEngine::PostEvent() and AK::SoundEngine::Dyn...
Definition: AkCallback.h:48
AkReal32 fDuration
Duration of the sound (unit: milliseconds)
Definition: AkCallback.h:129
@ AkGlobalCallbackLocation_WakeupFromSuspend
Sound engine awakening through AK::SoundEngine::WakeupFromSuspend.
Definition: AkCallback.h:355
@ AkGlobalCallbackLocation_Init
Sound engine initialization.
Definition: AkCallback.h:352
void(* AkOutputDeviceMeteringCallbackFunc)(AkOutputDeviceMeteringCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:296
AkTimeMs iPreEntryDuration
Duration of the pre-entry region of the segment, in milliseconds.
Definition: AkCallback.h:217
float AkReal32
32-bit floating point
AkChannelConfig passthroughMixConfig
Channel configuration of the passthrough mix (if any; will be invalid otherwise)
Definition: AkCallback.h:189
AK::AkMetering * pMetering
Struct containing metering information.
Definition: AkCallback.h:177
AK::AkMetering * pMainMixMetering
Metering information for the main mix.
Definition: AkCallback.h:186
void * pCustomInfo
Custom info passed to the DynamicSequence::Open function.
Definition: AkCallback.h:145
AkUniqueID eventID
Unique ID of Event, passed to PostEvent()
Definition: AkCallback.h:97
AkUInt32 uIdentifier
Cue point identifier.
Definition: AkCallback.h:117
@ AK_Starvation
Callback triggered when playback skips a frame due to stream starvation. AkCallbackInfo can be cast t...
Definition: AkCallback.h:56
AkCallbackType musicSyncType
Would be either AK_MusicSyncEntry, AK_MusicSyncBeat, AK_MusicSyncBar, AK_MusicSyncExit,...
Definition: AkCallback.h:238
AkUInt32 AkUniqueID
Unique 32-bit ID.
Definition: AkTypes.h:52
@ AK_EnableGetSourceStreamBuffering
Enable stream buffering information for use by AK::SoundEngine::GetSourceStreamBuffering().
Definition: AkCallback.h:77
AkReal32 fGridOffset
Grid offset in seconds.
Definition: AkCallback.h:224
AkUInt32 uLabelSize
Size of the label string (including the terminating null character)
Definition: AkCallback.h:120
AkUInt32 uPosition
Position in the cue point (unit: sample frames)
Definition: AkCallback.h:118
AkUInt32 physicalVoices
Number of active physical voices.
Definition: AkCallback.h:247
@ AkAudioDeviceEvent_Removal
Audio device was removed through explicit call (AK::SoundEngine::RemoveOutput or AK::SoundEngine::Ter...
Definition: AkCallback.h:384
@ AkGlobalCallbackLocation_MonitorRecap
Send monitor data connection to recap.
Definition: AkCallback.h:350
void(* AkCaptureCallbackFunc)(AkAudioBuffer &in_CaptureBuffer, AkOutputDeviceID in_idOutput, void *in_pCookie)
Definition: AkCallback.h:408
AkPlayingID playingID
Playing ID of Event, returned by PostEvent()
Definition: AkCallback.h:236
@ AK_MusicSyncGrid
Enable notifications on Music Grid. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:65
void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:266
AkGlobalCallbackLocation
Bit field of various locations in the audio processing loop where the game can be called back.
Definition: AkCallback.h:335
AkReal32 totalCPU
Pourcentage of the cpu time used for processing audio. Please note that the numbers may add up when u...
Definition: AkCallback.h:245
AkTimeMs iPostExitDuration
Duration of the post-exit region of the segment, in milliseconds.
Definition: AkCallback.h:219
@ AkGlobalCallbackLocation_PreProcessMessageQueueForRender
Start of frame rendering, before having processed game messages.
Definition: AkCallback.h:340
AkUInt32 uPlaylistItemDone
Playlist node done: set by sound engine, modified by callback function (if set to anything but 0 then...
Definition: AkCallback.h:210
AkReal32 * pfEmitterListenerVolume
Emitter-listener pair-specific gain. When there are multiple emitter-listener pairs,...
Definition: AkCallback.h:169
#define AK_CALLBACK(_type, _name)
@ AK_EnableGetSourcePlayPosition
Enable play position information for use by AK::SoundEngine::GetSourcePlayPosition().
Definition: AkCallback.h:75
AkReal32 fEstimatedDuration
Estimated duration of the sound depending on source settings such as pitch. (unit: milliseconds)
Definition: AkCallback.h:130
void(* AkBusCallbackFunc)(AkSpeakerVolumeMatrixCallbackInfo *in_pCallbackInfo)
Definition: AkCallback.h:276
AkUniqueID audioNodeID
Audio Node ID of finished item.
Definition: AkCallback.h:144
AkUInt32 uNumSystemAudioObjects
Number of System Audio Objects going out of the output device.
Definition: AkCallback.h:190
AkUniqueID playlistID
ID of playlist node.
Definition: AkCallback.h:207
AkPlayingID playingID
Playing ID of Dynamic Sequence, returned by AK::SoundEngine:DynamicSequence::Open()
Definition: AkCallback.h:143
void * pCookie
User data, passed to PostEvent()
Definition: AkCallback.h:86
AkMeteringFlags eMeteringFlags
Metering flags that were asked for in RegisterOutputDeviceMeteringCallback(). You may only access cor...
Definition: AkCallback.h:192
@ AK_EndOfDynamicSequenceItem
Callback triggered when reaching the end of a dynamic sequence item. AkCallbackInfo can be cast to Ak...
Definition: AkCallback.h:50
void(* AkBankCallbackFunc)(AkUInt32 in_bankID, const void *in_pInMemoryBankPtr, AKRESULT in_eLoadResult, void *in_pCookie)
Definition: AkCallback.h:326
AK::AkMetering * pPassthroughMetering
Metering information for the passthrough mix (if any; will be null otherwise)
Definition: AkCallback.h:188
AkChannelConfig channelConfig
Channel configuration of the bus.
Definition: AkCallback.h:178
Struct containing metering information about a buffer. Depending on when this struct is generated,...
Definition: AkCommonDefs.h:205
@ AK_MusicPlaylistSelect
Callback triggered when music playlist container must select the next item to play....
Definition: AkCallback.h:58
@ AK_MusicSyncExit
Enable notifications on Music Exit Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:64
AkReal32 * MatrixPtr
Volume matrix. Access each input channel vector with AK::SpeakerVolumes::Matrix::GetChannel().
@ AK_MusicSyncBeat
Enable notifications on Music Beat. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:61
bool bStreaming
True if source is streaming, false otherwise.
Definition: AkCallback.h:133
AkReal32 fBarDuration
Bar Duration in seconds.
Definition: AkCallback.h:222
AkAudioDeviceEvent
Definition: AkCallback.h:382
uint32_t AkUInt32
Unsigned 32-bit integer.
@ AK_EnableGetMusicPlayPosition
Enable play position information of music objects, queried via AK::MusicEngine::GetPlayingSegmentInfo...
Definition: AkCallback.h:76
void(* AkDeviceStatusCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, AkAudioDeviceEvent in_idEvent, AKRESULT in_AkResult)
Definition: AkCallback.h:390
AkUInt64 AkOutputDeviceID
Audio Output device ID.
Definition: AkTypes.h:85
@ AK_MusicSyncPoint
Enable notifications on Music switch transition synchronization point. AkCallbackInfo can be cast to ...
Definition: AkCallback.h:67
AkReal32 pluginCPU
Pourcentage of the cpu time used by plugin processing. Please note that the numbers may add up when u...
Definition: AkCallback.h:246
AkTimeMs iCurrentPosition
Current position of the segment, relative to the Entry Cue, in milliseconds. Range is [-iPreEntryDura...
Definition: AkCallback.h:216
@ AkGlobalCallbackLocation_PostMessagesProcessed
After one or more messages have been processed, but before updating game object and listener position...
Definition: AkCallback.h:341
AkUInt32 uNumPlaylistItems
Number of items in playlist node (may be segments or other playlists)
Definition: AkCallback.h:208
AkReal32 fGridDuration
Grid duration in seconds.
Definition: AkCallback.h:223
AkUInt32 totalVoices
Number of active physical and virtual voices.
Definition: AkCallback.h:249
@ AK_SpeakerVolumeMatrix
Callback triggered at each frame, letting the client modify the speaker volume matrix....
Definition: AkCallback.h:54
AK::SpeakerVolumes::MatrixPtr pVolumes
Pointer to volume matrix describing the contribution of each source channel to destination channels....
Definition: AkCallback.h:165
AkMeteringFlags eMeteringFlags
Metering flags that were asked for in RegisterBusMeteringCallback(). You may only access correspondin...
Definition: AkCallback.h:179
AkUInt32 nbActiveEvents
Number of events triggered at a certain time.
Definition: AkCallback.h:250
AkUniqueID mediaID
Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file...
Definition: AkCallback.h:132
AkMIDIEvent midiEvent
MIDI event triggered by event.
Definition: AkCallback.h:106
AkUInt32 AkPlayingID
Playing ID.
Definition: AkTypes.h:55
@ AK_Marker
Callback triggered when encountering a marker during playback. AkCallbackInfo can be cast to AkMarker...
Definition: AkCallback.h:51
AkTimeMs iRemainingLookAheadTime
Number of milliseconds remaining in the "looking-ahead" state of the segment, when it is silent but s...
Definition: AkCallback.h:220
AkPlayingID playingID
Playing ID of Event, returned by PostEvent()
Definition: AkCallback.h:96
@ AK_MusicSyncUserCue
Enable notifications on Music Custom Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
Definition: AkCallback.h:66
@ AkGlobalCallbackLocation_BeginRender
Start of frame rendering, after having processed game messages.
Definition: AkCallback.h:342
AkUInt32 virtualVoices
Number of active virtual voices.
Definition: AkCallback.h:248
@ AK_MusicPlayStarted
Callback triggered when a "Play" or "Seek" command has been executed ("Seek" commands are issued from...
Definition: AkCallback.h:59
AkSegmentInfo segmentInfo
Segment information corresponding to the segment triggering this callback.
Definition: AkCallback.h:237
@ AkGlobalCallbackLocation_Monitor
Send monitor data.
Definition: AkCallback.h:349

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