バージョン

menu_open

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", 
    "required": [], 
    "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


このページはお役に立ちましたか?

サポートは必要ですか?

ご質問や問題、ご不明点はございますか?お気軽にお問い合わせください。

サポートページをご確認ください

あなたのプロジェクトについて教えてください。ご不明な点はありませんか。

プロジェクトを登録していただくことで、ご利用開始のサポートをいたします。

Wwiseからはじめよう