Table of Contents

Wwise SDK 2018.1.11
ak.soundengine.stopAll


Stop playing the current content associated to the specified game object ID. If no game object is specified, all sounds will be stopped. See AK::SoundEngine::StopAll.

Supported by

Graphical User Interface.

Arguments

Name Type Description
gameObject * integer Specify a game object to stop only playback associated to the provided game object ID.

(Required *)

Arguments Details


gameObject

description : Specify a game object to stop only playback associated to the provided game object ID.
type : integer
minimum : 0
maximum : 18446744073709551615


Examples :

Stopping a currently playing content

Stops playing all the content associated with "gameObject".

Arguments:

{
"gameObject": 1122334
}

Result:

{}


Detailed JSON Schema


Arguments :

{
"type": "object",
"properties": {
"gameObject": {
"description": "Specify a game object to stop only playback associated to the provided game object ID.",
"type": "integer",
"minimum": 0,
"maximum": 18446744073709551615
}
},
"required": [
"gameObject"
],
"additionalProperties": false
}


Options :

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


Response :

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

Document version : 1