版本
menu_open
Wwise Unity Integration Documentation
Spatial Audio 附加功能
备注:此页面涉及的内容假定您已完成 Spatial Audio 教程准备工作 以及 Surface Reflector 教程Room 和 Portal 教程

A. Surface Reflector 和 Portal

正如 Portal 会为 Room 区域创建开口以便声音从中穿过一样,在反射表面上也可用 Portal 实现类似的功能。在 Surface Reflector 教程 结尾,我们注意到:在将简单 Cube 用作 Surface Reflector 时,Mesh 开口上会产生反射。为了解决这一问题,Spatial Audio Portal 也能够处理反射路径,允许反射声穿过。反射路径甚至会在 Portal 边界发生衍射。

  1. 设置起来很简单,直接放置穿透 Room 的 Portal 以及 Surface Reflector 即可。
    Game Object 3D Viewer 中显示反射路径穿过 Portal

B. Surface Reflector 和 Reverb

在带有后期混响的 Room 中,可将早期反射馈送到混响效果器,使后期混响具有更多房间几何构造的特征。

  1. 在 Wwise 工程中,打开应用有 Reflect Effect 的 Auxiliary Bus。
    1. 在 General Settings 选项卡中,确保选中 Use game-defined auxiliary sends
      Auxiliary Bus Property Editor General Settings tab to send early reflection to the room reverb
  2. 启动场景并按下小房间中的按钮。在玩家进入 Small Room 后,Voices Graph 应如下图所示:
    Voices Graph 中显示 Small Room 中的早期反射被发送到了 Small Room 的混响效果器

C. 衍射

在有物体出现在发声体和听者之间时,Spatial Audio 可创建绕过该物体衍射路径。根据声音绕过障碍物边缘时的路径角度,声音会被衰减,以此模拟 Obstruction 作用。您可以针对每个 Sound 和 Surface Reflector 启用衍射。对于启用了衍射的声音,在发声体发出声音时仅会在启用了衍射的反射表面边缘产生衍射。

  1. 针对 Sound 启用衍射:
    1. 在 Positioning 选项卡中,确保选中 Enable Diffraction 复选框。
      针对 Sound 启用衍射
  2. AkSurfaceReflector 组件启用衍射:
    1. 选中 Enable Diffraction。这样会在发送到 Wwise Spatial Audio 的几何构造上生成衍射边缘。在将 Wwise 连接到游戏时,这些衍射边缘会显示在游戏对象查看器中。
    2. 另外可能还希望选中 Enable Diffraction On Boundary Edges。此复选框会在选中前述复选框后显示。其中,Boundary Edge 代表仅连有一个三角形的边缘。比如,Unity Quad 3D Object 周围的边缘便被视为 Boundary Edge。
      为 AkSurfaceReflector 启用了衍射
  3. 在 Wwise Unity Demo Scene 中,室外发声体、障碍物和建筑外侧启用了衍射。其中,衍射路径显示为紫色。它们都会在声音的听感位置创建一个虚声源。
    Game Object 3D Viewer 中显示衍射路径
    参见

D. 透射

在发声体和听者之间存在障碍物时,可能会有部分声音透射到障碍物的另一侧。Spatial Audio 可通过在声音的直达路径上应用滤波来模拟这一现象。在发声体处于 Room 内时,Room 的墙壁会对声音起到阻挡作用。在这种情况下,可通过在声音的直达和湿声路径上应用滤波来模拟透射。透射损失值 (0 ~ 1) 可作用于 AkSurfaceReflectorAkRoom 组件。在默认情况下,透射使用工程的 Occlusion Volume、Occlusion LPF 和 Occlusion HPF 曲线。一般来说,值为 1.0 时表示声音被损耗殆尽,值为 0.0 时表示声音可无损穿透几何构造。

  1. 在 Spatial Audio Settings 中启用 Use Occlusion。这样可将透射损失值与 Wwise 工程的声笼曲线关联起来。
    Spatial Audio Init Settings
  2. 当声音在从发声体到听者的直达路径上遇到 AkSurfaceReflectorAkRoom 组件时,滤波当中应用的最终透射损失值等于相应组件所发送全部表面的最大透射损失值。
    1. AkSurfaceReflector 组件上,通过填充 Transmission Loss Values 数组为 Surface Reflector Mesh 的每个 Submesh 关联透射损失值。
      AkSurfaceReflector 组件上的 Transmission Loss Values 数组
    2. AkRoom 组件上,更改 Transmission Loss 参数中的透射损失值。
      AkRoom 组件上的 Transmission Loss 参数
  3. 若使用声笼模拟透射,则在 Wwise 设计工具内 Project Settings 的 Obstruction/Occlusion 选项卡中调节声笼曲线。
    Wwise Project Settings 中的 Occlusion 曲线
    参见

E. 将 Room 与 Surface Reflector 关联(已弃用)

警告: 现已弃用并会在未来版本中移除 AkSurfaceReflector 组件的 Associated Room 属性。建议不要使用该属性(将其保留设为 None)。

对于每个添加到 Spatial Audio 的 Surface Reflector,都会实施衍射边缘和可见性分析。为了优化这一步骤,可为每个 Room 设置一组互连的 Surface Reflector。假如这些 Surface Reflector 仅与某个特定 Room 关联,那么从其他 Room 是看不到它们的。如有 Surface Reflector 被某个 Room 完全包围,且该 Room 不与其他 Room 共用 Surface Reflector,则应将上述特定 Surface Reflector 关联到该 Room。您可以自由选择是否在 Room 和 Surface Reflector 之间设定关联。若未选择任何 Room,则将 Surface Reflector 添加到 Surface Reflector 全局组。通过将 Surface Reflector 与 Room 关联,可限制反射和衍射计算中执行的射线投射的搜索范围。

  1. AkSurfaceReflector 组件中的 Associated Room 下选择要与其关联的 Room。
    为 AkSurfaceReflector 关联了 Room
Helper class that knows a Wwise Event and when to trigger it in Unity. As of 2017....
Definition: AkEvent.cs:48
void RemoveGeometryInstance()
Remove this component's geometry instance from Spatial Audio.
Definition: AkSurfaceReflector.cs:410
UnityEngine.Vector3 axis
The axis used to find the contribution of each environment
Definition: AkEnvironmentPortal.cs:27
Used to deserialize transport-state information receieved from the transport.stateChanged topic.
Definition: AkWaapiHelper.cs:187
(DEPRECATED) This script is deprecated as of 2019.2. Early reflections, Diffraction and Room Reverb c...
Definition: AkSpatialAudioEmitter.cs:26
static System.Action< bool > Disconnecting
Fired when the connection is closing or closed, the bool parameter represents whether the socket conn...
Definition: AkWaapiUtilities.cs:42
This type can be used to set game parameter values to the sound engine.
Definition: AkWwiseRtpc.cs:25
This class communicates with Wwise Authoring via AkWaapiUtilities to keep track of the Wwise object h...
Definition: AkWwiseTreeWAAPIDataSource.cs:31
Add this script on a listener game object to assign another game object as a distance probe....
Definition: AkListenerDistanceProbe.cs:28
A radial emitter is for sounds that are not point sources, but instead originate from a region of spa...
Definition: AkRadialEmitter.cs:26
This type represents an Acoustic Texture.
Definition: AkWwiseAcousticTexture.cs:25
Definition: Uri.cs:103
WAAPI arguments containing an object identfier.
Definition: AkWaapiHelper.cs:57
bool decodeBank
Decode this SoundBank upon load
Definition: AkBank.cs:31
Definition: AkWwiseAcousticTexture.cs:21
AK.Wwise.AcousticTexture[] AcousticTextures
The acoustic texture per submesh. The acoustic texture represents the surface of the geometry....
Definition: AkSurfaceReflector.cs:36
float[] TransmissionLossValues
The transmission loss value per submesh. The transmission loss value is a control value used to adjus...
Definition: AkSurfaceReflector.cs:41
static void QueueCommandWithReturnWwiseObjects< T >(WaqlArgs args, ReturnOptions options, GetResultListDelegate< T > callback)
Enqueues a command with a payload that desirializes the list of wwise objects from the response.
Definition: AkWaapiUtilities.cs:564
Definition: Uri.cs:73
static void SetReverbZone(AkRoom reverbZone, AkRoom parentRoom, float transitionRegionWidth)
Establish a parent-child relationship between two Rooms. Sound propagate between a Reverb Zone and it...
Definition: AkReverbZone.cs:60
bool loadAsynchronous
Check this to load the SoundBank in the background. Be careful, if Events are triggered and the Sound...
Definition: AkBank.cs:36
void StopMIDI()
Stops all MIDI Events on this Event.
Definition: AkWwiseEvent.cs:232
static void GetWwiseObject< T >(System.Guid guid, ReturnOptions options, GetResultListDelegate< T > callback)
Generic function for fetching a Wwise object with custom return options.
Definition: AkWaapiUtilities.cs:582
Definition: Uri.cs:193
Definition: Uri.cs:75
Exception thrown during WAMP operations.
Definition: Wamp.cs:44
void PostMIDI(UnityEngine.GameObject gameObject, AkMIDIPostArray array, int count)
Posts MIDI Events on this Event associated with a GameObject.
Definition: AkWwiseEvent.cs:213
bool drawDiffractionPaths
This allows you to visualize geometric diffraction sound paths between an obstructed emitter and the ...
Definition: AkSpatialAudioDebugDraw.cs:35
void ClosePortal(UnityEngine.GameObject in_gameObject)
Closes the portal on trigger event
Definition: AkRoomPortal.cs:223
ulong GetID()
Access the portal's ID
Definition: AkRoomPortal.cs:183
float TransitionRegionWidth
Width of the transition region between the Reverb Zone and its parent. The transition zone is centere...
Definition: AkReverbZone.cs:43
float reverbLevel
The reverb control value for the send to the reverb aux bus.
Definition: AkRoom.cs:47
Trigger triggerDelegate
All components reacting to the trigger will be registered in this delegate.
Definition: AkTriggerBase.cs:30
Sorts AkEnvironments based on the selection algorithm. The selection algorithm is as follows:
Definition: AkEnvironment.cs:87
static void SelectObjectInAuthoring(System.Guid guid)
Select the object in Wwise Authoring. Creates a WaapiCommand object containing a lambda call to Selec...
Definition: AkWaapiUtilities.cs:728
void PostMIDI(UnityEngine.GameObject gameObject, AkMIDIPostArray array)
Posts MIDI Events on this Event associated with a GameObject.
Definition: AkWwiseEvent.cs:201
static void Search< T >(string searchString, WwiseObjectType objectType, ReturnOptions options, GetResultListDelegate< T > callback)
Composes a WAQL "search" request based on the parameters and enqueues a WAAPI command....
Definition: AkWaapiUtilities.cs:665
Sorts AkEnvironments based on their priorities.
Definition: AkEnvironment.cs:73
float transitionDuration
Duration of the fade. See AK::SoundEngine::ExecuteEventOnAction()
Definition: AkEvent.cs:84
float reflectionsAuxBusGain
(DEPRECATED) As of 2019.2, the early reflections send volume can be set per sound,...
Definition: AkSpatialAudioEmitter.cs:37
The Spatial Audio Geometry Data. Can be used when calling AkSoundEngine.SetGeometry()
Definition: AkSurfaceReflector.cs:114
virtual UnityEngine.Vector3 GetUpward()
Definition: AkGameObj.cs:298
static void GetGeometryDataFromMesh(UnityEngine.Mesh mesh, ref GeometryData geometryData, AK.Wwise.AcousticTexture[] acousticTextures=null, float[] transmissionLossValues=null, string name="")
Create Spatial Audio Geometry Data from a Unity mesh. The Geometry Data can be used later to call AkS...
Definition: AkSurfaceReflector.cs:192
This component converts the provided mesh into Spatial Audio Geometry.
Definition: AkSurfaceReflector.cs:27
Base class for Json serializable objects. Implements implicit cast to string using UnityEngine....
Definition: AkWaapiHelper.cs:27
float roomReverbAuxBusGain
(DEPRECATED) As of 2019.2, the Room Reverb Aux Bus Gain is set by the Game-Defined Auxiliary Sends Vo...
Definition: AkSpatialAudioEmitter.cs:45
uint diffractionMaxPathLength
(DEPRECATED) As of 2019.2, diffraction is enabled in the Sound Property Editor in the Authoring tool.
Definition: AkSpatialAudioEmitter.cs:56
static void GetChildren< T >(System.Guid guid, ReturnOptions options, GetResultListDelegate< T > callback)
Get the children of a given object.
Definition: AkWaapiUtilities.cs:686
static SpatialAudioListenerList SpatialAudioListeners
Returns the list of active Unity Game Objects that are designated to be spatial audio listeners.
Definition: AkSpatialAudioListener.cs:47
This type represents the base for all Wwise Types that also require a group GUID, such as State and S...
Definition: AkWwiseBaseGroupType.cs:25
bool drawDiffractionPaths
(DEPRECATED) Spatial Audio Debug Drawing were moved to the new AkSpatialAudioDebugDraw component.
Definition: AkSpatialAudioEmitter.cs:72
This class represents the list of active Unity Game Objects that are designated to be spatial audio l...
Definition: AkSpatialAudioListener.cs:71
bool isLocalizedBank
Is the bank localized (situated in the language-specific folders)
Definition: AkMemBankLoader.cs:31
WAAPI arguments containing an Event identfier and transport ID. Used to toggle Event playback.
Definition: AkWaapiHelper.cs:119
void UpdateGeometry()
Update this component's geometry instance
Definition: AkSurfaceReflector.cs:391
Definition: Uri.cs:297
static void TogglePlayEvent(WwiseObjectType objectType, System.Guid guid)
Play or pause an object in Wwise authoring. Creates a WaapiCommand object containing a lambda call to...
Definition: AkWaapiUtilities.cs:876
bool drawSecondOrderReflections
(DEPRECATED) Spatial Audio Debug Drawing were moved to the new AkSpatialAudioDebugDraw component.
Definition: AkSpatialAudioEmitter.cs:66
Definition: Uri.cs:230
This type can be used to post Events to the sound engine.
Definition: AkWwiseEvent.cs:29
void LoadNonLocalizedBank(string in_bankFilename)
Load a SoundBank from WWW object
Definition: AkMemBankLoader.cs:56
Used to deserialize information published on the ak.wwise.core.@object.nameChanged topic.
Definition: AkWaapiHelper.cs:246
AK.Wwise.AuxBus reflectAuxBus
(DEPRECATED) As of 2019.2, the early reflections auxiliary bus can be set per sound,...
Definition: AkSpatialAudioEmitter.cs:30
static bool IsPlayable(WwiseObjectType type)
Checks if Wwise object is playable.
Definition: AkWaapiUtilities.cs:865
uint Post(UnityEngine.GameObject gameObject)
Posts this Event on a GameObject.
Definition: AkWwiseEvent.cs:61
static void GetWwiseObjects< T >(List< System.Guid > guids, ReturnOptions options, GetResultListDelegate< T > callback)
Generic function for fetching a list of Wwise objects with custom return options.
Definition: AkWaapiUtilities.cs:594
float outerRadius
Definition: AkRadialEmitter.cs:38
This component represents a sound object in your scene tracking its position and other game syncs suc...
Definition: AkGameObj.cs:32
Add this script on the game object that represent a listener. This is normally added to the Camera ob...
Definition: AkAudioListener.cs:27
bool EnableDiffractionOnBoundaryEdges
Switch to enable or disable geometric diffraction on boundary edges for this mesh....
Definition: AkSurfaceReflector.cs:49
A simple structure containing an async payload function that will be executed when it is consumed by ...
Definition: AkWaapiUtilities.cs:102
static void Unsubscribe(uint id)
Unsubscribe from an existing subscription. Creates a WaapiCommand object containing a lambda call to ...
Definition: AkWaapiUtilities.cs:1041
void SetGeometry()
Call AkSurfaceReflector::SetGeometryFromMesh() with this component's mesh.
Definition: AkSurfaceReflector.cs:349
Class used to deserialize selected Wwise objects published on the ak.wwise.ui.selectionChanged topic.
Definition: AkWaapiHelper.cs:237
Definition: Wamp.cs:35
uint diffractionMaxPaths
(DEPRECATED) As of 2019.2, diffraction is enabled in the Sound Property Editor in the Authoring tool.
Definition: AkSpatialAudioEmitter.cs:53
Definition: AkWwiseTypeMigration.cs:31
bool drawFirstOrderReflections
(DEPRECATED) Spatial Audio Debug Drawing were moved to the new AkSpatialAudioDebugDraw component.
Definition: AkSpatialAudioEmitter.cs:63
Used to deserialize WAAPI error messages.
Definition: AkWaapiHelper.cs:199
void ExitedRoom(AkRoom room)
Called when exiting a room.
Definition: AkRoomAwareObject.cs:101
void StopMIDI(UnityEngine.GameObject gameObject)
Stops MIDI Events on this Event associated with a GameObject.
Definition: AkWwiseEvent.cs:223
void UnloadBank(UnityEngine.GameObject in_gameObject)
Unloads a SoundBank
Definition: AkBank.cs:125
delegate void Trigger(UnityEngine.GameObject in_gameObject)
Delegate declaration for all Wwise Triggers.
delegate void PublishHandler(string json)
Publish events are delegates registered with Subscribe.
void SetReverbZone()
Calls AkReverbZone::SetReverbZone() with this component's properties
Definition: AkReverbZone.cs:94
This enables us to detect intersections between portals and environments in the editor
Definition: AkEnvironmentPortal.cs:90
Definition: AkWwiseAcousticTexture.cs:21
bool Remove(AkSpatialAudioListener listener)
Removes listeners from the list
Definition: AkSpatialAudioListener.cs:107
AK.Wwise.AuxBus reverbAuxBus
The reverb auxiliary bus.
Definition: AkRoom.cs:43
delegate void GetResultDelegate< T >(T result)
Generic delegate function for callbacks that expect to receive a single object in response to a WAAPI...
void LoadLocalizedBank(string in_bankFilename)
Load a language-specific bank from WWW object
Definition: AkMemBankLoader.cs:63
override void HandleEvent(UnityEngine.GameObject in_gameObject)
Loads the SoundBank
Definition: AkBank.cs:102
This type can be used to set Switch values on gameobjects.
Definition: AkWwiseSwitch.cs:25
Exception thrown during WAMP operations when the timeout is reached.
Definition: Wamp.cs:27
This will call AkSoundEngine.SetSwitch() whenever the selected Unity event is triggered....
Definition: AkSwitch.cs:29
bool drawSecondOrderReflections
This allows you to visualize second order reflection sound paths.
Definition: AkSpatialAudioDebugDraw.cs:29
This type can be used to post triggers to the sound engine.
Definition: AkWwiseTrigger.cs:25
AkGameObjPositionOffsetData m_positionOffsetData
When not set to null, the position will be offset relative to the Game Object position by the Positio...
Definition: AkGameObj.cs:49
void SetGeometryInstance()
Call AkSurfaceReflector::SetGeometryInstance() with this component's tranform.
Definition: AkSurfaceReflector.cs:378
static WwiseRenameInfo ParseRenameObject(string json)
Deserializes the object published by the ak.wwise.core.object.nameChanged topic.
Definition: AkWaapiUtilities.cs:1078
virtual UnityEngine.Vector3 GetForward()
Definition: AkGameObj.cs:291
UnityEngine.GameObject sender
GameObject from whom the callback function was called
Definition: AkEvent.cs:29
WAAPI arguments containing an object identfier and name used when deleting an object.
Definition: AkWaapiHelper.cs:88
WAAPI arguments containing an object identfier and new value used when renaming an object.
Definition: AkWaapiHelper.cs:72
WAAPI options used to specify the transport ID when subscribing.
Definition: AkWaapiHelper.cs:164
An AkRoom is an enclosed environment that can only communicate to the outside/other rooms with AkRoom...
Definition: AkRoom.cs:25
static List< WwiseObjectInfo > ParseObjectInfo(List< WwiseObjectInfoJsonObject > returnObjects)
Parse the response WwiseObjectInfoJsonObject of a "from object" request and implicit cast the objects...
Definition: AkWaapiUtilities.cs:713
This type can be used to load/unload SoundBanks.
Definition: AkWwiseBank.cs:29
static void Disconnected()
Invoked after the client has disconnected from Wwise authoring.
Definition: AkWaapiUtilities.cs:442
WAAPI arguments containing a transport ID. Used to specify transports in transport-specific commands.
Definition: AkWaapiHelper.cs:131
static System.Action QueueConsumed
Fired when all commands in the queue have been executed.
Definition: AkWaapiUtilities.cs:52
This type represents the values of the flags used when posting an Event with a callback.
Definition: AkWwiseCallbackFlags.cs:25
static List< WwiseObjectInfo > ParseSelectedObjects(string json)
Deserializes the objects published by the ak.wwise.ui.selectionChanged topic.
Definition: AkWaapiUtilities.cs:1062
virtual UnityEngine.Vector3 GetPosition()
Definition: AkGameObj.cs:278
AK.Wwise.AuxBus reflectionsAuxBus
Definition: AkEarlyReflections.cs:32
Add this script on the game object that represent a listener. This is normally added to the Camera ob...
Definition: AkSpatialAudioListener.cs:30
Definition: Uri.cs:286
This component establishes a parent-child relationship between two Rooms and allows for sound propaga...
Definition: AkReverbZone.cs:27
void EnteredRoom(AkRoom room)
Called when entering a room.
Definition: AkRoomAwareObject.cs:92
static void OpenWorkUnitInExplorer(System.Guid guid)
Open the OS file browser to the folder containing this object's Work Unit. Creates a WaapiCommand obj...
Definition: AkWaapiUtilities.cs:751
This type can be used to set Wwise States.
Definition: AkWwiseState.cs:25
static void Delete(System.Guid guid)
Delete an object in wwise authoring. Work Units cannot be deleted in this manner. Creates a WaapiComm...
Definition: AkWaapiUtilities.cs:838
System.Collections.Generic.List< int > unloadTriggerList
Reserved.
Definition: AkBank.cs:42
uint reflectionsOrder
(DEPRECATED) As of 2019.2, the Reflection Order is set in the Spatial Audio Initialization Settings.
Definition: AkSpatialAudioEmitter.cs:40
Used to deserialize the response from an ak.wwise.core.transport.create command. Contains the transpo...
Definition: AkWaapiHelper.cs:178
void SubscribeTopics()
Subscribes to nameChanged, childAdded, childRemoved, and selectionChanged WAAPI events in order to ke...
Definition: AkWwiseTreeWAAPIDataSource.cs:391
static void QueueCommandWithReturnType< T >(string uri, GetResultDelegate< T > callback, string args=null, string options=null)
Use this function to enqueue a command with an expected return object of type T. The command will des...
Definition: AkWaapiUtilities.cs:548
static ReadOnlyDictionary< WwiseObjectType, string > WwiseObjectTypeStrings
Maps WwiseObjectType to strings.
Definition: AkWaapiHelper.cs:464
This manager tracks the AkRoomAwareObjects and the AkRooms in which they enter and exit.
Definition: AkRoomAwareManager.cs:22
void SetReverbZone(AkRoom parentRoom, float transitionRegionWidth)
Establish a parent-child relationship between this Room and a parent Room. Sound propagate between a ...
Definition: AkRoom.cs:591
Contains the GUID of the returned object's parent.
Definition: AkWaapiHelper.cs:328
Event callback information. Event callback functions can receive this structure as a parameter
Definition: AkEvent.cs:24
AkCallbackInfo info
For more information about the event callback, see the classes derived from AkCallbackInfo.
Definition: AkEvent.cs:26
This will call AkSoundEngine.SetState() whenever the selected Unity event is triggered....
Definition: AkState.cs:29
Definition: AkRoom.cs:620
UnityEngine.Mesh Mesh
The mesh to send to Spatial Audio as a Geometry Set. We recommend using a simplified mesh.
Definition: AkSurfaceReflector.cs:32
string bankName
Name of the bank to load
Definition: AkMemBankLoader.cs:28
AkEnvironment[] environments
Definition: AkEnvironmentPortal.cs:32
bool drawHigherOrderReflections
This allows you to visualize third or higher order reflection sound paths.
Definition: AkSpatialAudioDebugDraw.cs:32
Contains a helper function GetWwiseObjectTypeFromString.
Definition: AkWaapiHelper.cs:354
ulong GetID()
Access the room's ID
Definition: AkRoom.cs:195
void RemoveGeometry()
Remove this component's geometry and corresponding instance from Spatial Audio.
Definition: AkSurfaceReflector.cs:399
static void SetGeometryInstance(ulong geometryInstanceID, ulong geometryID, ulong associatedRoomID, UnityEngine.Transform transform, bool useForReflectionAndDiffraction)
Add or update an instance of the geometry by sending the transform of this component to Wwise....
Definition: AkSurfaceReflector.cs:303
override void HandleEvent(UnityEngine.GameObject in_gameObject)
Opens the portal on trigger event
Definition: AkRoomPortal.cs:217
AkRoom AssociatedRoom
Definition: AkSurfaceReflector.cs:57
AK.Wwise.Event roomToneEvent
Wwise Event to be posted on the room game object.
Definition: AkRoom.cs:54
This class is an example of how to load banks in Wwise, if the bank data was preloaded in memory....
Definition: AkMemBankLoader.cs:22
float transmissionLoss
Loss value modeling transmission through walls.
Definition: AkRoom.cs:51
Abstract base class for WAAPI command arguments.
Definition: AkWaapiHelper.cs:36
static ReadOnlyDictionary< string, string > FolderDisplaynames
Maps root folder names to displayed strings.
Definition: AkWaapiHelper.cs:487
AkRoom ReverbZone
Definition: AkReverbZone.cs:33
int priority
Definition: AkRoom.cs:40
bool drawFirstOrderReflections
This allows you to visualize first order reflection sound paths.
Definition: AkSpatialAudioDebugDraw.cs:26
Use this component to define a reverb zone. This needs to be added to a collider object to work prope...
Definition: AkEnvironment.cs:34
WAMP protocol implementation using only strings and regular expressions. This implements only a subse...
Definition: Wamp.cs:24
AkCallbackType type
AkSoundEngine.PostEvent callback flags. See the AkCallbackType enumeration for a list of all callback...
Definition: AkEvent.cs:32
bool enableActionOnEvent
Enables additional options to reuse existing events. Use it to transform a Play event into a Stop eve...
Definition: AkEvent.cs:56
static bool SetGeometryFromMesh(UnityEngine.Mesh mesh, ulong geometryID, bool enableDiffraction, bool enableDiffractionOnBoundaryEdges, AK.Wwise.AcousticTexture[] acousticTextures=null, float[] transmissionLossValues=null, string name="")
Convert the mesh into a geometry consisting of vertices, triangles, surfaces, acoustic textures and t...
Definition: AkSurfaceReflector.cs:141
Base class for the generic triggering mechanism for Wwise Integration. All Wwise components will use ...
Definition: AkTriggerBase.cs:23
void RemoveReverbZone()
Remove this Room, a Reverb Zone, from its parent. Sound can no longer propagate between this Room and...
Definition: AkRoom.cs:613
static void Subscribe(string topic, Wamp.PublishHandler subscriptionCallback, System.Action< SubscriptionInfo > handshakeCallback)
Subscribe to WAAPI topic. Refer to WAAPI reference documentation for a list of topics and their optio...
Definition: AkWaapiUtilities.cs:1015
AkCurveInterpolation curveInterpolation
Fade curve to use with the new Action. See AK::SoundEngine::ExecuteEventOnAction()
Definition: AkEvent.cs:53
static void Rename(System.Guid guid, string newName)
Rename an object in Wwise authoring. Creates a WaapiCommand object containing a lambda call to Rename...
Definition: AkWaapiUtilities.cs:813
bool isEnvironmentAware
Is this object affected by Environment changes? Set to false if not affected in order to save some us...
Definition: AkGameObj.cs:36
Generic class to deserialize a WAAPI response containing Wwise objects with custom return options.
Definition: AkWaapiHelper.cs:228
WAAPI options to specify the names of fields to return in a WAAPI request returning WwiseObjects.
Definition: AkWaapiHelper.cs:150
static System.Action Connected
Fired when the connection is established, should be used by external classes to subscribe to topics t...
Definition: AkWaapiUtilities.cs:47
This class wraps the client that communicates with the Wwise Authoring application via WAAPI....
Definition: AkWaapiUtilities.cs:34
float reflectionMaxPathLength
(DEPRECATED) As of 2019.2, the Reflection Max Path Length is set by the sound's Attenuation Max Dista...
Definition: AkSpatialAudioEmitter.cs:33
This script deals with initialization, and frame updates of the Wwise audio engine....
Definition: AkInitializer.cs:38
uint Post(UnityEngine.GameObject gameObject, CallbackFlags flags, AkCallbackManager.EventCallback callback, object cookie=null)
Posts this Event on a GameObject.
Definition: AkWwiseEvent.cs:88
bool Add(AkSpatialAudioListener listener)
Uniquely adds listeners to the list
Definition: AkSpatialAudioListener.cs:85
This will call AkSoundEngine.PostTrigger() whenever the selected Unity event is triggered....
Definition: AkWwiseTrigger.cs:28
Completely obstructs/occludes the emitter of the current game object from its listeners if at least o...
Definition: AkEmitterObstructionOcclusion.cs:23
uint diffractionMaxEdges
(DEPRECATED) As of 2019.2, diffraction is enabled in the Sound Property Editor in the Authoring tool.
Definition: AkSpatialAudioEmitter.cs:50
bool drawHigherOrderReflections
(DEPRECATED) Spatial Audio Debug Drawing were moved to the new AkSpatialAudioDebugDraw component.
Definition: AkSpatialAudioEmitter.cs:69
static void GetWwiseObjectAndDescendants< T >(System.Guid guid, ReturnOptions options, int depth, GetResultListDelegate< T > callback)
Enqueues a waapi comand to fetch the specified object and all of its descendants in the hierarchy to ...
Definition: AkWaapiUtilities.cs:628
float roomToneAuxSend
Send level for sounds that are posted on the room game object; adds reverb to ambience and room tones...
Definition: AkRoom.cs:59
UnityEngine.GameObject soundEmitterObject
Game object onto which the Event will be posted. By default, when empty, it is posted on the same obj...
Definition: AkEvent.cs:81
Class containing the information returned by a WAAPI request for an object.
Definition: AkWaapiHelper.cs:338
float reflectionsVolume
Definition: AkEarlyReflections.cs:39
const int MAX_ROOMS_PER_PORTAL
AkRoomPortals can only connect a maximum of 2 rooms.
Definition: AkRoomPortal.cs:26
Use this component to add a Large Mode position to any AkAmbient in a Scene.
Definition: AkAmbientLargeModePositioner.cs:24
This manager tracks AkRoomPortals and the rooms that they connect (front and back room).
Definition: AkRoomManager.cs:22
static void RemoveReverbZone(AkRoom reverbZone)
Remove a Reverb Zone from its parent. Sound can no longer propagate between the two Rooms,...
Definition: AkReverbZone.cs:79
static ReadOnlyDictionary< string, WwiseObjectType > typeStringDict
Maps strings to WwiseObjectType.
Definition: AkWaapiHelper.cs:501
static bool IsConnected()
Check whether the client is currently connected.
Definition: AkWaapiUtilities.cs:179
static void GetProject< T >(GetResultListDelegate< T > callback, ReturnOptions options)
Get the WwiseObjectInfo for the project.
Definition: AkWaapiUtilities.cs:701
Add this script on a GameObject to print Spatial Audio paths.
Definition: AkSpatialAudioDebugDraw.cs:23
Completely obstructs the spatial audio portal of the current game object from the spatial audio liste...
Definition: AkRoomPortalObstruction.cs:24
static void QueueCommand(string uri, string args, string options)
Use this function to queue a command with no expected return object.
Definition: AkWaapiUtilities.cs:533
Definition: AkWwiseTypeMigration.cs:25
static void GetWwiseObjectAndAncestors< T >(System.Guid guid, ReturnOptions options, GetResultListDelegate< T > callback)
Enqueues a waapi command to fetch the specified object and all of its ancestors in the hierarchy....
Definition: AkWaapiUtilities.cs:613
An AkRoomPortal can connect two AkRoom components together.
Definition: AkRoomPortal.cs:24
AkRoom ParentRoom
Definition: AkReverbZone.cs:39
uint Post(UnityEngine.GameObject gameObject, uint flags, AkCallbackManager.EventCallback callback, object cookie=null)
Posts this Event on a GameObject.
Definition: AkWwiseEvent.cs:117
Abstract base class for WAAPI command options.
Definition: AkWaapiHelper.cs:141
EnvListWrapper[] envList
Unity can't serialize an array of list so we wrap the list in a serializable class
Definition: AkEnvironmentPortal.cs:95
Use this component to define an area that straddles two different AkEnvironment's zones and allow mix...
Definition: AkEnvironmentPortal.cs:23
This type represents the base for all Wwise Types that require a GUID.
Definition: AkWwiseBaseType.cs:25
void RemoveReverbZone()
Calls AkReverbZone::RemoveReverbZone() with this component's properties
Definition: AkReverbZone.cs:103
Used to deserialize details in WAAPI error messages.
Definition: AkWaapiHelper.cs:209
WAAPI arguments containing a WAQL string.
Definition: AkWaapiHelper.cs:44
This component makes a GameObject aware of AkRoom components. When using Spatial Audio rooms,...
Definition: AkRoomAwareObject.cs:28
static void StopAllTransports()
Stops all playing transports. Creates a WaapiCommand object containing a lambda call to StopAllTransp...
Definition: AkWaapiUtilities.cs:989
Class used to store information about a specific subscription.
Definition: AkWaapiUtilities.cs:118
float innerRadius
Definition: AkRadialEmitter.cs:44
delegate void GetResultListDelegate< T >(List< T > result)
Generic delegate function for callbacks that expect to receive a list of objects in response to a WAA...
URI strings to use in WAAPI calls. For a complete description, refer to the official Wwise SDK docume...
Definition: Uri.cs:20
This type represents an auxiliary send in the Master-Mixer Hierarchy.
Definition: AkWwiseAuxBus.cs:25
uint Post(ulong gameObjectId)
Posts this Event on a GameObject ID.
Definition: AkWwiseEvent.cs:143
static AkAudioListener? TheSpatialAudioListener
Returns the "single" spatial audio listener.
Definition: AkSpatialAudioListener.cs:39
Used to deserialize information published on the ak.wwise.core.@object.childAdded and ak....
Definition: AkWaapiHelper.cs:264
Contains fields for specific WAAPI keywords.
Definition: AkWaapiHelper.cs:377
Loads and unloads a SoundBank at a specified moment. Vorbis sounds can be decompressed at a specified...
Definition: AkBank.cs:27
Used to deserialize information from a request for a Wwise object. Implements an implicit cast to Wwi...
Definition: AkWaapiHelper.cs:284
Use this component to attach a Wwise Event to any object in a scene. The sound can be started at vari...
Definition: AkAmbient.cs:47
Set an early reflections auxiliary bus and send volume for a particular game object.
Definition: AkEarlyReflections.cs:25
static string GetStatusString()
Returns a rich text string representing the current WAAPI connection status.
Definition: AkWaapiUtilities.cs:481
bool saveDecodedBank
Save the decoded SoundBank to disk for faster loads in the future
Definition: AkBank.cs:39
static void OpenSoundBankInExplorer(System.Guid guid)
Open the OS file browser to the folder containing the generated SoundBank. Creates a WaapiCommand obj...
Definition: AkWaapiUtilities.cs:762
WAAPI arguments containing an object identfier and command field. Used by AkWaapiUtilities....
Definition: AkWaapiHelper.cs:103
AkActionOnEventType actionOnEventType
Replacement action. See AK::SoundEngine::ExecuteEventOnAction()
Definition: AkEvent.cs:50
static WwiseChildModifiedInfo ParseChildAddedOrRemoved(string json)
Deserializes the object published by the ak.wwise.core.object.childAdded or ak.wwise....
Definition: AkWaapiUtilities.cs:1090
bool EnableDiffraction
Switch to enable or disable geometric diffraction for this mesh.
Definition: AkSurfaceReflector.cs:45
void ExecuteAction(UnityEngine.GameObject gameObject, AkActionOnEventType actionOnEventType, int transitionDuration, AkCurveInterpolation curveInterpolation)
Executes various actions on this event associated with a GameObject.
Definition: AkWwiseEvent.cs:175

此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅