Version
menu_open
Wwise SDK 2024.1.4
Subscribing to Topics in the Wwise Authoring API

Overview

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:

{
"return": ["id", "name", "path"]
}

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.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise