Version

menu_open
Wwise SDK 2018.1.11
ak.soundengine.setDefaultListeners


Set a the default active listeners for all subsequent game objects that are registered. See AK::SoundEngine::SetDefaultListeners.

Supported by

Graphical User Interface.

Arguments

Name Type Description
listeners * array Array of listener game object IDs. Game objects must have been previously registered.

(Required *)

Arguments Details


listeners

type : array

argsSchema / listeners / ...

items

maxItems : 4294967295
type : integer
minimum : 0
maximum : 18446744073709551615
description : Array of listener game object IDs. Game objects must have been previously registered.


Examples :

Setting the list of default listeners

Sets "listeners" as the list of default listeners.

Arguments:

{
"listeners": [
2233445,
5566778,
123456,
11222648
]
}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"listeners": {
"type": "array",
"items": {
"maxItems": 4294967295,
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"description": "Array of listener game object IDs. Game objects must have been previously registered."
}
},
"required": [
"listeners"
],
"additionalProperties": false
}


Options :

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


Response :

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

Document version : 1


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