Version

    Autre Documentation

menu_open
Wwise SDK 2018.1.11
ak.wwise.core.transport.getState


Gets the state of the given transport object.

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.

(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


Result

Name Type Description
state * string The state of the transport object.
Possible values : "playing", "stopped", "paused"

(Required *)

Result Details


state

type : string
description : The state of the transport object.
Possible values : "playing", "stopped", "paused"


Examples :

Get a transport object's state.

Gets the state of the given transport object.

Arguments:

{
"transport": 1234
}

Result:

{
"state": "playing"
}


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
}
},
"required": [
"transport"
],
"additionalProperties": false
}


Options :

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


Response :

{
"type": "object",
"properties": {
"state": {
"type": "string",
"description": "The state of the transport object.",
"enum": [
"playing",
"stopped",
"paused"
]
}
},
"required": [
"state"
],
"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