AkSpatialAudioTypes.h

Wwise SDK 2025.1.0

#include <AK/SoundEngine/Common/AkTypes.h>
#include <AK/Tools/Common/AkString.h>

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

struct	AkRoomID

struct	AkVertex

struct	AkImageSourceName
	Data used to describe one image source in Reflect. More...

struct	AkSpatialAudioInitSettings
	Initialization settings of the spatial audio module. More...

struct	AkImageSourceParams

struct	AkImageSourceTexture

struct	AkImageSourceSettings
	Settings for individual image sources. More...

struct	AkExtent

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...

struct	AkGeometryInstanceParams
	Parameters passed to `SetGeometryInstance`. More...

Namespaces
namespace	AK
	Definition of data structures for AkAudioObject.

	AK::SpatialAudio
	Audiokinetic spatial audio namespace.

Macros
#define	AK_MAX_NUM_TEXTURE 4

#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_SA_ID ((AkUInt64)-1)

#define	AK_OUTDOORS_ROOM_ID AK_INVALID_SA_ID

#define	AK_DEFAULT_GEOMETRY_POSITION_X (0.0)

#define	AK_DEFAULT_GEOMETRY_POSITION_Y (0.0)

#define	AK_DEFAULT_GEOMETRY_POSITION_Z (0.0)

#define	AK_DEFAULT_GEOMETRY_FRONT_X (0.0)

#define	AK_DEFAULT_GEOMETRY_FRONT_Y (0.0)

#define	AK_DEFAULT_GEOMETRY_FRONT_Z (1.0)

#define	AK_DEFAULT_GEOMETRY_TOP_X (0.0)

#define	AK_DEFAULT_GEOMETRY_TOP_Y (1.0)

#define	AK_DEFAULT_GEOMETRY_TOP_Z (0.0)

Enumerations
enum	AkTransmissionOperation { AkTransmissionOperation_Add, AkTransmissionOperation_Multiply, AkTransmissionOperation_Max, AkTransmissionOperation_Default = AkTransmissionOperation_Max }

enum	AkRoomDistanceBehavior { AkRoomDistanceBehavior_Subtract, AkRoomDistanceBehavior_Exclude, AkRoomDistanceBehavior_Default = AkRoomDistanceBehavior_Subtract }
	Determines how a room interacts with the distance calculation of other rooms that it overlaps or is nested within. More...

Variables
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