バージョン
menu_open

ak.wwise.ui.commands.execute


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

(Required *)

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  


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

description : The ID (GUID) or path of the object. Some commands can take objects as arguments. Refer to the commands for more information.
Possibilities, one of the following :

1) 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}$

2) type : string
pattern : ^\

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": {
                "description": "The ID (GUID) or path of the object. Some commands can take objects as arguments. Refer to the commands for more information.", 
                "anyOf": [
                    {
                        "type": "string", 
                        "pattern": *Must be a valid GUID*
                    }, 
                    {
                        "type": "string", 
                        "pattern": "^\\\\"
                    }
                ]
            }
        }
    }, 
    "required": [
        "command"
    ], 
    "additionalProperties": false
}


Options :

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


Response :

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

Document version : 1

このページはお役に立ちましたか？

サポートは必要ですか？

ご質問や問題、ご不明点はございますか？お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう