目录

Wwise SDK 2018.1.11
ak.soundengine.postEvent


Asynchronously post an Event to the sound engine (by event ID). See AK::SoundEngine::PostEvent.

Supported by

Graphical User Interface.

Arguments

Name Type Description
event *   Either the ID (GUID), name, or short ID of the Event.
gameObject * integer The unique ID of the game object.

(Required *)

Arguments Details


event

description : Either the ID (GUID), name, or short ID of the Event.
Possibilities, one of the following :

1) type : string
pattern : ^[a-zA-Z_]+[a-zA-Z_0-9]*$

2) 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}\}$

3) type : integer
minimum : 0
maximum : 4294967295

gameObject

description : The unique ID of the game object.
type : integer
minimum : 0
maximum : 18446744073709551615


Result

Name Type Description
return * integer The playing ID of the Event launched, or AK_INVALID_PLAYING_ID if posting the event failed.

(Required *)

Result Details


return

description : The playing ID of the Event launched, or AK_INVALID_PLAYING_ID if posting the event failed.
type : integer
minimum : 0
maximum : 4294967295


Examples :

Posting an Event by name

Posts an Event to the sound engine using the Event's name.

Arguments:

{
"event": "Play_Music",
"gameObject": 1122334
}

Result:

{
"return": 8
}

Posting an Event by short ID

Posts an Event to the sound engine using the Event's short ID.

Arguments:

{
"event": 2932040671,
"gameObject": 1122334
}

Result:

{
"return": 8
}

Posting an Event by object GUID

Posts an Event to the sound engine using the Event's GUID.

Arguments:

{
"event": "{FF59687C-48CF-4385-B1C5-CE84B0A63880}",
"gameObject": 1122334
}

Result:

{
"return": 8
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"event": {
"description": "Either the ID (GUID), name, or short ID of the Event.",
"anyOf": [
{
"type": "string",
"pattern": "^[a-zA-Z_]+[a-zA-Z_0-9]*$"
},
{
"type": "string",
"pattern": *Must be a valid GUID*
},
{
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
]
},
"gameObject": {
"description": "The unique ID of the game object. ",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
}
},
"required": [
"event",
"gameObject"
],
"additionalProperties": false
}


Options :

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


Response :

{
"type": "object",
"properties": {
"return": {
"description": "The playing ID of the Event launched, or \\c AK_INVALID_PLAYING_ID if posting the event failed.",
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
"return"
],
"additionalProperties": false
}

Document version : 1