menu
버전
2024.1.2.8726
2024.1.2.8726
2023.1.10.8659
2022.1.18.8567
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
2024.1.2.8726
2023.1.10.8659
2022.1.18.8567
2021.1.14.8108
2019.2.15.7667
2019.1.11.7296
2018.1.11.6987
2017.2.10.6745
2017.1.9.6501
2016.2.6.6153
2015.1.9.5624
Wwise Unity Integration Documentation
|
This class wraps the client that communicates with the Wwise Authoring application via WAAPI. Given that only one request can be pending on the websocket, a queue is used to consume all calls sequentially. Messages sent to WAAPI use the JSON format and are serialized by Unity Json serialization. Helper classes (WaapiHelper) for serialization, keywords for WAAPI commands (WaapiKeywords), and classes for serializing message arguments and deserializing responses are found in AkWaapiHelper.cs. Uri.cs contains classes with fields containing URI strings for WAAPI calls and error messages. 더 자세히 ...
클래스 | |
class | SubscriptionInfo |
Class used to store information about a specific subscription. 더 자세히 ... | |
struct | WaapiCommand |
A simple structure containing an async payload function that will be executed when it is consumed by the command queue. 더 자세히 ... | |
Public 멤버 함수 | |
delegate void | GetResultListDelegate< T > (List< T > result) |
Generic delegate function for callbacks that expect to receive a list of objects in response to a WAAPI request. 더 자세히 ... | |
delegate void | GetResultDelegate< T > (T result) |
Generic delegate function for callbacks that expect to receive a single object in response to a WAAPI request. 더 자세히 ... | |
정적 Public 멤버 함수 | |||||
static bool | IsConnected () | ||||
Check whether the client is currently connected. 더 자세히 ... | |||||
static void | Disconnected () | ||||
Invoked after the client has disconnected from Wwise authoring. 더 자세히 ... | |||||
static string | GetStatusString () | ||||
Returns a rich text string representing the current WAAPI connection status. 더 자세히 ... | |||||
static void | QueueCommand (string uri, string args, string options) | ||||
Use this function to queue a command with no expected return object. 더 자세히 ... | |||||
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 deserialize the respone as type T and pass it to the callback. /// 더 자세히 ... | |||||
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. 더 자세히 ... | |||||
static void | GetWwiseObject< T > (System.Guid guid, ReturnOptions options, GetResultListDelegate< T > callback) | ||||
Generic function for fetching a Wwise object with custom return options. 더 자세히 ... | |||||
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. 더 자세히 ... | |||||
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. Passes the list of WwiseObjectInfo containing the specified object and ancestors to the callback. 더 자세히 ... | |||||
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 a specified depth. Passes the list of WwiseObjectInfo containing the specified object and descendants to the callback. 더 자세히 ... | |||||
static void | GetWwiseObjectAndDescendants< T > (string identifier, ReturnOptions options, int depth, GetResultListDelegate< T > callback) | ||||
Composes a WAQL "from object" request based on the parameters and enqueues a WAAPI command. Passes the list of WwiseObjectInfo containing the results to the callback 더 자세히 ... | |||||
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. Passes the list of WwiseObjectInfo containing the search results to the callback 더 자세히 ... | |||||
static void | GetChildren< T > (System.Guid guid, ReturnOptions options, GetResultListDelegate< T > callback) | ||||
Get the children of a given object. 더 자세히 ... | |||||
static void | GetProject< T > (GetResultListDelegate< T > callback, ReturnOptions options) | ||||
Get the WwiseObjectInfo for the project. 더 자세히 ... | |||||
static List< WwiseObjectInfo > | ParseObjectInfo (List< WwiseObjectInfoJsonObject > returnObjects) | ||||
Parse the response WwiseObjectInfoJsonObject of a "from object" request and implicit cast the objects to WwiseObjectInfo. 더 자세히 ... | |||||
static void | SelectObjectInAuthoring (System.Guid guid) | ||||
Select the object in Wwise Authoring. Creates a WaapiCommand object containing a lambda call to SelectObjectInAuthoringAsync and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static void | OpenWorkUnitInExplorer (System.Guid guid) | ||||
Open the OS file browser to the folder containing this object's Work Unit. Creates a WaapiCommand object containing a lambda call to OpenWorkUnitInExplorerAsync and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static void | OpenSoundBankInExplorer (System.Guid guid) | ||||
Open the OS file browser to the folder containing the generated SoundBank. Creates a WaapiCommand object containing a lambda call to OpenSoundBankInExplorer and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static void | Rename (System.Guid guid, string newName) | ||||
Rename an object in Wwise authoring. Creates a WaapiCommand object containing a lambda call to RenameAsync and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static void | Delete (System.Guid guid) | ||||
Delete an object in wwise authoring. Work Units cannot be deleted in this manner. Creates a WaapiCommand object containing a lambda call to DeleteAsync and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static bool | IsPlayable (WwiseObjectType type) | ||||
Checks if Wwise object is playable. 더 자세히 ... | |||||
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 TogglePlayEventAsync and adds it to the waapiCommandQueue. /summary>
| |||||
static void | StopAllTransports () | ||||
Stops all playing transports. Creates a WaapiCommand object containing a lambda call to StopAllTransportsAsync and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static void | Subscribe (string topic, Wamp.PublishHandler subscriptionCallback, System.Action< SubscriptionInfo > handshakeCallback, ReturnOptions returnOptions=null) | ||||
Subscribe to WAAPI topic. Refer to WAAPI reference documentation for a list of topics and their options. Creates a WaapiCommand object containing a lambda call to SubscribeAsync and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static void | Unsubscribe (uint id) | ||||
Unsubscribe from an existing subscription. Creates a WaapiCommand object containing a lambda call to UnsubscribeAsync and adds it to the waapiCommandQueue. 더 자세히 ... | |||||
static List< WwiseObjectInfo > | ParseSelectedObjects (string json) | ||||
Deserializes the objects published by the ak.wwise.ui.selectionChanged topic. 더 자세히 ... | |||||
static WwiseRenameInfo | ParseRenameObject (string json) | ||||
Deserializes the object published by the ak.wwise.core.object.nameChanged topic. 더 자세히 ... | |||||
static WwiseChildModifiedInfo | ParseChildAddedOrRemoved (string json) | ||||
Deserializes the object published by the ak.wwise.core.object.childAdded or ak.wwise.core.object.childRemoved topic. 더 자세히 ... | |||||
정적 Public 속성 | |
static System.Action< bool > | Disconnecting |
Fired when the connection is closing or closed, the bool parameter represents whether the socket connection is still open (for cleaning up subscriptions). 더 자세히 ... | |
static System.Action | Connected |
Fired when the connection is established, should be used by external classes to subscribe to topics they are interested in. 더 자세히 ... | |
static System.Action | QueueConsumed |
Fired when all commands in the queue have been executed. 더 자세히 ... | |
This class wraps the client that communicates with the Wwise Authoring application via WAAPI. Given that only one request can be pending on the websocket, a queue is used to consume all calls sequentially. Messages sent to WAAPI use the JSON format and are serialized by Unity Json serialization. Helper classes (WaapiHelper) for serialization, keywords for WAAPI commands (WaapiKeywords), and classes for serializing message arguments and deserializing responses are found in AkWaapiHelper.cs. Uri.cs contains classes with fields containing URI strings for WAAPI calls and error messages.
프로젝트를 등록하세요. 아무런 조건이나 의무 사항 없이 빠른 시작을 도와드리겠습니다.
Wwise를 시작해 보세요