Wwise SDK 2018.1.11

Executes a command. Some commands can take a list of objects as parameter. Refer to Wwise Authoring Command Identifiers for the available commands.

Supported by

Graphical User Interface.

Arguments

Name	Type	Description
command *	string	The ID of the command to execute. Refer to Wwise Authoring Command Identifiers for the lists of commands.
objects	array	An array of objects. Each object is an ID (GUID), name, or path of the object. Some commands can take objects as arguments. Refer to the commands for more information.
platforms	array	An array of platform. Each platform is an ID (GUID). Some commands can take platforms as arguments. Refer to the commands for more information.

(Required *)

Arguments Details

command

type : string
description : The ID of the command to execute. Refer to Wwise Authoring Command Identifiers for the lists of commands.

objects

type : array

argsSchema / objects / ...

items

Possibilities, one of the following :

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.

2) type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$

3) type : string
pattern : ^\
description : An array of objects. Each object is an ID (GUID), name, or path of the object. Some commands can take objects as arguments. Refer to the commands for more information.

platforms

type : array

argsSchema / platforms / ...

items

type : string
pattern : ^\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}$
description : An array of platform. Each platform is an ID (GUID). Some commands can take platforms as arguments. Refer to the commands for more information.

Examples :

Find and Select objects in Project Explorer

Finds the specified objects in the Project Explorer view (sync group 1), and select them.

Arguments:

{
    "command": "FindInProjectExplorerSyncGroup1", 
    "objects": [
        "{83D27335-6B94-4939-A01F-F00BEEB36E24}", 
        "{A076AA65-B71A-45BB-8841-5A20C52CE727}"
    ]
}

Result:

{}

Executing a command requiring the object's parameter

Executes "ConvertCurrentPlatform" on objects defined by "objects" GUID's.

Arguments:

{
    "command": "ConvertCurrentPlatform", 
    "objects": [
        "{83D27335-6B94-4939-A01F-F00BEEB36E24}", 
        "{A076AA65-B71A-45BB-8841-5A20C52CE727}"
    ]
}

Result:

{}

Executing a command not requiring the object's parameter

Executes the "ResetAllMutes" command.

Arguments:

{
    "command": "ResetAllMutes"
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "command": {
            "type": "string", 
            "description": "The ID of the command to execute."
        }, 
        "objects": {
            "type": "array", 
            "items": {
                "anyOf": [
                    {
                        "type": "string", 
                        "pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$", 
                        "description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported."
                    }, 
                    {
                        "type": "string", 
                        "pattern": *Must be a valid GUID*
                    }, 
                    {
                        "type": "string", 
                        "pattern": "^\\\\"
                    }
                ]
            }, 
            "description": "An array of objects. Each object is an ID (GUID), name, or path of the object. Some commands can take objects as arguments. Refer to the commands for more information."
        }, 
        "platforms": {
            "type": "array", 
            "items": {
                "type": "string", 
                "pattern": *Must be a valid GUID*
            }, 
            "description": "An array of platform. Each platform is an ID (GUID). Some commands can take platforms as arguments. Refer to the commands for more information."
        }
    }, 
    "required": [
        "command"
    ], 
    "additionalProperties": false
}

Options :

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

Response :

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

Document version : 1

此页面对您是否有帮助？

需要技术支持？

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

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

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

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

开始 Wwise 之旅

Wwise SDK 2018.1.11

ak.wwise.ui.commands.execute

Supported by

Arguments

Arguments Details

command

objects

items

platforms

items

Examples :

Find and Select objects in Project Explorer

Arguments:

Result:

Executing a command requiring the object's parameter

Arguments:

Result:

Executing a command not requiring the object's parameter

Arguments:

Result:

Detailed JSON Schema

Arguments :

Options :

Response :

此页面对您是否有帮助？

需要技术支持？

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