|
Wwise SDK 2019.1.11
|
Audiokinetic namespace. More...
Namespaces | |
| Comm | |
| MemoryMgr | |
| Monitor | |
| MusicEngine | |
| SoundEngine | |
| SpatialAudio | |
| Audiokinetic spatial audio namespace. |
|
| SpeakerVolumes | |
| Multi-channel volume definitions and services. |
|
| StreamMgr | |
| namespace | Wwise |
Classes | |
| class | AkFXParameterChangeHandler |
| class | CAkValueRamp |
| class | FNVHash |
| struct | Hash30 |
| struct | Hash32 |
| struct | Hash64 |
| class | IAkAndroidContext |
| Context specific to the Android port of Wwise SDK. More... |
|
| class | IAkAutoStream |
| class | IAkDeviceProfile |
| class | IAkEffectPlugin |
| Software effect plug-in interface (see How to Create Wwise Sound Engine Effect Plug-ins). More... |
|
| class | IAkEffectPluginContext |
| class | IAkGameObjectPluginInfo |
| Game object information available to plugins. More... |
|
| class | IAkGGPContext |
| Context specific to the Linux port of Wwise SDK. More... |
|
| class | IAkGlobalPluginContext |
| Global plugin context used for plugin registration/initialization. Games query this interface from the sound engine. More... |
|
| class | IAkInPlaceEffectPlugin |
| Software effect plug-in interface for in-place processing (see How to Create Wwise Sound Engine Effect Plug-ins). More... |
|
| class | IAkiOSContext |
| Context specific to the iOS port of Wwise SDK. More... |
|
| class | IAkLinuxContext |
| Context specific to the Linux port of Wwise SDK. More... |
|
| class | IAkLuminContext |
| Context specific to the Lumin port of Wwise SDK. More... |
|
| class | IAkMacContext |
| Context specific to the macOS port of Wwise SDK. More... |
|
| 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 | IAkMixerInputContext |
| Interface to retrieve information about an input of a mixer. More... |
|
| class | IAkMixerPluginContext |
| Interface to retrieve contextual information for a mixer. 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 | IAkPlatformContext |
| class | IAkPlugin |
| class | IAkPluginContextBase |
| Interface to retrieve contextual information available to all types of plugins. More... |
|
| class | IAkPluginMemAlloc |
| class | IAkPluginParam |
| class | IAkProcessorFeatures |
| class | IAkPS4Context |
| Context specific to the PS4 port of Wwise SDK. More... |
|
| class | IAkRTPCSubscriber |
| class | IAkSinkPlugin |
| Software effect plug-in interface for sink (audio end point) plugins. More... |
|
| class | IAkSinkPluginContext |
| class | IAkSourcePlugin |
|
Wwise sound engine source plug-in interface (see How to Create Wwise Sound Engine Source Plug-ins). More... |
|
| class | IAkSourcePluginContext |
| class | IAkStdStream |
| class | IAkStreamMgr |
| class | IAkStreamMgrProfile |
| class | IAkStreamProfile |
| class | IAkSwitchContext |
| Context specific to the NX port of Wwise SDK. More... |
|
| class | IAkUWPContext |
| Context specific to the UWP port of Wwise SDK. More... |
|
| class | IAkVoicePluginInfo |
| class | IAkWin32Context |
| Context specific to the Win32 port of Wwise SDK. More... |
|
| class | IAkXboxOneContext |
| Context specific to the Xbox One port of Wwise SDK. More... |
|
| class | IReadBytes |
| class | IWriteBuffer |
| class | IWriteBytes |
| class | PluginRegistration |
| class | ReadBytesMem |
| class | ReadBytesSkip |
| class | WriteBytesCount |
| class | WriteBytesMem |
Typedefs | |
| 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. More... |
|
| typedef FNVHash< Hash32 > | FNVHash32 |
| typedef FNVHash< Hash30 > | FNVHash30 |
| typedef FNVHash< Hash64 > | FNVHash64 |
Enumerations | |
| enum | AkAudioDeviceEvent { AkAudioDeviceEvent_Initialization, AkAudioDeviceEvent_Removal, AkAudioDeviceEvent_SystemRemoval } |
| 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 | |
| static AkUInt8 | ChannelMaskToNumChannels (AkChannelMask in_uChannelMask) |
| Returns the number of channels of a given channel configuration. More... |
|
| 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). More... |
|
| AkForceInline AkChannelMask | BackToSideChannels (AkChannelMask in_uChannelMask) |
| static unsigned int | StdChannelIndexToDisplayIndex (AkChannelOrdering in_eOrdering, unsigned int in_uChannelMask, unsigned int in_uChannelIdx) |
| void * | AllocHook (size_t in_size) |
| void | FreeHook (void *in_pMemAddress) |
| template<typename T > | |
| T | ReadUnaligned (const AkUInt8 *in_pVal) |
| template<typename T > | |
| void | WriteUnaligned (AkUInt8 *out_pVal, const T in_val) |
| template<typename T > | |
| T | ReadBankData (AkUInt8 *&in_rptr) |
| Read data from bank and advance pointer. More... |
|
| template<typename T > | |
| T | ReadVariableSizeBankData (AkUInt8 *&in_rptr) |
| char * | ReadBankStringUtf8 (AkUInt8 *&in_rptr, AkUInt32 &out_uStringSize) |
| AkForceInline AkUInt32 | GetNumNonZeroBits (AkUInt32 in_uWord) |
| int | GetPS4OutputHandle (AkOutputDeviceID deviceId=0) |
| AKSOUNDENGINE_API IUnknown * | GetWwiseXAudio2Interface () |
| AKSOUNDENGINE_API IDirectSound8 * | GetDirectSoundInstance () |
| AKSOUNDENGINE_API AkUInt32 | GetDeviceID (IMMDevice *in_pDevice) |
| AKSOUNDENGINE_API AkUInt32 | GetDeviceIDFromName (wchar_t *in_szToken) |
| AKSOUNDENGINE_API const wchar_t * | GetWindowsDeviceName (AkInt32 index, AkUInt32 &out_uDeviceID, AkAudioDeviceState uDeviceStateMask=AkDeviceState_All) |
| AKSOUNDENGINE_API AkUInt32 | GetWindowsDeviceCount (AkAudioDeviceState uDeviceStateMask=AkDeviceState_All) |
| AKSOUNDENGINE_API bool | GetWindowsDevice (AkInt32 in_index, AkUInt32 &out_uDeviceID, IMMDevice **out_ppDevice, AkAudioDeviceState uDeviceStateMask=AkDeviceState_All) |
| AKSOUNDENGINE_API AkDeviceID | GetDeviceIDFromGamepad (Windows::Gaming::Input::Gamepad^ rGamepad) |
Variables | |
| class AK::CAkValueRamp | AK_ALIGN_DMA |
| AkReal32 | g_fFreqRatio |
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: https://en.wikipedia.org/wiki/Ambisonic_data_exchange_formats). 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 |
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise