Version

menu_open
Wwise SDK 2023.1.9
ak.soundengine.setState Arguments Schema

Schema

{
"type": "object",
"properties": {
"stateGroup": {
"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}."
},
{
"type": "integer",
"description": "The Short ID of a Wwise Object.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
}
],
"description": "Either the ID (GUID), name, or Short ID of the State Group."
},
"state": {
"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}."
},
{
"type": "integer",
"description": "The Short ID of a Wwise Object.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
}
],
"description": "Either the ID (GUID), name, or Short ID of the State."
}
},
"required": [
"stateGroup",
"state"
],
"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