Version

    Other Documentation

menu_open

AK Namespace Reference

Audiokinetic namespace. More...

Namespaces

namespace   Comm
namespace   MemoryMgr
namespace   Monitor
namespace   MotionEngine
namespace   MultiCoreServices
namespace   MusicEngine
namespace   SoundEngine
namespace   SoundFrame
 

Audiokinetic Sound Frame namespace.


namespace   SpeakerVolumes
 

Multi-channel volume definitions and services.


namespace   StreamMgr
namespace   ThreadEmulation
namespace   Wwise

Classes

class   IReadBytes
class   IWriteBytes
class   IWriteBuffer
class   AkFXParameterChangeHandler
class   CAkValueRamp
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   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

Typedefs

typedef FNVHash< Hash32 FNVHash32
typedef FNVHash< Hash30 FNVHash30
typedef FNVHash< Hash64 FNVHash64

Enumerations

enum   AkChannelOrdering { ChannelOrdering_Standard, ChannelOrdering_RunTime }
 

Channel ordering type.

More...
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.

More...

Functions

AkForceInline bool  HasLFE (AkChannelMask in_uChannelMask)
AkForceInline bool  HasCenter (AkChannelMask in_uChannelMask)
AkForceInline AkUInt32  GetNumberOfAnglesForConfig (AkChannelMask in_uChannelMask)
static unsigned int  ChannelMaskToNumChannels (AkChannelMask in_uChannelMask)
  Returns the number of channels of a given channel configuration.
static AkChannelMask  ChannelMaskFromNumChannels (unsigned int in_uNumChannels)
AkForceInline bool  HasSurroundChannels (AkChannelMask in_uChannelMask)
AkForceInline bool  HasStrictlyOnePairOfSurroundChannels (AkChannelMask in_uChannelMask)
AkForceInline bool  HasSideAndRearChannels (AkChannelMask in_uChannelMask)
AkForceInline AkChannelMask  BackToSideChannels (AkChannelMask in_uChannelMask)
static unsigned int  ChannelIndexToDisplayIndex (AkChannelOrdering in_eOrdering, unsigned int in_uChannelMask, unsigned int in_uChannelIdx)
void *__cdecl  AllocHook (size_t in_size)
void __cdecl  FreeHook (void *in_pMemAddress)
static AkForceInline AkInt16  AK_FLOAT_TO_SAMPLETYPE (AkReal32 in_fIn)
  This function can be useful to convert from normalized floating point audio samples to Wii-pipeline format samples.
static AkForceInline AkInt16  AK_FLOAT_TO_SAMPLETYPE_NOCLIP (AkReal32 in_fIn)
  This function can be useful to convert from normalized floating point audio samples to Wii-pipeline format samples when the input is not not to exceed (-1,1) range.
static AkForceInline AkReal32  AK_SAMPLETYPE_TO_FLOAT (AkInt16 in_iIn)
  This function can be useful to convert from Wii-pipeline format samples to normalized floating point audio samples.
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)

Variables

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


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