AkSpatialAudioTypes.h

Wwise SDK 2024.1.10

#include AK/Tools/Common/AkString.h>
#include AK/Tools/Common/AkLock.h>
#include AK/Tools/Common/AkSet.h>

Classes
struct	AkSpatialAudioID
	Base type for ID's used by Wwise spatial audio. More...

struct	AkRoomID

struct	AkRoomHierarchyID

Namespaces
namespace	AK
	Definition of data structures for AkAudioObject.

	AK::SpatialAudio
	Audiokinetic spatial audio namespace.

Macros
#define	AK_MAX_REFLECT_ORDER 4

#define	AK_MAX_REFLECTION_PATH_LENGTH (AK_MAX_REFLECT_ORDER + 4)

#define	AK_STOCHASTIC_RESERVE_LENGTH AK_MAX_REFLECTION_PATH_LENGTH

#define	AK_MAX_SOUND_PROPAGATION_DEPTH 8

#define	AK_MAX_SOUND_PROPAGATION_WIDTH 32

#define	AK_SA_EPSILON (0.001f)

#define	AK_SA_DIFFRACTION_EPSILON (0.01f)

#define	AK_SA_DIFFRACTION_DOT_EPSILON (0.00005f)

#define	AK_SA_PLANE_THICKNESS (0.01f)

#define	AK_SA_MIN_ENVIRONMENT_ABSORPTION (0.01f)

#define	AK_SA_MIN_ENVIRONMENT_SURFACE_AREA (1.0f)

#define	AK_INVALID_VERTEX ((AkVertIdx)(-1))

#define	AK_INVALID_TRIANGLE ((AkTriIdx)(-1))

#define	AK_INVALID_SURFACE ((AkSurfIdx)(-1))

#define	AK_INVALID_EDGE ((AkEdgeIdx)(-1))

Typedefs
typedef AkArrayAllocatorNoAlignAkMemID_SpatialAudio >	ArrayPoolSpatialAudio

typedef AkArrayAllocatorAlignedSimdAkMemID_SpatialAudio >	ArrayPoolSpatialAudioSIMD

typedef AkArrayAllocatorNoAlignAkMemID_SpatialAudioPaths >	ArrayPoolSpatialAudioPaths

typedef AkArrayAllocatorAlignedSimdAkMemID_SpatialAudioPaths >	ArrayPoolSpatialAudioPathsSIMD

typedef AkArrayAllocatorNoAlignAkMemID_SpatialAudioGeometry >	ArrayPoolSpatialAudioGeometry

typedef AkArrayAllocatorAlignedSimdAkMemID_SpatialAudioGeometry >	ArrayPoolSpatialAudioGeometrySIMD

typedef AkStringArrayPoolSpatialAudio, wchar_t >	AK::SpatialAudio::WString
	Wide string type for use in Wwise Spatial Audio. More...

typedef AkStringArrayPoolSpatialAudio, AkOSChar >	AK::SpatialAudio::OsString
	OS string type for use in Wwise Spatial Audio. More...

typedef AkStringArrayPoolSpatialAudio, char >	AK::SpatialAudio::String
	String type for use in Wwise Spatial Audio. More...

typedef AkDbStringArrayPoolSpatialAudio, char >	AK::SpatialAudio::DbString
	Instanced string type. More...

typedef AkDbWeakStringArrayPoolSpatialAudio, char >	AK::SpatialAudio::DbWeakString
	Weak reference to DbString. Multi-thread reading is safe. More...

typedef AkUInt16	AK::SpatialAudio::Idx

typedef AkUInt16	AkVertIdx

typedef AkUInt16	AkTriIdx

typedef AkUInt16	AkSurfIdx

typedef AkUInt16	AkEdgeIdx

typedef AkUInt16	AkEdgeReceptorIdx

typedef AkSetAkRoomID, ArrayPoolSpatialAudio >	AkRoomIDSet

typedef AkSpatialAudioID	AkPortalID

typedef AkSpatialAudioID	AkGeometrySetID

typedef AkSpatialAudioID	AkGeometryInstanceID

Variables
const AkUInt32	kDefaultDiffractionMaxEdges = 8

const AkUInt32	kDefaultDiffractionMaxPaths = 8

const AkUInt32	kHashListBlockAllocItemCount = 50

const AkUInt32	kRayPoolBlockAllocItemCount = 35

const AkUInt32	kDiffractionMaxEdges = 8

const AkUInt32	kDiffractionMaxPaths = 8

const AkUInt32	kPortalToPortalDiffractionMaxPaths = 8

constexpr AkRoomID	AK::SpatialAudio::kOutdoorRoomID
	The outdoor room ID. This room is created automatically and is typically used for outdoors, i.e. when not in a room. More...

Detailed Description

Spatial audio data type definitions.

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Get started with Wwise