Retrieves the connection status.
Supported by
Graphical User Interface.
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. |
(Required *)
Result Details
isConnected
type : boolean
description : Indicates if the Wwise Authoring application is connected to a Wwise Sound Engine process.
status
type : string
description : The current connection status in text.
console
type : object
| Name |
Type |
Description |
| name * |
string |
Name of the remote console as returned by the executable. |
| platform * |
string |
Platform of the remote console as returned by the executable. |
| customPlatform * |
string |
Platform, as defined in the project platforms of the remote console as returned by the executable. |
| 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). |
| appName * |
string |
The name of the connected application as returned by the executable. |
(Required *)
description : Describe the remote process.
Examples :
Getting the connection status
Retrieves the current connection status. In this example, Wwise is connected to the Integration Demo.
Arguments:
Result:
{
"isConnected": true,
"console": {
"name": "PC-USERNAME",
"platform": "Windows",
"host": "127.0.0.1",
"customPlatform": "Windows",
"appName": "Integration Demo"
},
"status": "Connected to PC-USERNAME (Windows - Local host) Integration Demo"
}
Detailed JSON Schema
Arguments :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Options :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Response :
{
"type": "object",
"properties": {
"isConnected": {
"type": "boolean",
"description": "Indicates if the Wwise Authoring application is connected to a Wwise Sound Engine process."
},
"status": {
"type": "string",
"description": "The current connection status in text."
},
"console": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the remote console as returned by the executable."
},
"platform": {
"type": "string",
"description": "Platform of the remote console as returned by the executable."
},
"customPlatform": {
"type": "string",
"description": "Platform, as defined in the project platforms of the remote console as returned by the executable."
},
"host": {
"type": "string",
"description": "The IPv4 of the connected host. This can also be a file path if Wwise is connected to a local file (profiler session)."
},
"appName": {
"type": "string",
"description": "The name of the connected application as returned by the executable."
}
},
"required": [
"name",
"platform",
"customPlatform",
"host",
"appName"
],
"description": "Describe the remote process."
}
},
"required": [
"isConnected",
"status"
],
"additionalProperties": false
}
Document version : 1