版本

menu_open

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


此页面对您是否有帮助?

需要技术支持?

仍有疑问?或者问题?需要更多信息?欢迎联系我们,我们可以提供帮助!

查看我们的“技术支持”页面

介绍一下自己的项目。我们会竭力为您提供帮助。

来注册自己的项目,我们帮您快速入门,不带任何附加条件!

开始 Wwise 之旅