Wwise SDK 2019.2.14
AkSpatialAudio.h File Reference

Go to the source code of this file.


struct   AkGrowByPolicy_Legacy_SpatialAudio< TSize >
struct   AkSpatialAudioInitSettings
  Initialization settings of the spatial audio module. More...
struct   AkImageSourceSettings
struct   AkVertex
  Vertex for a spatial audio mesh. More...
struct   AkTriangle
  Triangle for a spatial audio mesh. More...
struct   AkAcousticSurface
struct   AkReflectionPathInfo
  Structure for retrieving information about the indirect paths of a sound that have been calculated via the geometric reflections API. Useful for debug draw applications. More...
struct   AkDiffractionPathInfo
struct   AkPortalParams
  Parameters passed to SetPortal. More...
struct   AkRoomParams
  Parameters passed to SetRoom. More...
struct   AkGeometryParams
  Parameters passed to SetGeometry. More...


namespace   AK
  Audiokinetic namespace.
  Audiokinetic spatial audio namespace.


enum   AkDiffractionFlags { DiffractionFlags_UseBuiltInParam = 1 << 0, DiffractionFlags_UseObstruction = 1 << 1, DiffractionFlags_CalcEmitterVirtualPosition = 1 << 3, DefaultDiffractionFlags = DiffractionFlags_UseBuiltInParam | DiffractionFlags_UseObstruction | DiffractionFlags_CalcEmitterVirtualPosition }
  AkDiffractionFlags determine if diffraction values for sound passing through portals will be calculated, and how to apply those calculations to Wwise parameters. More...


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.
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::Init (const AkSpatialAudioInitSettings &in_initSettings)
  Initialize the SpatialAudio API.
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::RegisterListener (AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::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.
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::SetImageSource (AkImageSourceID in_srcID, const AkImageSourceSettings &in_info, AkUniqueID in_AuxBusID, AkRoomID in_roomID, AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::RemoveImageSource (AkImageSourceID in_srcID, AkUniqueID in_AuxBusID, AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::ClearImageSources (AkUniqueID in_AuxBusID=AK_INVALID_AUX_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)

Geometry API for early reflection processing using Wwise Reflect.

AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::SetGeometry (AkGeometrySetID in_GeomSetID, const AkGeometryParams &in_params)
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::RemoveGeometry (AkGeometrySetID in_SetID)
AKSOUNDENGINE_API AKRESULT  AK::SpatialAudio::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.

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

Detailed Description

Spatial Audio interface.

Definition in file AkSpatialAudio.h.