Version
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

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