版本
menu_open

ak.wwise.core.plugin.getList


Retrieves the list of all plugins.

(Required *)

Supported by

Graphical User Interface, Command-Line Interface.

Result

Name Type Description
return array  


Result Details


return

type : array

resultSchema / return / ...

items

type : object

Name Type Description
classId integer The ID (class ID) of the plugin.
name string The name of the plugin.
type string The type of the plugin. Refer to Wwise Objects Reference for more information on the types available.


Examples :

Getting the list of all plugins.

Retrieves the list of all plugins.

Arguments:

{}

Result:

{
    "return": [
        {
            "classId": 16, 
            "name": "AudioSource", 
            "type": "WObject"
        }, 
        {
            "classId": 65537, 
            "name": "PCM", 
            "type": "Conversion"
        }, 
        {
            "classId": 8192003, 
            "name": "Wwise Flanger", 
            "type": "Effect"
        }
    ]
}

Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {}, 
    "additionalProperties": false
}


Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

{
    "type": "object", 
    "properties": {
        "return": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "classId": {
                        "description": "The ID (class ID) of the plugin.", 
                        "type": "integer", 
                        "minimum": 0, 
                        "maximum": 4294967295
                    }, 
                    "name": {
                        "type": "string", 
                        "description": "The name of the plugin."
                    }, 
                    "type": {
                        "type": "string", 
                        "description": "The type of the plugin."
                    }
                }, 
                "additionalProperties": false
            }
        }
    }, 
    "additionalProperties": false
}

Document version : 1

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅