Version

menu_open

include/AK/SpatialAudio/Common/AkSpatialAudio.h File Reference

Go to the source code of this file.

Classes

struct   AkSpatialAudioInitSettings
  Initialization settings of the spatial audio module. More...
struct   AkEmitterSettings
  Settings for a sound emitter. More...
struct   AkTriangle
  Structure for describing information about individual triangles. More...
struct   AkSoundPathInfo
  Structure for retrieving information about the indirect paths of a sound that have been calculated via the geometric reflections API. More...
struct   AkPortalParams
  Parameters passed to AddPortal. More...
struct   AkRoomParams
  Parameters passed to AddRoom. More...

Namespaces

namespace   AK
 

Audiokinetic namespace.


namespace   AK::SpatialAudio
 

Audiokinetic spatial audio namespace.


Functions

AkMemPoolId __cdecl  AK::SpatialAudio::GetPoolID ()
  Access the internal pool ID passed to Init.
AKRESULT __cdecl  AK::SpatialAudio::Init (const AkSpatialAudioInitSettings &in_initSettings)
  Initialize the SpatialAudio API.
void __cdecl  AK::SpatialAudio::Term ()
  Terminate the SpatialAudio API.
AKRESULT __cdecl  AK::SpatialAudio::RegisterEmitter (AkGameObjectID in_gameObjectID, const AkEmitterSettings &in_roomSettings)
AKRESULT __cdecl  AK::SpatialAudio::UnregisterEmitter (AkGameObjectID in_gameObjectID)
AKRESULT __cdecl  AK::SpatialAudio::AddImageSource (const AkReflectImageSource &in_info, AkUniqueID in_AuxBusID, AkRoomID in_roomID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT, const String &in_name="")
AKRESULT __cdecl  AK::SpatialAudio::RemoveImageSource (AkImageSourceID in_srcID, AkUniqueID in_AuxBusID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
AKRESULT __cdecl  AK::SpatialAudio::SetEmitterAuxSendValues (AkGameObjectID in_gameObjectID, AkAuxSendValue *in_pAuxSends, AkUInt32 in_uNumAux)
AKRESULT __cdecl  AK::SpatialAudio::SetGameObjectInRoom (AkGameObjectID in_gameObjectID, AkRoomID in_CurrentRoomID)
AKRESULT __cdecl  AK::SpatialAudio::SetEmitterPosition (AkGameObjectID in_gameObjectID, const AkTransform &in_sourcePosition, const AkTransform *in_virtualPositions=NULL, AkUInt16 in_uNumVirtualPositions=0)
AKRESULT __cdecl  AK::SpatialAudio::AddGeometrySet (AkGeometrySetID in_GeomSetID, AkTriangle *in_pTriangles, AkUInt32 in_uNumTriangles)
AKRESULT __cdecl  AK::SpatialAudio::RemoveGeometrySet (AkGeometrySetID in_SetID)
AKRESULT __cdecl  AK::SpatialAudio::AddRoom (AkRoomID in_RoomID, const AkRoomParams &in_Params)
AKRESULT __cdecl  AK::SpatialAudio::RemoveRoom (AkRoomID in_RoomID)
AKRESULT __cdecl  AK::SpatialAudio::AddPortal (AkPortalID in_PortalID, const AkPortalParams &in_Params)
AKRESULT __cdecl  AK::SpatialAudio::RemovePortal (AkPortalID in_PortalID)
AKRESULT __cdecl  AK::SpatialAudio::QueryIndirectPaths (AkGameObjectID in_gameObjectID, AkVector &out_listenerPos, AkVector &out_emitterPos, AkSoundPathInfo *out_aPaths, AkUInt32 &io_uArraySize)
bool __cdecl  AK::SpatialAudio::CalcOcclusionAndVirtualPositions (const AkVector &in_EmitterPos, AkRoomID in_EmitterRoomID, const AkVector &in_ListenerPos, AkRoomID in_listenerRoomID, AkReal32 &out_fOcclusionFactor, AkReal32 &out_fObstructionFactor, AkTransform *io_aVirtualPositions, AkUInt32 &io_uArraySize)

Detailed Description

Spatial Audio interface.

Definition in file AkSpatialAudio.h.


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