Wwise SDK 2025.1.0
|
With the Wwise Authoring API, you can call remote procedures (RPC), and can also subscribe to topics and be notified when a topic is published in Wwise (Pub/Sub). You could, therefore, synchronize data between the WAAPI client and the Wwise process or, for example, be informed when the selection changes in Wwise.
To subscribe to topics, you must use the Web Application Messaging Protocol (WAMP). The details vary by language and library. For examples, see the following documentation topics:
When subscribing to a topic, the specified callback is executed whenever the topic is published. Some of the topics support return options you can use to control the content that is passed in the callback, which avoids unnecessary queries.
For example, someone could subscribe to the ak.wwise.core.object.nameChanged topic and provide the following options:
Every time a Wwise object name changes, the notification is sent to the subscriber with the id, name and path of the object.
![]() | Note: Subscriptions are automatically revoked when the project is closed. However, topics that deal with project events support subscriptions across project loads. The following topics are exempted topics: ak.wwise.core.project.loaded, ak.wwise.core.project.preClosed, and ak.wwise.core.project.postClosed. |
See Return Options for more information about the return statement, and Wwise Authoring API Reference for more information about the topics.
In Wwise projects, objects are related to one another in different ways:
After you retrieve the tree structure, you can subscribe to ak.wwise.core.object.structureChanged to synchronize any changes to object ownership or object location in the tree structure. Subscribing to this topic provides notifications for the following events:
The changes sent by ak.wwise.core.object.structureChanged
are grouped into batches by Undo events. Wwise automatically collapses redundant information, and presents a summary of all changes made within the last Undo event in the project. For instance, when copying and pasting multiple objects in the project, multiple changes, such as create
, nameChange
, and parentChange
are grouped together.
![]() | Note: Use ak.wwise.core.object.structureChanged instead of the following topics:
The ak.wwise.core.object.structureChanged topic replaces the topics listed above, and provides more predictable and stable behavior. |
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise