ak.soundengine.stopPlayingID

Stop the current content, associated to the specified playing ID, from playing. See AK::SoundEngine::StopPlayingID.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name	Type	Description
playingId *	integer	Playing ID to be stopped.
transitionDuration *	integer	Fade duration (ms).
fadeCurve *	integer	Curve type to be used for the transition. Use values from `AkCurveInterpolation`.

Arguments Details

playingId

description : Playing ID to be stopped.
type : integer
minimum : 0
maximum : 4294967295

transitionDuration

description : Fade duration (ms).
type : integer
minimum : -2147483648
maximum : 2147483647

fadeCurve

type : integer
minimum : 0
maximum : 9
description : Curve type to be used for the transition. Use values from AkCurveInterpolation.

Examples :

Stopping a current content playing

Stops the content, specified by "playingId", by using "transitionDuration" with a Linear Curve.

Arguments:

{
    "playingId": 5566998, 
    "transitionDuration": 2000, 
    "fadeCurve": 4
}

Result:

{}

Detailed JSON Schema

Arguments :

{
    "type": "object", 
    "properties": {
        "playingId": {
            "description": "Playing ID to be stopped.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 4294967295
        }, 
        "transitionDuration": {
            "description": "Fade duration (ms).", 
            "type": "integer", 
            "minimum": -2147483648, 
            "maximum": 2147483647
        }, 
        "fadeCurve": {
            "type": "integer", 
            "minimum": 0, 
            "maximum": 9, 
            "description": "Curve type to be used for the transition. Use values from <tt>AkCurveInterpolation</tt>."
        }
    }, 
    "required": [
        "playingId", 
        "transitionDuration", 
        "fadeCurve"
    ], 
    "additionalProperties": false
}

Options :

{
    "type": "object", 
    "required": [], 
    "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.

Get started with Wwise

Wwise SDK 2017.1.9