Version

menu_open
Wwise Unreal Integration Documentation
WAAPI Blueprint Functions

These Blueprint functions connect to the Wwise Authoring application through the Wwise Authoring API.

For more information on WAAPI and its features, refer to the WAAPI documentation.

JSON Objects

WAAPI uses JSON extensively, so the integration includes a Blueprint wrapper for the Unreal FJsonObject. For more information about nodes found under "WAAPI Json Manager", refer to the Unreal Engine documentation on FJsonObject.

Call WAAPI

Calls WAAPI and gets or sets information and parameters according to the specified URI.

Parameters:

  • WaapiUri: The function to call when an event occurs.
  • WaapiArgs: The arguments referenced by the in_uri function.
  • WaapiOptions: An optional flag, which retrieves additional information about the event.
  • Return Value: A JSON object that contains information about the event call process. It returns an error if the call fails.

Register WAAPI Connection Lost Callback

Subscribes to an event that is broadcast when the WAAPI connection is lost. Use this function to clean up any resources that use WAAPI.

Parameters:

  • Callback: The event to call when the connection is lost.

Register WAAPI Project Loaded Callback

Subscribes to an event that is broadcast when the correct Wwise project is loaded (as defined by the Wwise Project Path in the Wwise Plugin Settings). Use this function to initialize any resources that use WAAPI.

Parameters:

  • Callback: The event to call when a connection is established.

Subscribe To WAAPI

Subscribes to notifications according to the event.

Parameters:

  • WaapiUri: The reference to the event.
  • WaapiOptions: An optional flag, which retrieves additional information about the event.
  • Callback: A delegate to execute during the subscription event.

Return Values:

  • SubscriptionId: The ID of the subscription.
  • Result: Indicates whether the subscription was successful.
  • Return Value: A JSON object that contains information about the event subscription process. It returns an error if the subscription failed.

Unsubscribe

Unsubscribes from an event.

Parameters:

  • SubscriptionId: ID of the current event subscription.

Return Values:

  • UnsubscriptionDone: Indicates whether the unsubscription succeeded.
  • Return Value : A JSON object that contains information about the event unsubscription process. It returns an error if the unsubscription failed.

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