版本

menu_open

ak.wwise.core.transport.executeAction


Executes an action on the given transport object, or all transports if no transport is specified.

Supported by

Graphical User Interface.

Arguments

Name Type Description
transport integer Transport object ID to be used with all other ak.wwise.core.transport functions.
action * string The action to execute.
Possible values : "play", "stop", "pause", "playStop"

(Required *)

Arguments Details


transport

description : Transport object ID to be used with all other ak.wwise.core.transport functions.
type : integer
minimum : 0
maximum : 4294967295

action

type : string
Possible values : "play", "stop", "pause", "playStop"
description : The action to execute.


Examples :

Play a transport object.

Plays the given transport object.

Arguments:

{
    "action": "play", 
    "transport": 1234
}

Result:

{}

Stop all transport objects.

Stops all transport objects.

Arguments:

{
    "action": "stop"
}

Result:

{}

Toggle playback (pause / resume) on a transport object.

Toggles playback (pause / resume) on the given transport object.

Arguments:

{
    "action": "pause", 
    "transport": 1234
}

Result:

{}

Toggle playback (play / stop) on a transport object.

Toggles playback (play / stop) on the given transport object.

Arguments:

{
    "action": "playStop", 
    "transport": 1234
}

Result:

{}


Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {
        "transport": {
            "description": "Transport object ID to be used with all other ak.wwise.core.transport functions.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 4294967295
        }, 
        "action": {
            "type": "string", 
            "enum": [
                "play", 
                "stop", 
                "pause", 
                "playStop"
            ], 
            "description": "The action to execute."
        }
    }, 
    "required": [
        "action"
    ], 
    "additionalProperties": false
}


Options :

{
    "type": "object", 
    "required": [], 
    "properties": {}, 
    "additionalProperties": false
}


Response :

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

Document version : 1


此页面对您是否有帮助?

需要技术支持?

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

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

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

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

开始 Wwise 之旅