Wwise SDK 2024.1.0

Retrieves the connection status.

Result

Name	Type	Description
isConnected *	boolean	Indicates if the Wwise Authoring application is connected to a Wwise Sound Engine process.
status *	string	The current connection status in text.
console	object	Describe the remote process.
console.name *	string	Name of the remote console as returned by the executable.
console.platform *	string	Platform of the remote console as returned by the executable.
console.customPlatform *	string	Platform, as defined in the project platforms of the remote console, as returned by the executable.
console.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).
console.appName *	string	The name of the connected application as returned by the executable.

(Required *)

See Also

Examples

Getting the connection status

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

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