Wwise SDK 2021.1.14

Retrieves all consoles available for connecting Wwise Authoring to a Sound Engine instance.

Result

Name	Type	Description
consoles *	array	An array of remote consoles available.
consoles [...]	object	Describe the remote process.
consoles[...].name *	string	Name of the remote console as returned by the executable.
consoles[...].platform *	string	Platform of the remote console as returned by the executable.
consoles[...].customPlatform *	string	Platform, as defined in the project platforms of the remote console as returned by the executable.
consoles[...].host *	string	The IPv4 of the connected host. This can also be a file path if Wwise is connected to a local file (profiler session). For using WAAPI on Mac, please refer to Using WAAPI on Mac .
consoles[...].appName *	string	The name of the connected application as returned by the executable. Must be used when connecting to a specific Sound Engine instance.
consoles[...].commandPort *	integer	The command port. Can be used when connecting to a specific Sound Engine instance. Unsigned Integer 16-bit. Range: [0,65535]
consoles[...].notificationPort *	integer	The notification port. Can be used when connecting to a specific Sound Engine instance. Unsigned Integer 16-bit. Range: [0,65535]

(Required *)

Examples

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

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Get started with Wwise