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.
AkGeometrySetID GeometryInstanceID
bool RoomGameObj_KeepRegistered
AKSOUNDENGINE_API AKRESULT QueryWetDiffraction(AkPortalID in_portal, AkReal32 &out_wetDiffraction)
AKSOUNDENGINE_API AKRESULT UnregisterListener(AkGameObjectID in_gameObjectID)
Triangle for a spatial audio mesh.
AkUInt32 numPathPoints
Number of valid elements in the pathPoint[], surfaces[], and diffraction[] arrays.
AkVertex(AkReal32 in_X, AkReal32 in_Y, AkReal32 in_Z)
Constructor.
AkImageSourceParams params
Image source parameters.
Parameters passed to SetPortal.
AkReal32 TransmissionLoss
AKSOUNDENGINE_API AKRESULT RemovePortal(AkPortalID in_PortalID)
AkTriIdx NumTriangles
Number of triangles in Triangles.
bool bEnableGeometricDiffractionAndTransmission
AkReal32 transmissionLoss
AkVertIdx point2
Index into the vertex table passed into AkGeometryParams that describes the third vertex of the trian...
AkReal32 RoomGameObj_AuxSendLevelToSelf
AKSOUNDENGINE_API AKRESULT SetGameObjectInRoom(AkGameObjectID in_gameObjectID, AkRoomID in_CurrentRoomID)
AkAcousticSurface()
Constructor.
AKSOUNDENGINE_API AKRESULT SetMaxEmitterRoomAuxSends(AkUInt32 in_uMaxEmitterRoomAuxSends)
AkTriangle(AkVertIdx in_pt0, AkVertIdx in_pt1, AkVertIdx in_pt2, AkSurfIdx in_surfaceInfo)
Constructor.
AKSOUNDENGINE_API AKRESULT Init(const AkSpatialAudioInitSettings &in_initSettings)
Initialize the SpatialAudio API.
#define AK_DEFAULT_GEOMETRY_POSITION_Z
AkSpatialAudioInitSettings()
AkPortalParams()
Constructor.
AKSOUNDENGINE_API AKRESULT SetReverbZone(AkRoomID in_ReverbZone, AkRoomID in_ParentRoom, AkReal32 in_transitionRegionWidth)
#define AK_DEFAULT_GEOMETRY_FRONT_Y
#define AK_INVALID_VERTEX
AkUInt32 uLoadBalancingSpread
Spread the computation of paths on uLoadBalancingSpread frames [1..[. When uLoadBalancingSpread is se...
AKSOUNDENGINE_API AKRESULT QueryDiffractionPaths(AkGameObjectID in_gameObjectID, AkUInt32 in_positionIndex, AkVector64 &out_listenerPos, AkVector64 &out_emitterPos, AkDiffractionPathInfo *out_aPaths, AkUInt32 &io_uArraySize)
AkRoomParams()
Constructor.
AkUInt32 nodeCount
Total number of nodes in the path. Defines the number of valid entries in the nodes,...
AkUInt64 AkGameObjectID
Game object ID.
#define AK_EXTERNAPIFUNC(_type, _name)
AKSOUNDENGINE_API AKRESULT SetEarlyReflectionsAuxSend(AkGameObjectID in_gameObjectID, AkAuxBusID in_auxBusID)
AkUInt32 uNumTexture
Number of valid textures in the texture array.
AKRESULT
Standard function call result.
const char * strName
Name to describe this surface.
AkUInt32 uDiffractionOnReflectionsOrder
AkVector64 nodes[kMaxNodes]
AkAcousticSurface surfaces[AK_MAX_REFLECTION_PATH_LENGTH]
AkWorldTransform Transform
AkUInt32 AkImageSourceID
Image Source ID.
AkVector64 pathPoint[AK_MAX_REFLECTION_PATH_LENGTH]
bool UseForReflectionAndDiffraction
#define AK_DEFAULT_GEOMETRY_FRONT_X
AkAcousticSurface * Surfaces
AkReal32 fCPULimitPercentage
AKSOUNDENGINE_API AKRESULT QueryReflectionPaths(AkGameObjectID in_gameObjectID, AkUInt32 in_positionIndex, AkVector64 &out_listenerPos, AkVector64 &out_emitterPos, AkReflectionPathInfo *out_aPaths, AkUInt32 &io_uArraySize)
AKSOUNDENGINE_API AKRESULT RemoveGeometryInstance(AkGeometryInstanceID in_GeometryInstanceID)
float AkReal32
32-bit floating point
AKSOUNDENGINE_API AKRESULT SetImageSource(AkImageSourceID in_srcID, const AkImageSourceSettings &in_info, const char *in_name, AkUniqueID in_AuxBusID=AK_INVALID_AUX_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
AKSOUNDENGINE_API AKRESULT SetGeometry(AkGeometrySetID in_GeomSetID, const AkGeometryParams &in_params)
Structure for retrieving information about the indirect paths of a sound that have been calculated vi...
AKSOUNDENGINE_API AKRESULT SetPortalToPortalObstruction(AkPortalID in_PortalID0, AkPortalID in_PortalID1, AkReal32 in_fObstruction)
AKSOUNDENGINE_API AKRESULT RemoveReverbZone(AkRoomID in_ReverbZone)
AkUInt32 uMaxEmitterRoomAuxSends
bool isOccluded
Deprecated - always false. Occluded paths are not generated.
AKSOUNDENGINE_API AKRESULT SetDiffractionOrder(AkUInt32 in_uDiffractionOrder, bool in_bUpdatePaths)
bool bCalcEmitterVirtualPosition
An emitter that is diffracted through a portal or around geometry will have its apparent or virtual p...
AkUInt32 AkUniqueID
Unique 32-bit ID.
void SetOneTexture(AkUniqueID in_texture)
Helper function to set a single acoustic texture.
AkUInt32 uMaxDiffractionOrder
AkReal32 angles[kMaxNodes]
Raw diffraction angles at each point, in radians.
#define AK_DEFAULT_GEOMETRY_TOP_Z
AKSOUNDENGINE_API AKRESULT ClearImageSources(AkUniqueID in_AuxBusID=AK_INVALID_AUX_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
AKSOUNDENGINE_API AKRESULT SetLoadBalancingSpread(AkUInt32 in_uNbFrames)
AkVector64 imageSource
Apparent source of the reflected sound that follows this path.
AKSOUNDENGINE_API AKRESULT SetGeometryInstance(AkGeometryInstanceID in_GeometryInstanceID, const AkGeometryInstanceParams &in_params)
AkPortalID portals[kMaxNodes]
#define AK_DEFAULT_GEOMETRY_POSITION_X
AkReal32 transmissionLoss
AkUInt32 uNumberOfPrimaryRays
The number of primary rays used in the ray tracing engine. A larger number of rays will increase the ...
AkUInt32 uMaxReflectionOrder
Maximum reflection order [1, 4] - the number of 'bounces' in a reflection path. A high reflection ord...
#define AK_DEFAULT_GEOMETRY_TOP_X
AKSOUNDENGINE_API AKRESULT RemoveImageSource(AkImageSourceID in_srcID, AkUniqueID in_AuxBusID=AK_INVALID_AUX_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
Initialization settings of the spatial audio module.
Vertex for a spatial audio mesh.
AKSOUNDENGINE_API AKRESULT UnsetGameObjectInRoom(AkGameObjectID in_gameObjectID)
AkReal32 diffraction[AK_MAX_REFLECTION_PATH_LENGTH]
Diffraction amount, normalized to the range [0,1].
#define AK_MAX_REFLECTION_PATH_LENGTH
AKSOUNDENGINE_API AKRESULT RemoveRoom(AkRoomID in_RoomID)
AKSOUNDENGINE_API AKRESULT SetReflectionsOrder(AkUInt32 in_uReflectionsOrder, bool in_bUpdatePaths)
AkVertIdx point0
Index into the vertex table passed into AkGeometryParams that describes the first vertex of the trian...
Base type for ID's used by Wwise spatial audio.
Settings for individual image sources.
AkUInt32 numReflections
Number of reflections in the pathPoint[] array. Shadow zone diffraction does not count as a reflectio...
static const AkUniqueID AK_INVALID_UNIQUE_ID
Invalid unique 32-bit ID.
AKSOUNDENGINE_API AKRESULT SetPortal(AkPortalID in_PortalID, const AkPortalParams &in_Params, const char *in_PortalName=nullptr)
AKSOUNDENGINE_API AKRESULT ResetStochasticEngine()
bool EnableDiffraction
Switch to enable or disable geometric diffraction for this Geometry.
Parameters passed to SetGeometryInstance.
AkSurfIdx NumSurfaces
Number of of AkTriangleInfo structures in in_pTriangleInfo and number of AkTriIdx's in in_infoMap.
AkReal32 level
Linear gain applied to image source.
AkWorldTransform virtualPos
Virtual emitter position. This is the position that is passed to the sound engine to render the audio...
#define AK_DEFAULT_GEOMETRY_TOP_Y
static const AkUInt32 kMaxNodes
Defines the maximum number of nodes that a user can retrieve information about. Longer paths will be ...
AkImageSourceSettings()
Constructor.
#define AK_DEFAULT_GEOMETRY_POSITION_Y
AKSOUNDENGINE_API AKRESULT SetGameObjectToPortalObstruction(AkGameObjectID in_gameObjectID, AkPortalID in_PortalID, AkReal32 in_fObstruction)
AkReal32 fMovementThreshold
Amount that an emitter or listener has to move to trigger a validation of reflections/diffraction....
AkRoomID rooms[kMaxNodes+1]
bool EnableDiffractionOnBoundaryEdges
Switch to enable or disable geometric diffraction on boundary edges for this Geometry....
static const AkGameObjectID AK_INVALID_GAME_OBJECT
Invalid game object (may also mean all game objects)
3D 64-bit vector. Intended as storage for world positions of sounds and objects, benefiting from 64-b...
AkExtent(AkReal32 in_halfWidth, AkReal32 in_halfHeight, AkReal32 in_halfDepth)
AkImageSourceTexture texture
AkImageSourceSettings(AkVector64 in_sourcePosition, AkReal32 in_fDistanceScalingFactor, AkReal32 in_fLevel)
Constructor with parameters.
uint32_t AkUInt32
Unsigned 32-bit integer.
#define AK_DEFAULT_GEOMETRY_FRONT_Z
#define AK_INVALID_SURFACE
static const AkAuxBusID AK_INVALID_AUX_ID
Invalid auxiliary bus ID (or no Aux bus ID)
AkVertex * Vertices
Number of vertices in Vertices.
AkUInt32 AkAuxBusID
Auxilliary bus ID.
AkUInt32 uMaxSoundPropagationDepth
Maximum number of portals that sound can propagate through; must be less than or equal to AK_MAX_SOUN...
3D vector for some operations in 3D space. Typically intended only for localized calculations due to ...
AkGeometrySetID GeometrySetID
AKSOUNDENGINE_API AKRESULT SetEarlyReflectionsVolume(AkGameObjectID in_gameObjectID, AkReal32 in_fSendVolume)
AkGeometryParams()
Constructor.
AKSOUNDENGINE_API AKRESULT SetPortalObstructionAndOcclusion(AkPortalID in_PortalID, AkReal32 in_fObstruction, AkReal32 in_fOcclusion)
AkGeometryInstanceParams()
AkReal32 obstructionValue
AKSOUNDENGINE_API AKRESULT RemoveGeometry(AkGeometrySetID in_SetID)
AkUniqueID arTextureID[AK_MAX_NUM_TEXTURE]
Unique IDs of the Acoustics Texture ShareSets used to filter this image source.
Parameters passed to SetRoom.
#define AK_MAX_SOUND_PROPAGATION_DEPTH
Parameters passed to SetGeometry.
AkVertIdx point1
Index into the vertex table passed into AkGeometryParams that describes the second vertex of the tria...
AkWorldTransform PositionAndOrientation
AKSOUNDENGINE_API AKRESULT RegisterListener(AkGameObjectID in_gameObjectID)
AKSOUNDENGINE_API AKRESULT SetRoom(AkRoomID in_RoomID, const AkRoomParams &in_Params, const char *in_RoomName=nullptr)
AKSOUNDENGINE_API AKRESULT SetGameObjectRadius(AkGameObjectID in_gameObjectID, AkReal32 in_outerRadius, AkReal32 in_innerRadius)
AKSOUNDENGINE_API AKRESULT SetNumberOfPrimaryRays(AkUInt32 in_uNbPrimaryRays)
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