_ak_callback_8h

Wwise SDK 2024.1.0

 /*******************************************************************************
 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
 released in source code form as part of the SDK installer package.
  
 Commercial License Usage
  
 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
 may use this file in accordance with the end user license agreement provided 
 with the software or, alternatively, in accordance with the terms contained in a
 written agreement between you and Audiokinetic Inc.
  
 Apache License Usage
  
 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
 "Apache License"); you may not use this file except in compliance with the 
 Apache License. You may obtain a copy of the Apache License at 
 http://www.apache.org/licenses/LICENSE-2.0.
  
 Unless required by applicable law or agreed to in writing, software distributed
 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
 the specific language governing permissions and limitations under the License.
  
   Copyright (c) 2024 Audiokinetic Inc.
 *******************************************************************************/
  
 // AkCallback.h
  
 /// \file 
 /// Declaration of callback prototypes
  
  
 #ifndef _AK_CALLBACK_H_
 #define _AK_CALLBACK_H_
  
 #include <AK/SoundEngine/Common/AkCommonDefs.h>
 #include <AK/SoundEngine/Common/AkMidiTypes.h>
  
 namespace AK
 {
     class IAkGlobalPluginContext;
     class IAkMixerInputContext;
     class IAkMixerPluginContext;
 }
  
 /// Type of callback. Used as a bitfield in methods AK::SoundEngine::PostEvent() and AK::SoundEngine::DynamicSequence::Open().
 enum AkCallbackType
 {
     AK_EndOfEvent                   = 0x0001,   ///< Callback triggered when reaching the end of an event. AkCallbackInfo can be cast to AkEventCallbackInfo.
     AK_EndOfDynamicSequenceItem     = 0x0002,   ///< Callback triggered when reaching the end of a dynamic sequence item. AkCallbackInfo can be cast to AkDynamicSequenceItemCallbackInfo.
     AK_Marker                       = 0x0004,   ///< Callback triggered when encountering a marker during playback. AkCallbackInfo can be cast to AkMarkerCallbackInfo.
     AK_Duration                     = 0x0008,   ///< Callback triggered when the duration of the sound is known by the sound engine. AkCallbackInfo can be cast to AkDurationCallbackInfo.
  
     AK_SpeakerVolumeMatrix          = 0x0010,   ///< Callback triggered at each frame, letting the client modify the speaker volume matrix. AkCallbackInfo can be cast to AkSpeakerVolumeMatrixCallbackInfo.
  
     AK_Starvation                   = 0x0020,   ///< Callback triggered when playback skips a frame due to stream starvation. AkCallbackInfo can be cast to AkEventCallbackInfo.
  
     AK_MusicPlaylistSelect          = 0x0040,   ///< Callback triggered when music playlist container must select the next item to play. AkCallbackInfo can be cast to AkMusicPlaylistCallbackInfo.
     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.
  
     AK_MusicSyncBeat                = 0x0100,   ///< Enable notifications on Music Beat. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
     AK_MusicSyncBar                 = 0x0200,   ///< Enable notifications on Music Bar. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
     AK_MusicSyncEntry               = 0x0400,   ///< Enable notifications on Music Entry Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
     AK_MusicSyncExit                = 0x0800,   ///< Enable notifications on Music Exit Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
     AK_MusicSyncGrid                = 0x1000,   ///< Enable notifications on Music Grid. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
     AK_MusicSyncUserCue             = 0x2000,   ///< Enable notifications on Music Custom Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
     AK_MusicSyncPoint               = 0x4000,   ///< Enable notifications on Music switch transition synchronization point. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.
  
     AK_MIDIEvent                    = 0x8000,   ///< Enable notifications for MIDI events. AkCallbackInfo can be cast to AkMIDIEventCallbackInfo.
  
     AK_Callback_Last                = 0x10000,  ///< Last calblack unused bit, invalid value.
  
     //A few useful bitmasks.
     AK_MusicSyncAll                 = 0x7f00,   ///< Use this flag if you want to receive all notifications concerning AK_MusicSync registration.   
     AK_CallbackBits                 = 0xffff,   ///< Bitmask for all callback types.
  
     // Not callback types, but need to be part of same bitfield for AK::SoundEngine::PostEvent().
     AK_EnableGetSourcePlayPosition  = 0x100000, ///< Enable play position information for use by AK::SoundEngine::GetSourcePlayPosition().
     AK_EnableGetMusicPlayPosition   = 0x200000, ///< Enable play position information of music objects, queried via AK::MusicEngine::GetPlayingSegmentInfo().
     AK_EnableGetSourceStreamBuffering = 0x400000,///< Enable stream buffering information for use by AK::SoundEngine::GetSourceStreamBuffering(). 
  
     AK_SourceInfo_Last              = 0x800000, ///< Last source info enable bit, invalid value.
 };
  
 /// Callback information structure used as base for all notifications handled by \ref AkCallbackFunc.
 /// \sa 
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_events
 struct AkCallbackInfo
 {
     void *          pCookie;        ///< User data, passed to PostEvent()
     AkGameObjectID  gameObjID;      ///< Game object ID
 };
  
 /// Callback information structure corresponding to \ref AK_EndOfEvent, \ref AK_MusicPlayStarted and \ref AK_Starvation.
 /// \sa 
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_events
 struct AkEventCallbackInfo : public AkCallbackInfo
 {
     AkPlayingID     playingID;      ///< Playing ID of Event, returned by PostEvent()
     AkUniqueID      eventID;        ///< Unique ID of Event, passed to PostEvent()
 };
  
 /// Callback information structure corresponding to \ref AkCallbackType::AK_MIDIEvent
 /// \sa 
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_events
 struct AkMIDIEventCallbackInfo : public AkEventCallbackInfo
 {
     AkMIDIEvent     midiEvent;      ///< MIDI event triggered by event.
 };
  
  
 /// Callback information structure corresponding to \ref AK_Marker.
 /// \sa 
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_events
 /// - \ref soundengine_markers
 struct AkMarkerCallbackInfo : public AkEventCallbackInfo
 {
     AkUInt32    uIdentifier;        ///< Cue point identifier
     AkUInt32    uPosition;          ///< Position in the cue point (unit: sample frames)
     const char* strLabel;           ///< Label of the marker (null-terminated)
     AkUInt32    uLabelSize;         ///< Size of the label string (including the terminating null character)
 };
  
 /// Callback information structure corresponding to \ref AK_Duration.
 /// \sa 
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_events
 struct AkDurationCallbackInfo : public AkEventCallbackInfo
 {
     AkReal32    fDuration;              ///< Duration of the sound (unit: milliseconds)
     AkReal32    fEstimatedDuration;     ///< Estimated duration of the sound depending on source settings such as pitch. (unit: milliseconds)
     AkUniqueID  audioNodeID;            ///< Audio Node ID of playing item
     AkUniqueID  mediaID;                ///< Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file)
     bool        bStreaming;             ///< True if source is streaming, false otherwise.
 };
  
 /// Callback information structure corresponding to \ref AK_EndOfDynamicSequenceItem.
 /// \sa 
 /// - AK::SoundEngine::PostEvent()
 /// - AK::SoundEngine::DynamicSequence::Open()
 /// - \ref soundengine_events
 struct AkDynamicSequenceItemCallbackInfo : public AkCallbackInfo
 {
     AkPlayingID playingID;          ///< Playing ID of Dynamic Sequence, returned by AK::SoundEngine:DynamicSequence::Open()
     AkUniqueID  audioNodeID;        ///< Audio Node ID of finished item
     void*       pCustomInfo;        ///< Custom info passed to the DynamicSequence::Open function
 };
  
 /// Structure describing basic information about the input of a mixer
 /// \sa 
 /// - \ref goingfurther_speakermatrixcallback
 /// - AkSpeakerVolumeMatrixCallbackInfo
 struct AkMixerInputInfo
 {
     AkConnectionType       eConnectionType;               ///< Nature of the connection between this input and the mixer.
     AkReal32               fCenterPerc;                   ///< Center percentage of this input, between 0 and 1.
     AkSpeakerPanningType   eSpeakerPanningType;           ///< Specifies type of panning logic when object is not 3D spatialized. Applicable only when eSpatializationMode is AK_SpatializationMode_None.
     Ak3DSpatializationMode eSpatializationMode;           ///< The 3D spatialization mode used by this input. Applicable only when the input has listener relative routing (see bHasListenerRelativeRouting).
     Ak3DPositionType       e3DPositionType;               ///< Get whether the emitter position is defined by the game alone (AK_3DPositionType_Emitter), or if it is further automated. Applicable only when the input has listener relative routing (see bHasListenerRelativeRouting).
     bool                   bHasListenerRelativeRouting;   ///< Get the value of this input's Listener Relative Routing option, that is, if the emitter-listener relative association is calculated at this node.
 };
  
 /// Callback information structure corresponding to \ref AK_SpeakerVolumeMatrix, and passed to callbacks registered in RegisterBusVolumeCallback()
 /// or PostEvent() with AK_SpeakerVolumeMatrix. These callbacks are called at every audio frame for every connection from an input (voice
 /// 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 
 /// having been scaled in accordance to volumes authored in Wwise. The volumes are passed via this structure as pointers because they can be modified
 /// in the callbacks. They are factored into two linear values ([0..1]): a common base value (pfBaseVolume), that is channel-agnostic and represents 
 /// the collapsed gain of all volume changes in Wwise (sliders, actions, RTPC, attenuations, ...), and a matrix of gains per input/output channel, 
 /// which depends on spatialization. Use the methods of AK::SpeakerVolumes::Matrix, defined in AkCommonDefs.h, to perform operations on them. 
 /// Access each input channel of the volumes matrix with AK::SpeakerVolumes::Matrix::GetChannel(), passing it the input and output channel configuration.
 /// Then, you may access each element of the output vector using the standard bracket [] operator. See AK::SpeakerVolumes for more details.
 /// It is crucial that the processing done in the callback be lightweight and non-blocking.
 /// \sa 
 /// - \ref goingfurther_speakermatrixcallback
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_events
 /// - AK::SoundEngine::RegisterBusVolumeCallback()
 struct AkSpeakerVolumeMatrixCallbackInfo : public AkEventCallbackInfo
 {
     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. 
     AkChannelConfig inputConfig;                ///< Channel configuration of the voice/bus.
     AkChannelConfig outputConfig;               ///< Channel configuration of the output bus.
     AkReal32 * pfBaseVolume;                    ///< Base volume, common to all channels.
     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.
     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.
     AkMixerInputInfo inputInfo;                 ///< Information about the current voice/bus about to be mixed into the output bus with specified base volume and volume matrix.
 };
  
 /// Callback information structure allowing to query signal metering on busses, at each frame, after having mixed all their inputs and processed their effects.
 /// Register the callback using AK::SoundEngine::RegisterBusMeteringCallback.
 struct AkBusMeteringCallbackInfo : public AkCallbackInfo
 {
     AK::AkMetering* pMetering;                  ///< Struct containing metering information.
     AkChannelConfig channelConfig;              ///< Channel configuration of the bus.
     AkMeteringFlags eMeteringFlags;             ///< Metering flags that were asked for in RegisterBusMeteringCallback(). You may only access corresponding meter values from in_pMeteringInfo. Others will fail.
 };
  
 /// Callback information structure allowing to query signal metering on output devices, at each frame.
 /// Register the callback using AK::SoundEngine::RegisterOutputDeviceMeteringCallback.
 struct AkOutputDeviceMeteringCallbackInfo : public AkCallbackInfo
 {
     AK::AkMetering * pMainMixMetering;                  ///< Metering information for the main mix
     AkChannelConfig mainMixConfig;                      ///< Channel configuration of the main mix
     AK::AkMetering * pPassthroughMetering;              ///< Metering information for the passthrough mix (if any; will be null otherwise)
     AkChannelConfig passthroughMixConfig;               ///< Channel configuration of the passthrough mix (if any; will be invalid otherwise)
     AkUInt32 uNumSystemAudioObjects;                    ///< Number of System Audio Objects going out of the output device
     AK::AkMetering ** ppSystemAudioObjectMetering;      ///< Metering information for each System Audio Object (number of elements is equal to uNumSystemAudioObjects)
     AkMeteringFlags eMeteringFlags;                     ///< Metering flags that were asked for in RegisterOutputDeviceMeteringCallback(). You may only access corresponding meter values from the metering objects. Others will fail.
 };
  
 /// Callback information structure corresponding to \ref AK_MusicPlaylistSelect.
 /// Called when a music playlist container must select its next item to play.
 /// The members uPlaylistSelection and uPlaylistItemDone are set by the sound
 /// engine before the callback function call.  They are set to the next item
 /// selected by the sound engine.  They are to be modified by the callback
 /// function if the selection is to be changed.
 /// \sa 
 /// - \ref soundengine_events
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_music_callbacks
 struct AkMusicPlaylistCallbackInfo : public AkEventCallbackInfo
 {
     AkUniqueID playlistID;          ///< ID of playlist node
     AkUInt32 uNumPlaylistItems;     ///< Number of items in playlist node (may be segments or other playlists)
     AkUInt32 uPlaylistSelection;    ///< Selection: set by sound engine, modified by callback function (if not in range 0 <= uPlaylistSelection < uNumPlaylistItems then ignored).
     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)
 };
  
 /// Structure used to query info on active playing segments.
 struct AkSegmentInfo
 {
     AkTimeMs        iCurrentPosition;       ///< Current position of the segment, relative to the Entry Cue, in milliseconds. Range is [-iPreEntryDuration, iActiveDuration+iPostExitDuration].
     AkTimeMs        iPreEntryDuration;      ///< Duration of the pre-entry region of the segment, in milliseconds.
     AkTimeMs        iActiveDuration;        ///< Duration of the active region of the segment (between the Entry and Exit Cues), in milliseconds.
     AkTimeMs        iPostExitDuration;      ///< Duration of the post-exit region of the segment, in milliseconds.
     AkTimeMs        iRemainingLookAheadTime;///< Number of milliseconds remaining in the "looking-ahead" state of the segment, when it is silent but streamed tracks are being prefetched.
     AkReal32        fBeatDuration;          ///< Beat Duration in seconds.
     AkReal32        fBarDuration;           ///< Bar Duration in seconds.
     AkReal32        fGridDuration;          ///< Grid duration in seconds.
     AkReal32        fGridOffset;            ///< Grid offset in seconds.
 };
  
 /// 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.
 /// If you need the Tempo, you can compute it using the fBeatDuration
 /// Tempo (beats per minute) = 60/fBeatDuration
 /// \sa 
 /// - \ref soundengine_events
 /// - AK::SoundEngine::PostEvent()
 /// - \ref soundengine_music_callbacks
 struct AkMusicSyncCallbackInfo : public AkCallbackInfo
 {
     AkPlayingID playingID;          ///< Playing ID of Event, returned by PostEvent()
     AkSegmentInfo segmentInfo;      ///< Segment information corresponding to the segment triggering this callback.
     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.
     char *   pszUserCueName;        ///< Cue name (UTF-8 string). Set for notifications AK_MusicSyncUserCue. NULL if cue has no name.
 };
  
 /// Resources data summary structure containing general information about the system
 struct AkResourceMonitorDataSummary
 {
     AkReal32    totalCPU;       ///< Pourcentage of the cpu time used for processing audio. Please note that the numbers may add up when using multiple threads.
     AkReal32    pluginCPU;      ///< Pourcentage of the cpu time used by plugin processing. Please note that the numbers may add up when using multiple threads.
     AkUInt32    physicalVoices; ///< Number of active physical voices
     AkUInt32    virtualVoices;  ///< Number of active virtual voices
     AkUInt32    totalVoices;    ///< Number of active physical and virtual voices
     AkUInt32    nbActiveEvents; ///< Number of events triggered at a certain time
 };
  
 /// Function called on completion of an event, or when a marker is reached.
 /// \param in_eType Type of callback.
 /// \param in_pCallbackInfo Pointer to structure containing callback information. This pointer is invalidated as soon as the callback function returns.
 /// \remarks An event is considered completed once all of its actions have been executed and all the playbacks in this events are terminated.
 /// \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.
 /// \remarks Before waiting on an \ref AK_EndOfEvent, make sure that the event is going to end. 
 /// 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.
 /// \sa 
 /// - AK::SoundEngine::PostEvent()
 /// - AK::SoundEngine::DynamicSequence::Open()
 /// - \ref soundengine_events
 /// - \ref soundengine_markers
 /// - \ref soundengine_music_callbacks
 AK_CALLBACK( void, AkCallbackFunc )( 
     AkCallbackType in_eType,                            ///< Callback type.
     AkCallbackInfo* in_pCallbackInfo                    ///< Structure containing desired information. You can cast it to the proper sub-type, depending on the callback type.
     );
  
 /// Function called on at every audio frame for the specified registered busses.
 /// \sa 
 /// - AkSpeakerVolumeMatrixCallbackInfo
 /// - AK::SoundEngine::RegisterBusVolumeCallback()
 /// - \ref goingfurther_speakermatrixcallback
 AK_CALLBACK( void, AkBusCallbackFunc )( 
     AkSpeakerVolumeMatrixCallbackInfo* in_pCallbackInfo ///< Structure containing desired bus information. 
     );
  
 /// Function called on at every audio frame for the specified registered busses, just after metering has been computed.
 /// \sa 
 /// - AK::SoundEngine::RegisterBusMeteringCallback()
 /// - AK::AkMetering
 /// - AkBusMeteringCallbackInfo
 /// - \ref goingfurther_speakermatrixcallback
 AK_CALLBACK( void, AkBusMeteringCallbackFunc )( 
     AkBusMeteringCallbackInfo * in_pCallbackInfo        ///< Structure containing desired bus information.
     );
  
 /// Function called on at every audio frame for the specified registered output devices, just after metering has been computed.
 /// \sa 
 /// - AK::SoundEngine::RegisterOutputDeviceMeteringCallback()
 /// - AK::AkMetering
 /// - AkOutputDeviceMeteringCallbackInfo
 /// - \ref goingfurther_speakermatrixcallback
 AK_CALLBACK( void, AkOutputDeviceMeteringCallbackFunc )(
     AkOutputDeviceMeteringCallbackInfo * in_pCallbackInfo       ///< Structure containing desired output device information.
     );
  
 /// Callback prototype used with asynchronous bank load/unload requests.
 /// This function is called when the bank request has been processed 
 /// and indicates if it was successfully executed or if an error occurred.
 /// \param in_bankID Identifier of the bank that was explicitly loaded/unloaded. 
 /// In the case of PrepareEvent() or PrepareGameSyncs(), this value contains 
 /// the AkUniqueID of the event/game sync that was prepared/unprepared, if the array contained only
 /// one element. Otherwise, in_bankID equals AK_INVALID_UNIQUE_ID.
 /// \param in_pInMemoryBankPtr Value returned when the unloaded bank was loaded using an in memory location
 /// \param in_eLoadResult Result of the requested action.
 /// - AK_Success: Load or unload successful.
 /// - AK_IDNotFound: At least one of the event/game sync identifiers passed to PrepareEvent() or PrepareGameSyncs() does not exist.
 /// - AK_InsufficientMemory: Insufficient memory to store bank data.
 /// - AK_BankReadError: I/O error.
 /// - AK_WrongBankVersion: Invalid bank version: make sure the version of Wwise that 
 /// you used to generate the SoundBanks matches that of the SDK you are currently using.
 /// - AK_InvalidFile: File specified could not be opened.
 /// - AK_InvalidParameter: Invalid parameter.
 /// - AK_Fail: Load or unload failed for any other reason. (Most likely small allocation failure)
 /// \param in_pCookie Optional cookie that was passed to the bank request.
 /// \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.
 /// \sa 
 /// - AK::SoundEngine::LoadBank()
 /// - AK::SoundEngine::UnloadBank()
 /// - AK::SoundEngine::PrepareEvent()
 /// - AK::SoundEngine::PrepareGameSyncs()
 /// - \ref soundengine_banks
 AK_CALLBACK( void, AkBankCallbackFunc )(
     AkUInt32        in_bankID,
     const void *    in_pInMemoryBankPtr,
     AKRESULT        in_eLoadResult,
     void *          in_pCookie
     );
  
 /// Bit field of various locations in the audio processing loop where the game can be called back.
 enum AkGlobalCallbackLocation
 {
     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.
  
     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.
  
         AkGlobalCallbackLocation_PreProcessMessageQueueForRender = (1 << 2),    ///< Start of frame rendering, before having processed game messages.
         AkGlobalCallbackLocation_PostMessagesProcessed = (1 << 3),              ///< After one or more messages have been processed, but before updating game object and listener positions internally.
         AkGlobalCallbackLocation_BeginRender = (1 << 4),    ///< Start of frame rendering, after having processed game messages.
         AkGlobalCallbackLocation_EndRender = (1 << 5),      ///< End of frame rendering.
  
     AkGlobalCallbackLocation_End = (1 << 6),        ///< End of audio processing.
  
     AkGlobalCallbackLocation_Term = (1 << 7),       ///< Sound engine termination.
  
     AkGlobalCallbackLocation_Monitor = (1 << 8),        ///< Send monitor data
     AkGlobalCallbackLocation_MonitorRecap = (1 << 9),   ///< Send monitor data connection to recap.
  
     AkGlobalCallbackLocation_Init = (1 << 10),      ///< Sound engine initialization.
  
     AkGlobalCallbackLocation_Suspend = (1 << 11),           ///< Sound engine suspension through \ref AK::SoundEngine::Suspend
     AkGlobalCallbackLocation_WakeupFromSuspend = (1 << 12), ///< Sound engine awakening through \ref AK::SoundEngine::WakeupFromSuspend
  
     AkGlobalCallbackLocation_ProfilerConnect = (1 << 13),       ///< Wwise Profiler has connected to the game.
     AkGlobalCallbackLocation_ProfilerDisconnect = (1 << 14),    ///< Wwise Profiler has disconnected from the game.
  
  
     // IMPORTANT: Keep in sync with number of locations.
     AkGlobalCallbackLocation_Num = 15               ///< Total number of global callback locations.
 };
  
 /// Callback prototype used for global callback registration.
 /// 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
 /// that were passed to RegisterGlobalCallback(). See the possible values of AkGlobalCallbackLocation for more details about the available locations.
 /// \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.
 /// \sa
 /// - AK::SoundEngine::RegisterGlobalCallback()
 /// - AK::SoundEngine::UnregisterGlobalCallback()
 AK_CALLBACK( void, AkGlobalCallbackFunc )(
     AK::IAkGlobalPluginContext * in_pContext,   ///< Engine context.
     AkGlobalCallbackLocation in_eLocation,      ///< Location where this callback is fired.
     void * in_pCookie                           ///< User cookie passed to AK::SoundEngine::RegisterGlobalCallback().
     );
  
  
 AK_CALLBACK( void, AkResourceMonitorCallbackFunc )(
     const AkResourceMonitorDataSummary * in_pdataSummary        ///< Data summary passed to the function registered using AK::SoundEngine::RegisterResourceMonitorCallback().
     );
  
 namespace AK
 {
     enum AkAudioDeviceEvent 
     { 
         AkAudioDeviceEvent_Initialization,              ///< Sent after an Audio Device has initialized.  Initialization might have failed, check the AKRESULT.
         AkAudioDeviceEvent_Removal,                     ///< Audio device was removed through explicit call (AK::SoundEngine::RemoveOutput or AK::SoundEngine::Term)
         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.
         AkAudioDeviceEvent_Last                         ///< End of enum, invalid value.
     };
  
     /// Callback for Audio Device status changes.
     /// \sa AK::SoundEngine::AddOutput
     AK_CALLBACK(void, AkDeviceStatusCallbackFunc)(
         AK::IAkGlobalPluginContext * in_pContext,   ///< Engine context.
         AkUniqueID in_idAudioDeviceShareset,        ///< The audio device shareset attached, as passed to AK::SoundEngine::AddOutput or AK::SoundEngine::Init
         AkUInt32 in_idDeviceID,                     ///< The audio device specific id, as passed to AK::SoundEngine::AddOutput or AK::SoundEngine::Init
         AkAudioDeviceEvent in_idEvent,              ///< The event for which this callback was called.  See AK::AkAudioDeviceEvent.  AKRESULT may provide more information.
         AKRESULT in_AkResult                        ///< Result of the last operation.
         );
 }
  
 /// Callback prototype used for audio capture callback registration.
 /// This callback will be called at the end of each audio frame for each output device that has been registered.
 /// \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.
 /// \remarks The processing time in the callback function should be minimal. Having too much processing time could cause voice starvation during real-time rendering.
 /// \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.
 /// \sa
 /// - AK::SoundEngine::RenderAudio()
 /// - AK::SoundEngine::RegisterCaptureCallback()
 /// - AK::SoundEngine::UnregisterCaptureCallback()
 AK_CALLBACK(void, AkCaptureCallbackFunc)(
     AkAudioBuffer& in_CaptureBuffer,            ///< Capture audio buffer. The data is always float interleaved.
     AkOutputDeviceID in_idOutput,               ///< The audio device specific id, as passed to AK::SoundEngine::AddOutput or AK::SoundEngine::Init
     void* in_pCookie                            ///< Callback cookie that will be sent to the callback function along with additional information
     );
  
 #endif // _AK_CALLBACK_H_
  

AK::IAkMixerPluginContext

Interface to retrieve contextual information for a mixer.

Definition: IAkPlugin.h:445

AK_MIDIEvent

@ AK_MIDIEvent

Enable notifications for MIDI events. AkCallbackInfo can be cast to AkMIDIEventCallbackInfo.

Definition: AkCallback.h:69

AkMIDIEventCallbackInfo

Definition: AkCallback.h:110

AkGlobalCallbackLocation_Num

@ AkGlobalCallbackLocation_Num

Total number of global callback locations.

Definition: AkCallback.h:382

AkMixerInputInfo::eSpatializationMode

Ak3DSpatializationMode eSpatializationMode

The 3D spatialization mode used by this input. Applicable only when the input has listener relative r...

Definition: AkCallback.h:162

AkMarkerCallbackInfo::strLabel

const char * strLabel

Label of the marker (null-terminated)

Definition: AkCallback.h:124

AkDurationCallbackInfo::audioNodeID

AkUniqueID audioNodeID

Audio Node ID of playing item.

Definition: AkCallback.h:136

AkResourceMonitorDataSummary

Resources data summary structure containing general information about the system.

Definition: AkCallback.h:264

AkOutputDeviceMeteringCallbackInfo::ppSystemAudioObjectMetering

AK::AkMetering ** ppSystemAudioObjectMetering

Metering information for each System Audio Object (number of elements is equal to uNumSystemAudioObje...

Definition: AkCallback.h:211

AkTimeMs

AkInt32 AkTimeMs

Time in ms.

Definition: AkTypes.h:56

Definition of data structures for AkAudioObject.

Definition: AkWwiseSDKVersion.cs:31

AkDurationCallbackInfo

Definition: AkCallback.h:133

AkMusicSyncCallbackInfo::pszUserCueName

char * pszUserCueName

Cue name (UTF-8 string). Set for notifications AK_MusicSyncUserCue. NULL if cue has no name.

Definition: AkCallback.h:259

AK_EndOfEvent

@ AK_EndOfEvent

Callback triggered when reaching the end of an event. AkCallbackInfo can be cast to AkEventCallbackIn...

Definition: AkCallback.h:49

AkCallbackInfo::gameObjID

AkGameObjectID gameObjID

Game object ID.

Definition: AkCallback.h:92

AK::AkAudioDeviceEvent_Initialization

@ AkAudioDeviceEvent_Initialization

Sent after an Audio Device has initialized. Initialization might have failed, check the AKRESULT.

Definition: AkCallback.h:407

AK_MusicSyncEntry

@ AK_MusicSyncEntry

Enable notifications on Music Entry Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.

Definition: AkCallback.h:63

AkEventCallbackInfo

Definition: AkCallback.h:100

AkMixerInputInfo::bHasListenerRelativeRouting

bool bHasListenerRelativeRouting

Get the value of this input's Listener Relative Routing option, that is, if the emitter-listener rela...

Definition: AkCallback.h:164

AkResourceMonitorCallbackFunc

void(* AkResourceMonitorCallbackFunc)(const AkResourceMonitorDataSummary *in_pdataSummary)

Definition: AkCallback.h:399

AK_MusicSyncBar

@ AK_MusicSyncBar

Enable notifications on Music Bar. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.

Definition: AkCallback.h:62

AkMixerInputInfo::e3DPositionType

Ak3DPositionType e3DPositionType

Get whether the emitter position is defined by the game alone (AK_3DPositionType_Emitter),...

Definition: AkCallback.h:163

AkSpeakerVolumeMatrixCallbackInfo::pfBaseVolume

AkReal32 * pfBaseVolume

Base volume, common to all channels.

Definition: AkCallback.h:187

AkGlobalCallbackLocation_EndRender

@ AkGlobalCallbackLocation_EndRender

End of frame rendering.

Definition: AkCallback.h:363

AkOutputDeviceMeteringCallbackInfo::mainMixConfig

AkChannelConfig mainMixConfig

Channel configuration of the main mix.

Definition: AkCallback.h:207

AkMarkerCallbackInfo

Definition: AkCallback.h:121

AkMusicPlaylistCallbackInfo::uPlaylistSelection

AkUInt32 uPlaylistSelection

Selection: set by sound engine, modified by callback function (if not in range 0 <= uPlaylistSelectio...

Definition: AkCallback.h:229

AK_SourceInfo_Last

@ AK_SourceInfo_Last

Last source info enable bit, invalid value.

Definition: AkCallback.h:82

AkGlobalCallbackLocation_Begin

@ AkGlobalCallbackLocation_Begin

Start of audio processing. The number of frames about to be rendered depends on the sink/end-point an...

Definition: AkCallback.h:358

AkGlobalCallbackLocation_Register

@ AkGlobalCallbackLocation_Register

Right after successful registration of callback/plugin. Typically used by plugins along with AkGlobal...

Definition: AkCallback.h:356

AkSpeakerVolumeMatrixCallbackInfo::outputConfig

AkChannelConfig outputConfig

Channel configuration of the output bus.

Definition: AkCallback.h:186

AkGlobalCallbackLocation_ProfilerDisconnect

@ AkGlobalCallbackLocation_ProfilerDisconnect

Wwise Profiler has disconnected from the game.

Definition: AkCallback.h:378

AkBusMeteringCallbackInfo

Definition: AkCallback.h:196

AkCallbackInfo

Definition: AkCallback.h:90

AK_Duration

@ AK_Duration

Callback triggered when the duration of the sound is known by the sound engine. AkCallbackInfo can be...

Definition: AkCallback.h:52

AkMixerInputInfo::eConnectionType

AkConnectionType eConnectionType

Nature of the connection between this input and the mixer.

Definition: AkCallback.h:159

AkGlobalCallbackLocation_End

@ AkGlobalCallbackLocation_End

End of audio processing.

Definition: AkCallback.h:365

AkSegmentInfo::iActiveDuration

AkTimeMs iActiveDuration

Duration of the active region of the segment (between the Entry and Exit Cues), in milliseconds.

Definition: AkCallback.h:238

AkSpeakerVolumeMatrixCallbackInfo::inputConfig

AkChannelConfig inputConfig

Channel configuration of the voice/bus.

Definition: AkCallback.h:185

AkGameObjectID

AkUInt64 AkGameObjectID

Game object ID.

Definition: AkTypes.h:60

AK_MusicSyncAll

@ AK_MusicSyncAll

Use this flag if you want to receive all notifications concerning AK_MusicSync registration.

Definition: AkCallback.h:74

AkGlobalCallbackLocation_Term

@ AkGlobalCallbackLocation_Term

Sound engine termination.

Definition: AkCallback.h:367

AkChannelConfig

Definition: AkSpeakerConfig.h:444

AKRESULT

Standard function call result.

Definition: AkTypes.h:134

AkGlobalCallbackFunc

void(* AkGlobalCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkGlobalCallbackLocation in_eLocation, void *in_pCookie)

Definition: AkCallback.h:392

AkMeteringFlags

Metering flags. Used for specifying bus metering, through AK::SoundEngine::RegisterBusVolumeCallback(...

Definition: AkTypes.h:1171

AK_Callback_Last

@ AK_Callback_Last

Last calblack unused bit, invalid value.

Definition: AkCallback.h:71

AkSpeakerVolumeMatrixCallbackInfo::pMixerContext

AK::IAkMixerPluginContext * pMixerContext

Output mixing bus context. Use it to access a few useful panning and mixing services,...

Definition: AkCallback.h:189

AkSegmentInfo

Structure used to query info on active playing segments.

Definition: AkCallback.h:235

AkSegmentInfo::fBeatDuration

AkReal32 fBeatDuration

Beat Duration in seconds.

Definition: AkCallback.h:241

AK_CallbackBits

@ AK_CallbackBits

Bitmask for all callback types.

Definition: AkCallback.h:75

AK::AkAudioDeviceEvent_SystemRemoval

@ AkAudioDeviceEvent_SystemRemoval

Audio device was removed because of a system event (disconnection), hardware or driver problem....

Definition: AkCallback.h:409

AkBusMeteringCallbackFunc

void(* AkBusMeteringCallbackFunc)(AkBusMeteringCallbackInfo *in_pCallbackInfo)

Definition: AkCallback.h:306

AkGlobalCallbackLocation_Suspend

@ AkGlobalCallbackLocation_Suspend

Sound engine suspension through AK::SoundEngine::Suspend.

Definition: AkCallback.h:374

AkCallbackType

Type of callback. Used as a bitfield in methods AK::SoundEngine::PostEvent() and AK::SoundEngine::Dyn...

Definition: AkCallback.h:48

AkDurationCallbackInfo::fDuration

AkReal32 fDuration

Duration of the sound (unit: milliseconds)

Definition: AkCallback.h:134

AkMIDIEvent

Definition: AkMidiTypes.h:178

AkGlobalCallbackLocation_WakeupFromSuspend

@ AkGlobalCallbackLocation_WakeupFromSuspend

Sound engine awakening through AK::SoundEngine::WakeupFromSuspend.

Definition: AkCallback.h:375

AkGlobalCallbackLocation_Init

@ AkGlobalCallbackLocation_Init

Sound engine initialization.

Definition: AkCallback.h:372

AkOutputDeviceMeteringCallbackFunc

void(* AkOutputDeviceMeteringCallbackFunc)(AkOutputDeviceMeteringCallbackInfo *in_pCallbackInfo)

Definition: AkCallback.h:316

AkSegmentInfo::iPreEntryDuration

AkTimeMs iPreEntryDuration

Duration of the pre-entry region of the segment, in milliseconds.

Definition: AkCallback.h:237

AkReal32

float AkReal32

32-bit floating point

Definition: AkNumeralTypes.h:46

AkOutputDeviceMeteringCallbackInfo::passthroughMixConfig

AkChannelConfig passthroughMixConfig

Channel configuration of the passthrough mix (if any; will be invalid otherwise)

Definition: AkCallback.h:209

AkBusMeteringCallbackInfo::pMetering

AK::AkMetering * pMetering

Struct containing metering information.

Definition: AkCallback.h:197

AkOutputDeviceMeteringCallbackInfo::pMainMixMetering

AK::AkMetering * pMainMixMetering

Metering information for the main mix.

Definition: AkCallback.h:206

AkDynamicSequenceItemCallbackInfo::pCustomInfo

void * pCustomInfo

Custom info passed to the DynamicSequence::Open function.

Definition: AkCallback.h:150

AK::AkAudioDeviceEvent_Last

@ AkAudioDeviceEvent_Last

End of enum, invalid value.

Definition: AkCallback.h:410

AkEventCallbackInfo::eventID

AkUniqueID eventID

Unique ID of Event, passed to PostEvent()

Definition: AkCallback.h:102

AkMarkerCallbackInfo::uIdentifier

AkUInt32 uIdentifier

Cue point identifier.

Definition: AkCallback.h:122

AK_Starvation

@ AK_Starvation

Callback triggered when playback skips a frame due to stream starvation. AkCallbackInfo can be cast t...

Definition: AkCallback.h:56

AkMusicSyncCallbackInfo::musicSyncType

AkCallbackType musicSyncType

Would be either AK_MusicSyncEntry, AK_MusicSyncBeat, AK_MusicSyncBar, AK_MusicSyncExit,...

Definition: AkCallback.h:258

AkUniqueID

AkUInt32 AkUniqueID

Unique 32-bit ID.

Definition: AkTypes.h:52

AK_EnableGetSourceStreamBuffering

@ AK_EnableGetSourceStreamBuffering

Enable stream buffering information for use by AK::SoundEngine::GetSourceStreamBuffering().

Definition: AkCallback.h:80

AkSegmentInfo::fGridOffset

AkReal32 fGridOffset

Grid offset in seconds.

Definition: AkCallback.h:244

Ak3DSpatializationMode

3D spatialization mode.

Definition: AkTypes.h:1160

AkMarkerCallbackInfo::uLabelSize

AkUInt32 uLabelSize

Size of the label string (including the terminating null character)

Definition: AkCallback.h:125

AkMarkerCallbackInfo::uPosition

AkUInt32 uPosition

Position in the cue point (unit: sample frames)

Definition: AkCallback.h:123

AkResourceMonitorDataSummary::physicalVoices

AkUInt32 physicalVoices

Number of active physical voices.

Definition: AkCallback.h:267

AkMixerInputInfo::eSpeakerPanningType

AkSpeakerPanningType eSpeakerPanningType

Specifies type of panning logic when object is not 3D spatialized. Applicable only when eSpatializati...

Definition: AkCallback.h:161

AK::AkAudioDeviceEvent_Removal

@ AkAudioDeviceEvent_Removal

Audio device was removed through explicit call (AK::SoundEngine::RemoveOutput or AK::SoundEngine::Ter...

Definition: AkCallback.h:408

AkGlobalCallbackLocation_MonitorRecap

@ AkGlobalCallbackLocation_MonitorRecap

Send monitor data connection to recap.

Definition: AkCallback.h:370

AkCaptureCallbackFunc

void(* AkCaptureCallbackFunc)(AkAudioBuffer &in_CaptureBuffer, AkOutputDeviceID in_idOutput, void *in_pCookie)

Definition: AkCallback.h:433

AkMusicSyncCallbackInfo::playingID

AkPlayingID playingID

Playing ID of Event, returned by PostEvent()

Definition: AkCallback.h:256

AK_MusicSyncGrid

@ AK_MusicSyncGrid

Enable notifications on Music Grid. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.

Definition: AkCallback.h:65

AkCallbackFunc

void(* AkCallbackFunc)(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)

Definition: AkCallback.h:286

AkGlobalCallbackLocation

Bit field of various locations in the audio processing loop where the game can be called back.

Definition: AkCallback.h:355

AkResourceMonitorDataSummary::totalCPU

AkReal32 totalCPU

Pourcentage of the cpu time used for processing audio. Please note that the numbers may add up when u...

Definition: AkCallback.h:265

AkMixerInputInfo::fCenterPerc

AkReal32 fCenterPerc

Center percentage of this input, between 0 and 1.

Definition: AkCallback.h:160

AkSegmentInfo::iPostExitDuration

AkTimeMs iPostExitDuration

Duration of the post-exit region of the segment, in milliseconds.

Definition: AkCallback.h:239

AkGlobalCallbackLocation_PreProcessMessageQueueForRender

@ AkGlobalCallbackLocation_PreProcessMessageQueueForRender

Start of frame rendering, before having processed game messages.

Definition: AkCallback.h:360

AkSpeakerVolumeMatrixCallbackInfo

Definition: AkCallback.h:183

AkMusicPlaylistCallbackInfo::uPlaylistItemDone

AkUInt32 uPlaylistItemDone

Playlist node done: set by sound engine, modified by callback function (if set to anything but 0 then...

Definition: AkCallback.h:230

AkSpeakerVolumeMatrixCallbackInfo::pfEmitterListenerVolume

AkReal32 * pfEmitterListenerVolume

Emitter-listener pair-specific gain. When there are multiple emitter-listener pairs,...

Definition: AkCallback.h:188

AK_CALLBACK

#define AK_CALLBACK(_type, _name)

Definition: AkSoundEngineExport.h:87

AK_EnableGetSourcePlayPosition

@ AK_EnableGetSourcePlayPosition

Enable play position information for use by AK::SoundEngine::GetSourcePlayPosition().

Definition: AkCallback.h:78

AkDurationCallbackInfo::fEstimatedDuration

AkReal32 fEstimatedDuration

Estimated duration of the sound depending on source settings such as pitch. (unit: milliseconds)

Definition: AkCallback.h:135

AK::IAkGlobalPluginContext

Definition: IAkPlugin.h:1237

AkMusicPlaylistCallbackInfo

Definition: AkCallback.h:226

AkBusCallbackFunc

void(* AkBusCallbackFunc)(AkSpeakerVolumeMatrixCallbackInfo *in_pCallbackInfo)

Definition: AkCallback.h:296

AkDynamicSequenceItemCallbackInfo::audioNodeID

AkUniqueID audioNodeID

Audio Node ID of finished item.

Definition: AkCallback.h:149

AkOutputDeviceMeteringCallbackInfo::uNumSystemAudioObjects

AkUInt32 uNumSystemAudioObjects

Number of System Audio Objects going out of the output device.

Definition: AkCallback.h:210

AkMusicPlaylistCallbackInfo::playlistID

AkUniqueID playlistID

ID of playlist node.

Definition: AkCallback.h:227

AkMixerInputInfo

Definition: AkCallback.h:158

AkDynamicSequenceItemCallbackInfo::playingID

AkPlayingID playingID

Playing ID of Dynamic Sequence, returned by AK::SoundEngine:DynamicSequence::Open()

Definition: AkCallback.h:148

AkCallbackInfo::pCookie

void * pCookie

User data, passed to PostEvent()

Definition: AkCallback.h:91

AkOutputDeviceMeteringCallbackInfo::eMeteringFlags

AkMeteringFlags eMeteringFlags

Metering flags that were asked for in RegisterOutputDeviceMeteringCallback(). You may only access cor...

Definition: AkCallback.h:212

AK_EndOfDynamicSequenceItem

@ AK_EndOfDynamicSequenceItem

Callback triggered when reaching the end of a dynamic sequence item. AkCallbackInfo can be cast to Ak...

Definition: AkCallback.h:50

AkBankCallbackFunc

void(* AkBankCallbackFunc)(AkUInt32 in_bankID, const void *in_pInMemoryBankPtr, AKRESULT in_eLoadResult, void *in_pCookie)

Definition: AkCallback.h:346

AkGlobalCallbackLocation_ProfilerConnect

@ AkGlobalCallbackLocation_ProfilerConnect

Wwise Profiler has connected to the game.

Definition: AkCallback.h:377

AkOutputDeviceMeteringCallbackInfo::pPassthroughMetering

AK::AkMetering * pPassthroughMetering

Metering information for the passthrough mix (if any; will be null otherwise)

Definition: AkCallback.h:208

AkBusMeteringCallbackInfo::channelConfig

AkChannelConfig channelConfig

Channel configuration of the bus.

Definition: AkCallback.h:198

AK::AkMetering

Struct containing metering information about a buffer. Depending on when this struct is generated,...

Definition: AkCommonDefs.h:192

AK_MusicPlaylistSelect

@ AK_MusicPlaylistSelect

Callback triggered when music playlist container must select the next item to play....

Definition: AkCallback.h:58

AK_MusicSyncExit

@ AK_MusicSyncExit

Enable notifications on Music Exit Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.

Definition: AkCallback.h:64

AK::SpeakerVolumes::MatrixPtr

AkReal32 * MatrixPtr

Volume matrix. Access each input channel vector with AK::SpeakerVolumes::Matrix::GetChannel().

Definition: AkSpeakerVolumes.h:50

AK_MusicSyncBeat

@ AK_MusicSyncBeat

Enable notifications on Music Beat. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.

Definition: AkCallback.h:61

AkCommonDefs.h

AkDurationCallbackInfo::bStreaming

bool bStreaming

True if source is streaming, false otherwise.

Definition: AkCallback.h:138

AkSegmentInfo::fBarDuration

AkReal32 fBarDuration

Bar Duration in seconds.

Definition: AkCallback.h:242

AkOutputDeviceMeteringCallbackInfo

Definition: AkCallback.h:205

AK::AkAudioDeviceEvent

AkAudioDeviceEvent

Definition: AkCallback.h:406

AkUInt32

uint32_t AkUInt32

Unsigned 32-bit integer.

Definition: AkNumeralTypes.h:38

AK_EnableGetMusicPlayPosition

@ AK_EnableGetMusicPlayPosition

Enable play position information of music objects, queried via AK::MusicEngine::GetPlayingSegmentInfo...

Definition: AkCallback.h:79

AK::AkDeviceStatusCallbackFunc

void(* AkDeviceStatusCallbackFunc)(AK::IAkGlobalPluginContext *in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, AkAudioDeviceEvent in_idEvent, AKRESULT in_AkResult)

Definition: AkCallback.h:415

AkSpeakerPanningType

Speaker panning type: type of panning logic when object is not 3D spatialized (i.e....

Definition: AkTypes.h:1123

AkOutputDeviceID

AkUInt64 AkOutputDeviceID

Audio Output device ID.

Definition: AkTypes.h:85

AK_MusicSyncPoint

@ AK_MusicSyncPoint

Enable notifications on Music switch transition synchronization point. AkCallbackInfo can be cast to ...

Definition: AkCallback.h:67

AkResourceMonitorDataSummary::pluginCPU

AkReal32 pluginCPU

Pourcentage of the cpu time used by plugin processing. Please note that the numbers may add up when u...

Definition: AkCallback.h:266

AkAudioBuffer

Definition: AkCommonDefs.h:321

AkSegmentInfo::iCurrentPosition

AkTimeMs iCurrentPosition

Current position of the segment, relative to the Entry Cue, in milliseconds. Range is [-iPreEntryDura...

Definition: AkCallback.h:236

AkGlobalCallbackLocation_PostMessagesProcessed

@ AkGlobalCallbackLocation_PostMessagesProcessed

After one or more messages have been processed, but before updating game object and listener position...

Definition: AkCallback.h:361

AkMusicPlaylistCallbackInfo::uNumPlaylistItems

AkUInt32 uNumPlaylistItems

Number of items in playlist node (may be segments or other playlists)

Definition: AkCallback.h:228

AkSegmentInfo::fGridDuration

AkReal32 fGridDuration

Grid duration in seconds.

Definition: AkCallback.h:243

AkResourceMonitorDataSummary::totalVoices

AkUInt32 totalVoices

Number of active physical and virtual voices.

Definition: AkCallback.h:269

AkMidiTypes.h

AkSpeakerVolumeMatrixCallbackInfo::inputInfo

AkMixerInputInfo inputInfo

Information about the current voice/bus about to be mixed into the output bus with specified base vol...

Definition: AkCallback.h:190

AK_SpeakerVolumeMatrix

@ AK_SpeakerVolumeMatrix

Callback triggered at each frame, letting the client modify the speaker volume matrix....

Definition: AkCallback.h:54

AkSpeakerVolumeMatrixCallbackInfo::pVolumes

AK::SpeakerVolumes::MatrixPtr pVolumes

Pointer to volume matrix describing the contribution of each source channel to destination channels....

Definition: AkCallback.h:184

AkBusMeteringCallbackInfo::eMeteringFlags

AkMeteringFlags eMeteringFlags

Metering flags that were asked for in RegisterBusMeteringCallback(). You may only access correspondin...

Definition: AkCallback.h:199

AkDynamicSequenceItemCallbackInfo

Definition: AkCallback.h:147

AkResourceMonitorDataSummary::nbActiveEvents

AkUInt32 nbActiveEvents

Number of events triggered at a certain time.

Definition: AkCallback.h:270

Ak3DPositionType

3D position type: defines what acts as the emitter position for computing spatialization against the ...

Definition: AkTypes.h:1133

AkDurationCallbackInfo::mediaID

AkUniqueID mediaID

Media ID of playing item. (corresponds to 'ID' attribute of 'File' element in SoundBank metadata file...

Definition: AkCallback.h:137

AkMusicSyncCallbackInfo

Definition: AkCallback.h:255

AkMIDIEventCallbackInfo::midiEvent

AkMIDIEvent midiEvent

MIDI event triggered by event.

Definition: AkCallback.h:111

AkConnectionType

Nature of the connection binding an input to a bus.

Definition: AkTypes.h:324

AkPlayingID

AkUInt32 AkPlayingID

Playing ID.

Definition: AkTypes.h:55

AK_Marker

@ AK_Marker

Callback triggered when encountering a marker during playback. AkCallbackInfo can be cast to AkMarker...

Definition: AkCallback.h:51

AkSegmentInfo::iRemainingLookAheadTime

AkTimeMs iRemainingLookAheadTime

Number of milliseconds remaining in the "looking-ahead" state of the segment, when it is silent but s...

Definition: AkCallback.h:240

AkEventCallbackInfo::playingID

AkPlayingID playingID

Playing ID of Event, returned by PostEvent()

Definition: AkCallback.h:101

AK_MusicSyncUserCue

@ AK_MusicSyncUserCue

Enable notifications on Music Custom Cue. AkCallbackInfo can be cast to AkMusicSyncCallbackInfo.

Definition: AkCallback.h:66

AkGlobalCallbackLocation_BeginRender

@ AkGlobalCallbackLocation_BeginRender

Start of frame rendering, after having processed game messages.

Definition: AkCallback.h:362

AkResourceMonitorDataSummary::virtualVoices

AkUInt32 virtualVoices

Number of active virtual voices.

Definition: AkCallback.h:268

AK_MusicPlayStarted

@ AK_MusicPlayStarted

Callback triggered when a "Play" or "Seek" command has been executed ("Seek" commands are issued from...

Definition: AkCallback.h:59

AkMusicSyncCallbackInfo::segmentInfo

AkSegmentInfo segmentInfo

Segment information corresponding to the segment triggering this callback.

Definition: AkCallback.h:257

AkGlobalCallbackLocation_Monitor

@ AkGlobalCallbackLocation_Monitor

Send monitor data.

Definition: AkCallback.h:369

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.

Get started with Wwise

Wwise SDK

_ak_callback_8h_source

Was this page helpful?

Need Support?

Tell us about your project. We're here to help.