Version

    Other Documentation

menu_open
Wwise SDK 2018.1.11
ak.soundengine.setListeners


Set a single game object's active listeners. By default, all new game objects have no listeners active, but this behavior can be overridden with SetDefaultListeners(). Inactive listeners are not computed. See AK::SoundEngine::SetListeners.

Supported by

Graphical User Interface.

Arguments

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

(Required *)

Arguments Details


emitter

description : Emitter game object.
type : integer
minimum : 0
maximum : 18446744073709551615

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 a list of listeners for a game object

Sets "listeners" as the list of active listeners for "gameObject".

Arguments:

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


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"emitter": {
"description": "Emitter game object.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
},
"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": [
"emitter",
"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