menu
 
版本
2018.1.11.6987

2024.1.6.8842

2023.1.14.8770

2025.1.0.8897

2022.1.19.8584

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624

menu

Wwise SDK 2018.1.11
ak.wwise.core.remote.getConnectionStatus


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


此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅