Table of Contents

include/AK/SoundEngine/Common/AkCallback.h File Reference

Go to the source code of this file.

Classes

struct   AkCallbackInfo
struct   AkEventCallbackInfo
struct   AkMIDIEventCallbackInfo
struct   AkMarkerCallbackInfo
struct   AkDurationCallbackInfo
struct   AkDynamicSequenceItemCallbackInfo
struct   AkSpeakerVolumeMatrixCallbackInfo
struct   AkMusicPlaylistCallbackInfo
struct   AkSegmentInfo
  Structure used to query info on active playing segments. More...
struct   AkMusicSyncCallbackInfo

Namespaces

namespace   AK
 

Audiokinetic namespace.


Typedefs

typedef void(*  AkCallbackFunc )(AkCallbackType in_eType, AkCallbackInfo *in_pCallbackInfo)
typedef void(*  AkBusCallbackFunc )(AkSpeakerVolumeMatrixCallbackInfo *in_pCallbackInfo)
typedef void(*  AkBusMeteringCallbackFunc )(AK::IAkMetering *in_pMetering, AkChannelConfig in_channelConfig, AkMeteringFlags in_eMeteringFlags)
typedef void(*  AkBankCallbackFunc )(AkUInt32 in_bankID, const void *in_pInMemoryBankPtr, AKRESULT in_eLoadResult, AkMemPoolId in_memPoolId, void *in_pCookie)
typedef void(*  AkGlobalCallbackFunc )(AK::IAkGlobalPluginContext *in_pContext, AkGlobalCallbackLocation in_eLocation, void *in_pCookie)
typedef void(*  AK::AkDeviceStatusCallbackFunc )(AK::IAkGlobalPluginContext *in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, AkAudioDeviceEvent in_idEvent, AKRESULT in_AkResult)
  Callback for Audio Device status changes.

Enumerations

enum   AkCallbackType {
  AK_EndOfEvent = 0x0001, AK_EndOfDynamicSequenceItem = 0x0002, AK_Marker = 0x0004, AK_Duration = 0x0008,
  AK_SpeakerVolumeMatrix = 0x0010, AK_Starvation = 0x0020, AK_MusicPlaylistSelect = 0x0040, AK_MusicPlayStarted = 0x0080,
  AK_MusicSyncBeat = 0x0100, AK_MusicSyncBar = 0x0200, AK_MusicSyncEntry = 0x0400, AK_MusicSyncExit = 0x0800,
  AK_MusicSyncGrid = 0x1000, AK_MusicSyncUserCue = 0x2000, AK_MusicSyncPoint = 0x4000, AK_MusicSyncAll = 0x7f00,
  AK_MIDIEvent = 0x10000, AK_CallbackBits = 0xfffff, AK_EnableGetSourcePlayPosition = 0x100000, AK_EnableGetMusicPlayPosition = 0x200000,
  AK_EnableGetSourceStreamBuffering = 0x400000
}
 

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

More...
enum   AkGlobalCallbackLocation {
  AkGlobalCallbackLocation_Register = (1 << 0), AkGlobalCallbackLocation_Begin = (1 << 1), AkGlobalCallbackLocation_PreProcessMessageQueueForRender = (1 << 2), AkGlobalCallbackLocation_PostMessagesProcessed = (1 << 3),
  AkGlobalCallbackLocation_BeginRender = (1 << 4), AkGlobalCallbackLocation_EndRender = (1 << 5), AkGlobalCallbackLocation_End = (1 << 6), AkGlobalCallbackLocation_Term = (1 << 7),
  AkGlobalCallbackLocation_Monitor = (1 << 8), AkGlobalCallbackLocation_MonitorRecap = (1 << 9), AkGlobalCallbackLocation_Num = 10
}
 

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

More...
enum   AK::AkAudioDeviceEvent { AK::AkAudioDeviceEvent_Initialization, AK::AkAudioDeviceEvent_Removal, AK::AkAudioDeviceEvent_SystemRemoval }

Detailed Description

Declaration of callback prototypes

Definition in file AkCallback.h.