バージョン
menu_open
Wwise SDK 2024.1.0
クラス | 名前空間 | マクロ定義 | 列挙型
AkSpatialAudio.h ファイル
#include <AK/SpatialAudio/Common/AkSpatialAudioTypes.h>
#include <AK/Plugin/AkReflectGameData.h>
#include <AK/SoundEngine/Common/AkSoundEngine.h>

[ソースコード]

クラス

struct  AkSpatialAudioInitSettings
 Initialization settings of the spatial audio module. [詳解]
 
struct  AkImageSourceSettings
 Settings for individual image sources. [詳解]
 
struct  AkVertex
 Vertex for a spatial audio mesh. [詳解]
 
struct  AkExtent
 
struct  AkTriangle
 Triangle for a spatial audio mesh. [詳解]
 
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. [詳解]
 
struct  AkDiffractionPathInfo
 
struct  AkPortalParams
 Parameters passed to SetPortal [詳解]
 
struct  AkRoomParams
 Parameters passed to SetRoom [詳解]
 
struct  AkGeometryParams
 Parameters passed to SetGeometry [詳解]
 
struct  AkGeometryInstanceParams
 Parameters passed to SetGeometryInstance [詳解]
 

名前空間

namespace  AK
 Definition of data structures for AkAudioObject
 
 AK::SpatialAudio
 Audiokinetic spatial audio namespace
 

マクロ定義

#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)
 

列挙型

enum  AkTransmissionOperation : AkUInt8 { AkTransmissionOperation_Add, AkTransmissionOperation_Multiply, AkTransmissionOperation_Max, AkTransmissionOperation_Default = AkTransmissionOperation_Max }
 

関数

Basic functions.

In order to use SpatialAudio, you need to initialize it using Init, and register the listeners that you plan on using with any of the services offered by SpatialAudio, using RegisterListener respectively, after having registered their corresponding game object to the sound engine.

警告: At the moment, there can be only one Spatial Audio listener registered at any given time.
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::Init (const AkSpatialAudioInitSettings &in_initSettings)
 Initialize the SpatialAudio API.
[詳解]
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::RegisterListener (AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::UnregisterListener (AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetGameObjectRadius (AkGameObjectID in_gameObjectID, AkReal32 in_outerRadius, AkReal32 in_innerRadius)
 
Helper functions for passing game data to the Reflect plug-in.

Use this API for detailed placement of reflection image sources.

注釈: These functions are low-level and useful when your game engine already implements a geometrical approach to sound propagation such as an image-source or a ray tracing algorithm. Functions of Geometry are preferred and easier to use with the Reflect plug-in.
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::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 AK::SpatialAudio::RemoveImageSource (AkImageSourceID in_srcID, AkUniqueID in_AuxBusID=AK_INVALID_AUX_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::ClearImageSources (AkUniqueID in_AuxBusID=AK_INVALID_AUX_ID, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
 
Geometry

Geometry API for early reflection processing using Reflect.

AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetGeometry (AkGeometrySetID in_GeomSetID, const AkGeometryParams &in_params)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::RemoveGeometry (AkGeometrySetID in_SetID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetGeometryInstance (AkGeometryInstanceID in_GeometryInstanceID, const AkGeometryInstanceParams &in_params)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::RemoveGeometryInstance (AkGeometryInstanceID in_GeometryInstanceID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::QueryReflectionPaths (AkGameObjectID in_gameObjectID, AkUInt32 in_positionIndex, AkVector64 &out_listenerPos, AkVector64 &out_emitterPos, AkReflectionPathInfo *out_aPaths, AkUInt32 &io_uArraySize)
 
Rooms and Portals

Sound Propagation API using rooms and portals.

AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetRoom (AkRoomID in_RoomID, const AkRoomParams &in_Params, const char *in_RoomName=nullptr)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::RemoveRoom (AkRoomID in_RoomID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetPortal (AkPortalID in_PortalID, const AkPortalParams &in_Params, const char *in_PortalName=nullptr)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::RemovePortal (AkPortalID in_PortalID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetReverbZone (AkRoomID in_ReverbZone, AkRoomID in_ParentRoom, AkReal32 in_transitionRegionWidth)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::RemoveReverbZone (AkRoomID in_ReverbZone)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetGameObjectInRoom (AkGameObjectID in_gameObjectID, AkRoomID in_CurrentRoomID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::UnsetGameObjectInRoom (AkGameObjectID in_gameObjectID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetReflectionsOrder (AkUInt32 in_uReflectionsOrder, bool in_bUpdatePaths)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetDiffractionOrder (AkUInt32 in_uDiffractionOrder, bool in_bUpdatePaths)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetMaxGlobalReflectionPaths (AkUInt32 in_uMaxGlobalReflectionPaths)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetMaxDiffractionPaths (AkUInt32 in_uMaxDiffractionPaths, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetMaxEmitterRoomAuxSends (AkUInt32 in_uMaxEmitterRoomAuxSends)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetNumberOfPrimaryRays (AkUInt32 in_uNbPrimaryRays)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetLoadBalancingSpread (AkUInt32 in_uNbFrames)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetSmoothingConstant (AkReal32 in_fSmoothingConstantMs, AkGameObjectID in_gameObjectID=AK_INVALID_GAME_OBJECT)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetEarlyReflectionsAuxSend (AkGameObjectID in_gameObjectID, AkAuxBusID in_auxBusID)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetEarlyReflectionsVolume (AkGameObjectID in_gameObjectID, AkReal32 in_fSendVolume)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetPortalObstructionAndOcclusion (AkPortalID in_PortalID, AkReal32 in_fObstruction, AkReal32 in_fOcclusion)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetGameObjectToPortalObstruction (AkGameObjectID in_gameObjectID, AkPortalID in_PortalID, AkReal32 in_fObstruction)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetPortalToPortalObstruction (AkPortalID in_PortalID0, AkPortalID in_PortalID1, AkReal32 in_fObstruction)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::QueryWetDiffraction (AkPortalID in_portal, AkReal32 &out_wetDiffraction)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::QueryDiffractionPaths (AkGameObjectID in_gameObjectID, AkUInt32 in_positionIndex, AkVector64 &out_listenerPos, AkVector64 &out_emitterPos, AkDiffractionPathInfo *out_aPaths, AkUInt32 &io_uArraySize)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetTransmissionOperation (AkTransmissionOperation in_eOperation)
 
AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::ResetStochasticEngine ()
 

詳解

Spatial Audio interface.

AkSpatialAudio.h に定義があります。

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう