AkSpatialAudioTypes.h

Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.

Wwise SDK 2023.1.8

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

Go to the source code of this file.

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

struct	AkRoomID

struct	AkRoomHierarchyID

Namespaces
namespace	AK
	Audiokinetic namespace.

	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 8

#define	AK_SA_EPSILON (0.001f)

#define	AK_SA_DIFFRACTION_EPSILON (0.002f)

#define	AK_SA_DIFFRACTION_DOT_EPSILON (0.000002)

#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 AkArrayAllocatorNoAlign< AkMemID_SpatialAudio >	ArrayPoolSpatialAudio

typedef AkArrayAllocatorAlignedSimd< AkMemID_SpatialAudio >	ArrayPoolSpatialAudioSIMD

typedef AkArrayAllocatorNoAlign< AkMemID_SpatialAudioPaths >	ArrayPoolSpatialAudioPaths

typedef AkArrayAllocatorAlignedSimd< AkMemID_SpatialAudioPaths >	ArrayPoolSpatialAudioPathsSIMD

typedef AkArrayAllocatorNoAlign< AkMemID_SpatialAudioGeometry >	ArrayPoolSpatialAudioGeometry

typedef AkArrayAllocatorAlignedSimd< AkMemID_SpatialAudioGeometry >	ArrayPoolSpatialAudioGeometrySIMD

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

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

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

typedef AkDbString< ArrayPoolSpatialAudio, char, CAkLock >	AK::SpatialAudio::DbString
	Instanced string type. More...

typedef AkUInt16	AK::SpatialAudio::Idx

typedef AkUInt16	AkVertIdx

typedef AkUInt16	AkTriIdx

typedef AkUInt16	AkSurfIdx

typedef AkUInt16	AkEdgeIdx

typedef AkUInt16	AkEdgeReceptorIdx

typedef AkSet< AkRoomID, ArrayPoolSpatialAudio >	AkRoomIDSet

typedef AkSpatialAudioID	AkPortalID

typedef AkSpatialAudioID	AkGeometrySetID

typedef AkSpatialAudioID	AkGeometryInstanceID

Variables
const AkUInt32	kDefaultDiffractionMaxEdges = 8

const AkUInt32	kDefaultDiffractionMaxPaths = 8

const AkReal32	kMaxDiffraction = 1.0f

const AkUInt32	kHashListBlockAllocItemCount = 50

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.

Definition in file AkSpatialAudioTypes.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.

Get started with Wwise

Wwise SDK