版本

menu_open

ak.wwise.core.transport.create


Creates a transport object for the given Wwise object. The return transport object can be used to play, stop, pause and resume the Wwise object via the other transport functions.

(Required *)

Supported by

Graphical User Interface.

Arguments

Name Type Description
object *   The ID (GUID) or path of the object to control via the transport object.
gameObject integer The game object to use for playback.


Arguments Details


object

description : The ID (GUID) or path of the object to control via the transport object.
Possibilities, one of the following :

1) type : string
pattern : ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$

2) type : string
pattern : ^\

gameObject

description : The game object to use for playback.
type : integer
minimum : 0
maximum : 18446744073709551615


Result

Name Type Description
transport integer Transport object ID to be used with all other ak.wwise.core.transport functions.


Result Details


transport

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


Examples :

Creating a transport object.

Creates a transport object for a given Wwise object.

Arguments:

{
    "object": "{A076AA65-B71A-45BB-8841-5A20C52CE727}"
}

Result:

{
    "transport": 1234
}


Detailed JSON Schema


Arguments :

{
    "type": "object", 
    "properties": {
        "object": {
            "description": "The ID (GUID) or path of the object to control via the transport object.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": *Must be a valid GUID*
                }, 
                {
                    "type": "string", 
                    "pattern": "^\\\\"
                }
            ]
        }, 
        "gameObject": {
            "description": "The game object to use for playback.", 
            "type": "integer", 
            "minimum": 0, 
            "maximum": 18446744073709551615
        }
    }, 
    "required": [
        "object"
    ], 
    "additionalProperties": false
}


Options :

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


Response :

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

Document version : 1


此页面对您是否有帮助?

需要技术支持?

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

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

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

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

开始 Wwise 之旅