Wwise SDK 2018.1.11

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", 
    "properties": {}, 
    "additionalProperties": false
}

Response :

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

Document version : 1

Cette page a-t-elle été utile ?

Besoin d'aide ?

Des questions ? Des problèmes ? Besoin de plus d'informations ? Contactez-nous, nous pouvons vous aider !

Visitez notre page d'Aide

Décrivez-nous de votre projet. Nous sommes là pour vous aider.

Enregistrez votre projet et nous vous aiderons à démarrer sans aucune obligation !

Partir du bon pied avec Wwise