Wwise Unity Integration Documentation
|
A. Surface Reflectorと、Portal
ポータル(Portal)はルーム(Room)の開口部であり、そこを通って音が伝播しますが、ポータルには反射面を開口する役割もあります。単純な立方体をサーフェスリフレクタとして使うと、メッシュの開口部分でもリフレクション(反射)が発生してしまうことを、私たちは Surface Reflectorチュートリアル の終わりに気づきました。この問題の対策として、Spatial Audioのポータルは、リフレクションパスも認識し、通過させることができます。リフレクションパスは、ポータルの境界線で回折することもできます。
- 設定は単純で、ルームとサーフェスリフレクタを貫通するポータルを配置するだけです。
リフレクションパスがポータルを通過する様子を示す、Game Object 3D Viewer
B. Surface Reflectorと、Reverb
後期リバーブ(Late reverb)のあるルームでは、アーリーリフレクションをリバーブに送り込み、空間の形状をリバーブで意識できるようにすることが可能です。
- Wwiseプロジェクトで、Reflectエフェクトを適用したAuxiliary Busを開きます。
- General Settingsタブで、 Use game-defined auxiliary sends がチェックされていることを確認します。
Auxiliary Bus Property EditorのGeneral Settingsタブで、ルームリバーブにアーリーリフレクションを送る
- シーンを再生して、小ルーム(Small Room)の中のボタンを押します。プレイヤーが小ルームにいると、Voices Graphには以下のように表示されます:
Voices Graphで、Small Roomのアーリーリフレクションを、Small Roomのリバーブに送る
C. Diffraction(回折)
エミッターとリスナーの間にオブジェクトが出現するときに、Spatial Audioを使い、このオブジェクトの周りを回る回折パス(Diffraction path)を作成できます。エッジを回るパスの角度に基づいて、オブストラクションをシミュレーションし、音を減衰させます。回折(Diffraction)を、個別のサウンドや、個別のサーフェスリフレクタに対して設定できます。回折を有効にしたサウンドを出すエミッターは、回折を有効にした反射面でしか回折しません。
- サウンドの回折を有効にするには:
- Positioningタブで、Enable Diffractionチェックボックスがチェックされていることを確認します。
サウンドにDiffractionを設定する
- AkSurfaceReflector コンポーネントの回折を有効にするには:
- Enable Diffractionをチェックします。これで、Wwise Spatial Audioに送られるジオメトリに、回折エッジが生じます。Wwiseがゲームに接続したときに、回折エッジをゲームオブジェクトビュアーで見ることができます。
- 場合によって、Enable Diffraction On Boundary Edgesもチェックします。前の手順のチェックボックスをチェックすると、このチェックボックスが表示されます。バウンダリーエッジとは、1つの三角形だけに接するエッジです。例えば、UnityのQuad 3D Objectを囲うエッジなどは、バウンダリーエッジとみなされます。
Diffractionを有効にした AkSurfaceReflector
- Wwise Unity Demo Sceneでは、屋外のエミッター、バリア、そして建物の外壁で、回折を有効にしてあります。回折パスは、紫色です。それぞれのバーチャルソースが作成されて、音が出される場所に配置されます。
Game Object 3D Viewerに表示された回折パス
- 参照
-
D. Transmission(透過)
エミッターとリスナーの間にオブジェクトが出現すると、音はそのオブジェクトの中を通ることもできます。この現象をモデル化するために、Spatial Audioでは、音のダイレクトパスにフィルターをかけます。エミッターがルーム内にあれば、ルームの壁が音をブロックするオブジェクトのようなはたらきをします。この場合は、透過(Transmission)をモデル化するために、音のダイレクトパスとウェットパスにフィルターをかけます。AkSurfaceReflector コンポーネントや AkRoom コンポーネントに、0から1までの透過損失値を適用できます。デフォルトで、プロジェクトのオクルージョンボリューム、ローパス、そしてハイパスの各カーブが透過に使われます。通常は設定値が1.0であれば完全な損失を意味し、設定値が0.0であれば音がフィルターされずにジオメトリを透過することを意味します。
- Spatial Audio Settingsで、 Use Occlusion を有効にします。これで、透過損失値がWwiseプロジェクトのOcclusionカーブに関連付けられます。
Spatial Audioの初期設定
- フィルターとして音に適用する最終的な透過損失値は、その音がエミッターからリスナーまでのダイレクトパスにおいて遭遇するAkSurfaceReflector コンポーネントや AkRoom コンポーネントから送られる、全てのサーフェスの透過損失値のうちの最大値です。
- AkSurfaceReflector コンポーネントで、 Surface Reflectorメッシュの各サブメッシュに透過損失値を関連付けるために、Transmission Loss Valuesアレイを設定します。
AkSurfaceReflector コンポーネントのTransmission Loss Valuesアレイ
- AkRoom コンポーネントで、Transmission Lossパラメータの透過損失値を変更します。
AkRoom コンポーネントのTransmission Lossパラメータ
- 透過にオクルージョンを使う場合は、Wwise AuthoringのProject Settingsで、Obstruction/OcclusionタブにあるOcclusionカーブを調節します。
WwiseのProject SettingsのOcclusionカーブ
- 参照
-
E. ルームをSurface Reflectorと関連付ける(最適化)
Spatial Audioにサーフェスリフレクタを追加すると、必ずその回折(Diffraction)エッジや、それが視界に入るかが、分析されます。この処理を最適化するために、各ルームに複数のサーフェスリフレクタをつなげるグループを設定できます。1つのルームに関連付けられたサーフェスリフレクタは、ほかのルームからは見えません。サーフェスリフレクタを、1つのルームに関連付けるのが適しているのは、サーフェスリフレクタがそのルームに完全に包囲されていて、そのルームに、ほかのルームと共有するサーフェスリフレクタがない場合です。ルームを、サーフェスリフレクタに関連付けるかどうかは、全く自由です。ルームを選択していないサーフェスリフレクタは、サーフェスリフレクタをまとめたグローバルグループに追加されます。サーフェスリフレクタをルームに関連付けることで、反射や回折の計算で実行する、レイキャストのサーチ対象範囲を削減できます。
- ルームとサーフェスリフレクタを関連付けるには、 AkSurfaceReflector コンポーネントのAssociated Roomの下にある、ルームを、1つ選択します。
AkSurfaceReflectorにAssociated Roomを設定する
Helper class that knows a Wwise Event and when to trigger it in Unity. As of 2017....
Definition: AkEvent.cs:47
void RemoveGeometryInstance()
Remove this component's geometry instance from Spatial Audio.
Definition: AkSurfaceReflector.cs:352
UnityEngine.Vector3 axis
The axis used to find the contribution of each environment
Definition: AkEnvironmentPortal.cs:28
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
static void SetGeometryFromMesh(UnityEngine.Mesh mesh, ulong geometryID, bool enableDiffraction, bool enableDiffractionOnBoundaryEdges, bool enableTriangles, 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:122
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
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
bool loadAsynchronous
Check this to load the SoundBank in the background. Be careful, if Events are triggered and the Sound...
Definition: AkBank.cs:34
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
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:174
ulong GetID()
Access the portal's ID
Definition: AkRoomPortal.cs:134
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, in milliseconds. See AK::SoundEngine::ExecuteEventOnAction().
Definition: AkEvent.cs:83
float reflectionsAuxBusGain
(DEPRECATED) As of 2019.2, the early reflections send volume can be set per sound,...
Definition: AkSpatialAudioEmitter.cs:37
virtual UnityEngine.Vector3 GetUpward()
Definition: AkGameObj.cs:292
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:336
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
static void SetGeometryInstance(ulong geometryInstanceID, ulong geometryID, ulong associatedRoomID, UnityEngine.Transform transform)
Add or update an instance of the geometry by sending the transform of this component to Wwise....
Definition: AkSurfaceReflector.cs:256
bool drawSecondOrderReflections
(DEPRECATED) Spatial Audio Debug Drawing were moved to the new AkSpatialAudioDebugDraw component.
Definition: AkSpatialAudioEmitter.cs:66
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 and tracks its position and other game syncs s...
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:297
Class used to deserialize selected Wwise objects published on the ak.wwise.ui.selectionChanged topic.
Definition: AkWaapiHelper.cs:237
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:87
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.
This enables us to detect intersections between portals and environments in the editor
Definition: AkEnvironmentPortal.cs:91
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:78
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:28
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 is offset relative to the Game Object position by the Position Off...
Definition: AkGameObj.cs:49
void SetGeometryInstance()
Call AkSurfaceReflector::SetGeometryInstance() with this component's tranform.
Definition: AkSurfaceReflector.cs:324
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:285
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:272
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
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:40
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
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:28
Definition: AkRoom.cs:408
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:33
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:111
void RemoveGeometry()
Remove this component's geometry and corresponding instance from Spatial Audio.
Definition: AkSurfaceReflector.cs:344
override void HandleEvent(UnityEngine.GameObject in_gameObject)
Opens the portal on trigger event
Definition: AkRoomPortal.cs:168
AkRoom AssociatedRoom
Optional room with which this surface reflector is associated. It is recommended to associate geometr...
Definition: AkSurfaceReflector.cs:53
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
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:55
Base class for the generic triggering mechanism for Wwise Integration. All Wwise components will use ...
Definition: AkTriggerBase.cs:23
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:52
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
Indicates whether the object is affected by environmental changes. Set to false if the object is not ...
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:37
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:27
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:80
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 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
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:96
Use this component to define an area that straddles two different AkEnvironment's zones and allow mix...
Definition: AkEnvironmentPortal.cs:24
This type represents the base for all Wwise Types that require a GUID.
Definition: AkWwiseBaseType.cs:25
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:37
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:49
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からはじめよう