Wwise SDK 2019.1.11

Connects the Wwise Authoring application to a Wwise Sound Engine running executable. The host must be running code with communication enabled. If only "host" is provided, Wwise will connect to the first Sound Engine instance found. To distinguish between different instances, you can also provide the name of the application to connect to.

Arguments

Name	Type	Description
notificationPort	integer	The notification port associated with the command port. If you specify a notification port, you must also specify a command port. You can obtain this information from ak.wwise.core.remote.getAvailableConsoles. Unsigned Integer 16-bit. Range: [0,65535]
host *	string	The host to connect to. The host can be an IPv4 address or a computer name. Use 127.0.0.1 to connect to localhost.
commandPort	integer	The command port. If you are running two or more Sound Engine instances that use the same application name, you can specify the command port and the notification port to distinguish between different applications sharing the same name. You don't need to use this if the application name is unique. When using this, you must also provide appName. If you specify a command port, you must also specify a notification port. You can obtain this information from ak.wwise.core.remote.getAvailableConsoles. Unsigned Integer 16-bit. Range: [0,65535]
appName	string	The value in the Application Name column from the Remote Connection dialog in Wwise, or from from ak.wwise.core.remote.getAvailableConsoles. If you are running more than one Sound Engine instance, you can specify the name of the application to connect to.

(Required *)

Arguments Schema

Examples

Connecting to Cube

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

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.

Get started with Wwise