Table of Contents

Wwise SDK 2019.2.1
AK::SpatialAudio Namespace Reference

Audiokinetic spatial audio namespace. More...


typedef AkString< ArrayPoolSpatialAudio, wchar_t >  WString
  Wide string type for use in Wwise Spatial Audio. More...
typedef AkString< ArrayPoolSpatialAudio, AkOSChar >  OsString
  OS string type for use in Wwise Spatial Audio. More...
typedef AkString< ArrayPoolSpatialAudio, char >  String
  String type for use in Wwise Spatial Audio. More...
typedef AkDbString< ArrayPoolSpatialAudio, char, CAkLock DbString
  Instanced string type. More...
typedef AkUInt16  Idx


Basic functions.

In order to use SpatialAudio, you need to initalize it using Init, and register the listeners that you plan on using with any of the services offered by SpatialAudio, using RegisterListener respectively, after having registered their corresponding game object to the sound engine.

Warning: At the moment, there can be only one Spatial Audio listener registered at any given time.
AKRESULT __cdecl  Init (const AkSpatialAudioInitSettings &in_initSettings)
  Initialize the SpatialAudio API. More...
AKRESULT __cdecl  RegisterListener (AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  UnregisterListener (AkGameObjectID in_gameObjectID)
Helper functions for passing game data to the Wwise Reflect plug-in.

Use this API for detailed placement of reflection image sources.

Note: These functions are low-level and useful when your game engine already implements a geometrical approach to sound propagation such as an image-source or a ray tracing algorithm. Functions of Geometry are preferred and easier to use with the Wwise Reflect plug-in.
AKRESULT __cdecl  SetImageSource (AkImageSourceID in_srcID, const AkImageSourceSettings &in_info, AkUniqueID in_AuxBusID, AkRoomID in_roomID, AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  RemoveImageSource (AkImageSourceID in_srcID, AkUniqueID in_AuxBusID, AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  ClearImageSources (AkUniqueID in_AuxBusID=AK_INVALID_AUX_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)

Geometry API for early reflection processing using Wwise Reflect.

AKRESULT __cdecl  SetGeometry (AkGeometrySetID in_GeomSetID, const AkGeometryParams &in_params)
AKRESULT __cdecl  RemoveGeometry (AkGeometrySetID in_SetID)
AKRESULT __cdecl  QueryReflectionPaths (AkGameObjectID in_gameObjectID, AkVector &out_listenerPos, AkVector &out_emitterPos, AkReflectionPathInfo *out_aPaths, AkUInt32 &io_uArraySize)
Rooms and Portals

Sound Propagation API using rooms and portals.

AKRESULT __cdecl  SetRoom (AkRoomID in_RoomID, const AkRoomParams &in_Params)
AKRESULT __cdecl  RemoveRoom (AkRoomID in_RoomID)
AKRESULT __cdecl  SetPortal (AkPortalID in_PortalID, const AkPortalParams &in_Params)
AKRESULT __cdecl  RemovePortal (AkPortalID in_PortalID)
AKRESULT __cdecl  SetGameObjectInRoom (AkGameObjectID in_gameObjectID, AkRoomID in_CurrentRoomID)
AKRESULT __cdecl  SetReflectionsOrder (AkUInt32 in_uReflectionsOrder, bool in_bUpdatePaths)
AKRESULT __cdecl  SetNumberOfPrimaryRays (AkUInt32 in_uNbPrimaryRays)
AKRESULT __cdecl  SetEarlyReflectionsAuxSend (AkGameObjectID in_gameObjectID, AkAuxBusID in_auxBusID)
AKRESULT __cdecl  SetEarlyReflectionsVolume (AkGameObjectID in_gameObjectID, AkReal32 in_fSendVolume)
AKRESULT __cdecl  SetPortalObstructionAndOcclusion (AkPortalID in_PortalID, AkReal32 in_fObstruction, AkReal32 in_fOcclusion)
AKRESULT __cdecl  QueryWetDiffraction (AkPortalID in_portal, AkReal32 &out_wetDiffraction)
AKRESULT __cdecl  QueryDiffractionPaths (AkGameObjectID in_gameObjectID, AkVector &out_listenerPos, AkVector &out_emitterPos, AkDiffractionPathInfo *out_aPaths, AkUInt32 &io_uArraySize)

Detailed Description

Audiokinetic spatial audio namespace.