Table of Contents

Initializing the Wwise Authoring API

Running the Wwise Authoring API (WAAPI) varies according to your chosen protocol and language. But, regardless of these, you must first run Wwise and enable the Wwise Authoring API to be able to use it:

  • In Wwise, select Project > User Preferences. (Default shortcut: Shift + U)
  • In the Wwise Authoring API group box, select Enable Wwise Authoring API.
  • Click OK.

This means you can now write some WAAPI code. But, first, be sure to check your Network Security!

Network Security

Since WAAPI allows you to control Wwise remotely, it must be used in a secure environment in order to prevent other people from gaining control of your computer.

Note.gif
Note: If you are connecting to WAAPI through a browser, both the IP address and origin of the web server must be added for the connection to be allowed. Refer to Preventing Cross-Site Scripting.

Blocking access to WAAPI ports

WAAPI provides access to two ports for WAMP and HTTP (by default: 8080 and 8090). Those ports should be blocked in your firewall configuration, either on your own machine directly or in your company's firewall configuration (in case you wish to use WAAPI on your LAN).

Restricting access to WAAPI to specific IP addresses

By default, WAAPI will only accept connections coming from localhost (127.0.0.1).

Using WAAPI from another host will therefore fail, unless you add its IP address in the User Preferences. To allow an IP address to connect to WAAPI:

  • Click Project > User Preferences, from the main Wwise menu.
  • Add the IP address to the Allow connections from field. For example:
    • 203.0.113.255
  • Click OK.
Caution.gif
Caution: You can add * to allow connections from any IP address. But, this is insecure and, therefore, unrecommended.

Preventing Cross-Site Scripting

WAAPI provides a security layer against cross-site scripting. Otherwise, when you visit a webpage that contains JavaScript code, for example, that code could theoretically gain access to Wwise by connecting from the loaded webpage. In that scenario, the firewall is not enough.

This WAAPI security layer relies on your browser security settings. By default, WAAPI will only accept connections from local software or, in the case of browsers, only when opening HTML files on the local file system.

Using WAAPI in a webpage loaded from another host will fail, unless you add the host in the User Preferences. To add a host as a valid origin for WAAPI:

  • Click Project > User Preferences, from the main Wwise menu.
  • Add your host URI to the Allow browser connections from origins field. For example:
  • Click OK.
Caution.gif
Caution: You can add * to allow connections from webpages of any origin. But, this is insecure and, therefore, unrecommended.

See Using the Command Line for information on using "-Waapi" commands from the command line.

Note.gif

Note: Using Multiple Clients

WAAPI supports usage from multiple connections at once. The current maximum number of active connections to WAAPI is 20 for WAMP, with another 20 for HTTP POST.

Using WAAPI on Mac

WAAPI uses Windows-style paths to access files, with the root folder "/" represented by drive Z and the home folder drive Y. For example, in order to load project "/Volumes/path/to/MyProject.wproj", you must use path "Z:\Volumes\path\to\MyProject.wproj".

In case of doubt, you can refer to the project path as displayed in the recent projects in Wwise.

Next Steps

You can now try out WAAPI according to one of the WAAPI Samples, which show you how to get WAAPI running for your preferred language and protocol.

See also: