menu
 
Version
2023.1.9.8628

2024.1.1.8691

2023.1.9.8628

2022.1.18.8567

2021.1.14.8108

2019.2.15.7667

2019.1.11.7296

2018.1.11.6987

2017.2.10.6745

2017.1.9.6501

2016.2.6.6153

2015.1.9.5624


menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.9
ak.soundengine.executeActionOnEvent Arguments Schema

Schema

{
"type": "object",
"properties": {
"event": {
"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 event."
},
"actionType": {
"type": "integer",
"minimum": 0,
"maximum": 4,
"description": "Action to execute on all the elements that were played using the specified event. Uses values from <tt>AK::SoundEngine::AkActionOnEventType</tt>."
},
"gameObject": {
"type": "integer",
"description": "Associated game object ID.\\n A game object ID, unsigned integer 64-bit.",
"minimum": 0,
"maximum": 18446744073709551615
},
"transitionDuration": {
"type": "integer",
"description": "Fade duration (ms).\\n Integer 32-bit.",
"minimum": -2147483648,
"maximum": 2147483647
},
"fadeCurve": {
"type": "integer",
"minimum": 0,
"maximum": 9,
"description": "Use values from \\ref AkCurveInterpolation ."
}
},
"required": [
"event",
"actionType",
"gameObject",
"transitionDuration",
"fadeCurve"
],
"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