Wwise SDK 2018.1.11

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.

Supported by

Graphical User Interface.

Arguments

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

(Required *)

Arguments Details

object

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

1) type : string
pattern : ^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$
description : The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported.

2) 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}\}$

3) 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), name, or path of the object to control via the transport object.", 
            "anyOf": [
                {
                    "type": "string", 
                    "pattern": "^(StateGroup|SwitchGroup|SoundBank|GameParameter|Event|Effect|AudioDevice|Trigger|Attenuation|DialogueEvent|Bus|AuxBus|Conversion|ModulatorLfo|ModulatorEnvelope|ModulatorTime|Platform|Language|AcousticTexture):[a-zA-Z_]+[a-zA-Z0-9_]*$", 
                    "description": "The name of the object qualified by its type in the form of type:name. Only object types that have globally-unique names are supported."
                }, 
                {
                    "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", 
    "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 之旅