Version

menu_open
Wwise SDK 2023.1.5
Wwise Authoring API Reference - Topics

Refer to Using the Wwise Authoring API (WAAPI) for more information about Wwise Authoring API.

ak.wwise.core.audio.imported
Sent at the end of an import operation.

ak.wwise.core.log.itemAdded
Sent when an item is added to the log. This could be used to retrieve items added to the SoundBank generation log. To retrieve the complete log, refer to ak.wwise.core.log.get.

ak.wwise.core.object.attenuationCurveChanged
Sent when an attenuation curve is changed.

ak.wwise.core.object.attenuationCurveLinkChanged
Sent when an attenuation curve's link/unlink is changed.

ak.wwise.core.object.childAdded
Sent when an object is added as a child to another object.

ak.wwise.core.object.childRemoved
Sent when an object is removed from the children of another object.

ak.wwise.core.object.created
Sent when an object is created.

ak.wwise.core.object.curveChanged
Sent when one or many curves are changed.

ak.wwise.core.object.nameChanged
Sent when an object is renamed. Publishes the renamed object.

ak.wwise.core.object.notesChanged
Sent when the object's notes are changed.

ak.wwise.core.object.postDeleted
Sent following an object's deletion.

ak.wwise.core.object.preDeleted
Sent prior to an object's deletion.

ak.wwise.core.object.propertyChanged
Sent when the watched property of an object changes.

ak.wwise.core.object.referenceChanged
Sent when an object reference is changed.

ak.wwise.core.profiler.captureLog.itemAdded
Sent when a new entry is added to the capture log. Note that all entries are being sent. No filtering is applied as opposed to the Capture Log view.

ak.wwise.core.profiler.gameObjectRegistered
Sent when a game object has been registered.

ak.wwise.core.profiler.gameObjectReset
Sent when the game objects have been reset, such as closing a connection to a game while profiling.

ak.wwise.core.profiler.gameObjectUnregistered
Sent when a game object has been unregistered.

ak.wwise.core.profiler.stateChanged
Sent when a state group state has been changed. This subscription does not require the profiler capture log to be started.

ak.wwise.core.profiler.switchChanged
Sent when a switch group state has been changed. This function does not require the profiler capture log to be started.

ak.wwise.core.project.loaded
Sent when the project has been successfully loaded.

ak.wwise.core.project.postClosed
Sent when the after the project is completely closed.

ak.wwise.core.project.preClosed
Sent when the project begins closing.

ak.wwise.core.project.saved
Sent when the project has been saved.

ak.wwise.core.soundbank.generated
Sent when a single SoundBank is generated. This could be sent multiple times during SoundBank generation, for every SoundBank generated and for every platform. To generate SoundBanks, refer to ak.wwise.core.soundbank.generate or ak.wwise.ui.commands.execute with one of the SoundBank generation commands. Refer to Wwise Authoring Command Identifiers for the list of commands.

ak.wwise.core.soundbank.generationDone
Sent when all SoundBanks are generated. Note: This notification is only sent when SoundBanks have been generated, it is not a reliable way to determine when ak.wwise.core.soundbank.generate has completed.

ak.wwise.core.switchContainer.assignmentAdded
Sent when an assignment is added to a Switch Container.

ak.wwise.core.switchContainer.assignmentRemoved
Sent when an assignment is removed from a Switch Container.

ak.wwise.core.transport.stateChanged
Sent when the transport's state has changed.

ak.wwise.debug.assertFailed
Sent when an assert has failed. This is only available in Debug builds.

ak.wwise.ui.commands.executed
Sent when a command is executed. The objects for which the command is executed are sent in the publication.

ak.wwise.ui.selectionChanged
Sent when the selection changes in the project.


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