Table of Contents

AK Namespace Reference

Audiokinetic namespace. More...


namespace   Comm
namespace   MemoryMgr
namespace   Monitor
namespace   MusicEngine
namespace   SoundEngine
namespace   SpatialAudio

Audiokinetic spatial audio namespace.

namespace   SpeakerVolumes

Multi-channel volume definitions and services.

namespace   StreamMgr
namespace   Wwise


class   IReadBytes
class   IWriteBytes
class   IWriteBuffer
class   AkFXParameterChangeHandler
class   CAkValueRamp
class   ReadBytesMem
class   WriteBytesMem
class   IAkMetering
  Interface to retrieve metering information about a buffer. More...
class   IAkMixerEffectPlugin
  Software effect plug-in interface for panner/mixer effects (see How to Create Wwise Sound Engine Effect Plug-ins). More...
class   IAkGameObjectPluginInfo
  Game object information available to plugins. More...
class   IAkVoicePluginInfo
class   IAkPluginContextBase
  Interface to retrieve contextual information available to all types of plugins. More...
class   IAkEffectPluginContext
class   IAkSourcePluginContext
class   IAkMixerPluginContext
  Interface to retrieve contextual information for a mixer. More...
class   IAkPluginParam
class   IAkPlugin
class   IAkEffectPlugin
  Software effect plug-in interface (see How to Create Wwise Sound Engine Effect Plug-ins). More...
class   IAkInPlaceEffectPlugin
  Software effect plug-in interface for in-place processing (see How to Create Wwise Sound Engine Effect Plug-ins). More...
class   IAkOutOfPlaceEffectPlugin
  Software effect plug-in interface for out-of-place processing (see How to Create Wwise Sound Engine Effect Plug-ins). More...
class   IAkMixerInputContext
  Interface to retrieve information about an input of a mixer. More...
class   IAkSinkPluginContext
class   IAkSinkPlugin
  Software effect plug-in interface for sink (audio end point) plugins. More...
class   IAkSourcePlugin
  Wwise sound engine source plug-in interface (see How to Create Wwise Sound Engine Source Plug-ins). More...
class   IAkGlobalPluginContext
  Global plugin context used for plugin registration/initialization. Games query this interface from the sound engine. More...
class   PluginRegistration
class   IAkPluginMemAlloc
class   IAkProcessorFeatures
class   IAkRTPCSubscriber
class   IAkStreamProfile
class   IAkDeviceProfile
class   IAkStreamMgrProfile
class   IAkStdStream
class   IAkAutoStream
class   IAkStreamMgr
struct   Hash32
struct   Hash30
struct   Hash64
class   FNVHash


typedef void(*  AkDeviceStatusCallbackFunc )(AK::IAkGlobalPluginContext *in_pContext, AkUniqueID in_idAudioDeviceShareset, AkUInt32 in_idDeviceID, AkAudioDeviceEvent in_idEvent, AKRESULT in_AkResult)
  Callback for Audio Device status changes.
typedef FNVHash< Hash32 FNVHash32
typedef FNVHash< Hash30 FNVHash30
typedef FNVHash< Hash64 FNVHash64


enum   AkAudioDeviceEvent { AkAudioDeviceEvent_Initialization, AkAudioDeviceEvent_Removal, AkAudioDeviceEvent_SystemRemoval }
enum   AkChannelOrdering { ChannelOrdering_Standard, ChannelOrdering_RunTime }

Channel ordering type.

enum   AkSIMDProcessorSupport { AK_SIMD_SSE = 1<<0, AK_SIMD_SSE2 = 1<<1, AK_SIMD_SSE3 = 1<<2, AK_SIMD_SSSE3 = 1<<3 }

SIMD instruction sets.



static AkUInt8  ChannelMaskToNumChannels (AkChannelMask in_uChannelMask)
  Returns the number of channels of a given channel configuration.
static AkChannelMask  ChannelMaskFromNumChannels (unsigned int in_uNumChannels)
static AkUInt8  ChannelBitToIndex (AkChannelMask in_uChannelBit, AkChannelMask in_uChannelMask)
AkForceInline bool  HasLFE (AkChannelMask in_uChannelMask)
AkForceInline bool  HasCenter (AkChannelMask in_uChannelMask)
AkForceInline AkUInt32  GetNumberOfAnglesForConfig (AkChannelMask in_uChannelMask)
AkForceInline bool  HasSurroundChannels (AkChannelMask in_uChannelMask)
AkForceInline bool  HasStrictlyOnePairOfSurroundChannels (AkChannelMask in_uChannelMask)
AkForceInline bool  HasSideAndRearChannels (AkChannelMask in_uChannelMask)
AkForceInline bool  HasHeightChannels (AkChannelMask in_uChannelMask)
  Returns true if standard configuration represented by channel mask has at least one "height" channel (above the plane).
AkForceInline AkChannelMask  BackToSideChannels (AkChannelMask in_uChannelMask)
static unsigned int  StdChannelIndexToDisplayIndex (AkChannelOrdering in_eOrdering, unsigned int in_uChannelMask, unsigned int in_uChannelIdx)
void *__cdecl  AllocHook (size_t in_size)
void __cdecl  FreeHook (void *in_pMemAddress)
AkForceInline AkUInt32  GetNumNonZeroBits (AkUInt32 in_uWord)
int  GetPS4OutputHandle ()
IUnknown *__cdecl  GetWwiseXAudio2Interface ()
IDirectSound8 *__cdecl  GetDirectSoundInstance ()
AkUInt32 __cdecl  GetDeviceID (IMMDevice *in_pDevice)
AkUInt32 __cdecl  GetDeviceIDFromName (wchar_t *in_szToken)
const wchar_t *__cdecl  GetWindowsDeviceName (AkInt32 index, AkUInt32 &out_uDeviceID, AkAudioDeviceState uDeviceStateMask=AkDeviceState_All)


class AK::CAkValueRamp  AK_ALIGN_DMA
AkReal32  g_fFreqRatio

Detailed Description

Audiokinetic namespace.

Dummy assert hook definition.

Utility functions.

Can be used to track individual parameter changes to avoid costly computations when they remain constant This class is designed to use only the lower bit information of the parameter IDs

Ambisonics configurations (corresponding to AkChannelConfig::eConfigType == AK_ChannelConfigType_Ambisonic). Convention: X points towards the front, and XYZ follow a right-hand rule, so Y is the side vector (pointing to the left). Channel presence and ordering are predefined according to the number of channels. The ordering convention is ACN, with the mapping of components to number of channels detailed below (source: Normalization natively used in Wwise is SN3D.

Number of channels Order Description Layout of components
Horizontal Vertical
1     0     0       mono  
4     1     1       first-order full sphere   WYZX
9     2     2       second-order full sphere   WYZXVTRSU
16     3     3       third-order full sphere   WYZXVTRSUQOMKLNP