Wwise Unreal Integration: WAAPI Blueprint Functions

Wwise Unreal Integration

previous page next page

WAAPI Blueprint Functions

These Blueprint functions are used to connect to the Wwise Authoring application using the Wwise Authoring API.

For more information on WAAPI and its features, refer to https://www.audiokinetic.com/library/edge/?source=SDK&id=waapi.html.

JSON objects

Since WAAPI makes extensive use of JSON, a Blueprint wrapper was written for the Unreal FJsonObject. For more information related to nodes found under "WAAPI Json Manager", please refer to the Unreal Engine documentation on FJsonObject.

Call Waapi

Call WAAPI and get/set information/parameters according to the chosen URI.

Parameters:

  • WaapiUri: The function that will be called when an event that we would be aware of occurs.
  • WaapiArgs: The arguments referenced by the in_uri function.
  • WaapiOptions: Optional flag to get more information about the event that occurred.

Return Value: A JSON object that contains useful information about the call process to a specific Event. It returns error info if the call fails.

Register WAAPI Connection Lost Callback

Subscribe to WAAPI connection lost event. This event will be broadcast when the WAAPI connection is lost. This should be used to clean up any resources that use Waapi.

Parameters:

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

Register WAAPI Project Loaded Callback

Subscribe to WAAPI project loaded event. This event will be broadcast whenever the correct Wwise project is loaded (as defined by the Wwise Project Path in the Wwise Plugin Settings). This should be used to initialize any resources that use Waapi.

Parameters:

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

Subscribe To Waapi

Allows clients to subscribe to notifications according to the event.

Parameters:

  • WaapiUri: The reference to the event that we would be aware of when it occurs.
  • WaapiOptions: Optional flag to get more information about the event that occurred.
  • Callback: A delegate to be executed during the subscription event.

Return Values:

  • SubscriptionId: The ID of this subscription.
  • Result: A boolean to ensure that the subscription was successfully done.
  • Return Value: A JSON object that contains useful information about the subscription process to a specific event. It returns error info if the subscription failed.

Unsubscribe

Unsubscribe from an event.

Parameters:

  • SubscriptionId: ID of the current subscription to the event from which we want to be unsubscribed.

Return Values:

  • UnsubscriptionDone: A boolean to ensure that the unsubscription was successfully done.
  • Return Value : A JSON object that contains useful informations about the unsubscription process from a specific event, gets an error infos in case the unsubscription failed.
Generated by  doxygen 1.6.3
previous page start next page