Version

menu_open
Wwise SDK 2021.1.14
ak.wwise.ui.commands.execute Arguments Schema

Schema

{
"type": "object",
"properties": {
"command": {
"type": "string",
"description": "The ID of the command to execute. Refer to \\ref globalcommandsids for the lists of commands."
},
"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. Ex: Event:Play_Sound_01"
},
{
"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 object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
},
{
"type": "string",
"pattern": "^\\\\",
"description": "A project path to a Wwise object, including the category and the work-unit. For example: \\\\Actor-Mixer Hierarchy\\\\Default Work Unit\\\\New Sound SFX."
}
]
},
"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": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9()]*$",
"description": "The name of the object."
},
{
"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 object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}."
}
]
},
"description": "An array of platform. Each platform is an ID (GUID) or a unique name. Some commands can take platforms as arguments. Refer to the commands for more information."
},
"value": {
"description": "A value to pass to the command. Some commands can take a value as an argument. Refer to the commands for more information.\\n The value of a property.",
"anyOf": [
{
"type": "null",
"description": "A null value. No reference to an object."
},
{
"type": "string",
"description": "A string value."
},
{
"type": "number",
"description": "A numerical value."
},
{
"type": "boolean",
"description": "A boolean value."
}
]
}
},
"required": [
"command"
],
"additionalProperties": false
}

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise