Version

menu_open
Wwise SDK 2021.1.14
ak.soundengine.seekOnEvent 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."
},
"gameObject": {
"type": "integer",
"description": "Associated game object ID; use <tt>AK_INVALID_GAME_OBJECT</tt> to affect all game objects.\\n A game object ID, unsigned integer 64-bit.",
"minimum": 0,
"maximum": 18446744073709551615
},
"position": {
"type": "integer",
"description": "Desired position where playback should restart, in milliseconds.\\n Integer 32-bit.",
"minimum": -2147483648,
"maximum": 2147483647
},
"percent": {
"type": "number",
"description": "Desired position where playback should restart, expressed in a percentage of the file's total duration, between 0 and 1.f. See note above about infinite looping sounds."
},
"seekToNearestMarker": {
"type": "boolean",
"description": "If true, the final seeking position is made equal to the nearest marker."
},
"playingId": {
"type": "integer",
"description": "Specifies the playing ID for which the seek is to be applied. This results in the seek being applied only to active actions of the playing ID. Use \\c AK_INVALID_PLAYING_ID or nothing, to seek on all active Actions of this Event ID.\\n Unsigned Integer 32-bit.",
"minimum": 0,
"maximum": 4294967295
}
},
"oneOf": [
{
"required": [
"event",
"gameObject",
"position",
"seekToNearestMarker",
"playingId"
]
},
{
"required": [
"event",
"gameObject",
"percent",
"seekToNearestMarker",
"playingId"
]
}
],
"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