版本
menu_open

ak.wwise.core.remote.getAvailableConsoles


Retrieves all consoles available for connecting Wwise Authoring to a Sound Engine instance.

(Required *)

Supported by

Graphical User Interface.

Result

Name Type Description
consoles * array  


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).
appName * string The name of the connected application as returned by the executable.


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", 
    "required": [], 
    "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

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅