Retrieves all consoles available for connecting Wwise Authoring to a Sound Engine instance.
Supported by
Graphical User Interface.
Result
(Required *)
Result Details
consoles
type : array
resultSchema / consoles / ...
items
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). For using WAAPI on Mac, please refer to MacでWAAPIを使う . |
appName * |
string |
The name of the connected application as returned by the executable. |
(Required *)
description : Describe the remote process.
Examples :
Getting available consoles
Gets the available console for the connected sound engine.
Arguments:
Result:
{
"consoles": [
{
"name": "MyConsole01",
"platform": "Android",
"customPlatform": "CustomAndroid",
"host": "127.0.0.1",
"appName": "MyApp"
},
{
"name": "MyConsole02",
"platform": "Windows",
"customPlatform": "CustomBuild01",
"host": "127.0.0.1",
"appName": "MyApp"
}
]
}
Detailed JSON Schema
Arguments :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Options :
{
"type": "object",
"properties": {},
"additionalProperties": false
}
Response :
{
"type": "object",
"properties": {
"consoles": {
"type": "array",
"items": {
"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": [
"consoles"
],
"additionalProperties": false
}
Document version : 1