Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.remote.getAvailableConsoles Result Schema

Schema

{
"type": "object",
"properties": {
"consoles": {
"type": "array",
"description": "An array of remote consoles available.",
"items": {
"type": "object",
"description": "Describe the remote process.",
"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). For using WAAPI on Mac, please refer to \\ref waapi_path_on_mac ."
},
"appName": {
"type": "string",
"description": "The name of the connected application as returned by the executable. Must be used when connecting to a specific Sound Engine instance."
},
"commandPort": {
"type": "integer",
"description": "The command port. Can be used when connecting to a specific Sound Engine instance.\\n Unsigned Integer 16-bit.",
"minimum": 0,
"maximum": 65535
}
},
"required": [
"name",
"platform",
"customPlatform",
"host",
"appName",
"commandPort"
]
}
}
},
"required": [
"consoles"
],
"additionalProperties": false
}

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